/**
* Root namespace for JavaScript functionality provided by SAP SE.
*
* The sap
namespace is automatically registered with the
* OpenAjax hub if it exists.
*/
declare namespace sap {
/**
* The main UI5 control library, with responsive controls that can be used in touch devices as well as desktop browsers.
*/
namespace m {
/**
* Hide the soft keyboard.
*/
var closeKeyboard: any;
/**
* Search given control's parents and try to find iScroll.
*/
var getIScroll: any;
/**
* Search given control's parents and try to find ScrollDelegate.
*/
var getScrollDelegate: any;
/**
*
**/ var Support: any; /** * Returns invalid date value of UI5. * @returns {null} */ function getInvalidDate(): null; /** * Finds default locale settings once and returns always the same. * We should not need to create new instance to get same locale settings * This method keep the locale instance in the scope and returns the same after first run * @returns {Object} sap.ui.core.Locale instane */ function getLocale(): Object; /** * Finds default locale data once and returns always the same. * @returns {Object} sap.ui.core.LocaleData instance */ function getLocaleData(): Object; /** * Checks if the given parameter is a valid JsDate Object. * @param {any} value - Any variable to test. * @returns {boolean} */ function isDate(value: any): boolean; /** * Thesap.m.Support
shows the technical information for SAPUI5 Mobile Applications. * This technical information includes * * SAPUI5 Version * * User Agent * * Configurations (Bootstrap and Computed) * * URI parameters * * All loaded module names * * In order to show the device information, the user must follow the following gestures. * 1 - Hold two finger for 3 seconds minimum. * 2 - Tab with a third finger while holding the first two fingers. * * NOTE: This class is internal and all its functions must not be used by an application * * Assap.m.Support
is a static class, ajQuery.sap.require("sap.m.Support");
* statement must be implicitly executed before the class is used. * * * Enable Support: * -------------------------------------------------- * //import library * jQuery.sap.require("sap.m.Support"); * * //By default after require, support is enabled but implicitly we can call * sap.m.Support.on(); * * Disable Support: * -------------------------------------------------- * sap.m.Support.off(); *
sap.m.ActionListItem
can be used like a button
to fire actions when pressed.
* Note: The inherited selected
property of the sap.m.ListItemBase
is not supported.
*/
export class ActionListItem extends sap.m.ListItemBase {
/**
* Constructor for a new ActionListItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.ActionListItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ListItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.ActionListItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Determines item specific mode
*
* ActionListItems are not selectable because they are command controls (like Button or Link) so triggering the associated command, rather than selection is
* appropriate to happen upon user action on these items. By overwriting isSelectable (inherited from ListItemBase) we exclude the item from processing
* specific to selectable list-items.
* @returns {string}
*/
protected getMode(): string;
/**
* Gets current value of property {@link #getText text}.
*
* Defines the text that appears in the control.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Sets a new value for property {@link #getText text}.
*
* Defines the text that appears in the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.m.ActionListItem} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.ActionListItem;
}
/**
* The ActionSelect control provides a list of predefined items that allows end users to choose options and additionally trigger some actions.
*/
export class ActionSelect extends sap.m.Select {
/**
* Constructor for a new ActionSelect.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some button into the association {@link #getButtons buttons}.
* @param {sap.ui.core.ID|sap.m.Button} vButton - the buttons to add; if empty, nothing is inserted
* @returns {sap.m.ActionSelect} Reference to this
in order to allow method chaining
*/
public addButton(vButton: sap.ui.core.ID|sap.m.Button): sap.m.ActionSelect;
/**
* Creates a new subclass of class sap.m.ActionSelect with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.Select.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getButtons buttons}.
* @returns {sap.ui.core.ID[]}
*/
public getButtons(): sap.ui.core.ID[];
/**
* Returns a metadata object for class sap.m.ActionSelect.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Remove all buttons from the ActionSelect.
* @returns {string[]} An array with the ids of the removed elements (might be empty).
*/
public removeAllButtons(): string[];
/**
* Button to be removed from the ActionSelect content.
* @param {number|string|sap.m.Button} vButton - The button to remove or its index or id.
* @returns {string} The id of the removed button or null.
*/
public removeButton(vButton: number|string|sap.m.Button): string;
}
/**
* The action sheet holds a list of options from which the user can select to complete an action.
* mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some button to the aggregation {@link #getButtons buttons}.
* @param {sap.m.Button} oButton - the button to add; if empty, nothing is inserted
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public addButton(oButton: sap.m.Button): sap.m.ActionSheet;
/**
* Attaches event handler fnFunction
to the {@link #event:afterClose afterClose} event of this sap.m.ActionSheet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ActionSheet
itself.
*
* This event will be fired after the ActionSheet is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ActionSheet
itself
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public attachAfterClose(fnFunction: Function, oListener?: any): sap.m.ActionSheet;
/**
* Attaches event handler fnFunction
to the {@link #event:afterClose afterClose} event of this sap.m.ActionSheet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ActionSheet
itself.
*
* This event will be fired after the ActionSheet is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ActionSheet
itself
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public attachAfterClose(oData: any, fnFunction: Function, oListener?: any): sap.m.ActionSheet;
/**
* Attaches event handler fnFunction
to the {@link #event:afterOpen afterOpen} event of this sap.m.ActionSheet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ActionSheet
itself.
*
* This event will be fired after the ActionSheet is opened.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ActionSheet
itself
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public attachAfterOpen(fnFunction: Function, oListener?: any): sap.m.ActionSheet;
/**
* Attaches event handler fnFunction
to the {@link #event:afterOpen afterOpen} event of this sap.m.ActionSheet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ActionSheet
itself.
*
* This event will be fired after the ActionSheet is opened.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ActionSheet
itself
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public attachAfterOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.ActionSheet;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.ActionSheet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ActionSheet
itself.
*
* This event will be fired before the ActionSheet is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ActionSheet
itself
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public attachBeforeClose(fnFunction: Function, oListener?: any): sap.m.ActionSheet;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.ActionSheet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ActionSheet
itself.
*
* This event will be fired before the ActionSheet is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ActionSheet
itself
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public attachBeforeClose(oData: any, fnFunction: Function, oListener?: any): sap.m.ActionSheet;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.ActionSheet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ActionSheet
itself.
*
* This event will be fired before the ActionSheet is opened.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ActionSheet
itself
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(fnFunction: Function, oListener?: any): sap.m.ActionSheet;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.ActionSheet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ActionSheet
itself.
*
* This event will be fired before the ActionSheet is opened.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ActionSheet
itself
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.ActionSheet;
/**
* Attaches event handler fnFunction
to the {@link #event:cancelButtonPress cancelButtonPress} event of this sap.m.ActionSheet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ActionSheet
itself.
*
* This event is fired when the cancelButton is clicked. For iPad, this event is also fired when showCancelButton is set to true, and Popover is closed by clicking outside.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ActionSheet
itself
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public attachCancelButtonPress(fnFunction: Function, oListener?: any): sap.m.ActionSheet;
/**
* Attaches event handler fnFunction
to the {@link #event:cancelButtonPress cancelButtonPress} event of this sap.m.ActionSheet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ActionSheet
itself.
*
* This event is fired when the cancelButton is clicked. For iPad, this event is also fired when showCancelButton is set to true, and Popover is closed by clicking outside.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ActionSheet
itself
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public attachCancelButtonPress(oData: any, fnFunction: Function, oListener?: any): sap.m.ActionSheet;
/**
* Attaches event handler fnFunction
to the {@link #event:cancelButtonTap cancelButtonTap} event of this sap.m.ActionSheet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ActionSheet
itself.
*
* This event is fired when the cancelButton is tapped. For iPad, this event is also fired when showCancelButton is set to true, and Popover is closed by tapping outside.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ActionSheet
itself
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public attachCancelButtonTap(fnFunction: Function, oListener?: any): sap.m.ActionSheet;
/**
* Attaches event handler fnFunction
to the {@link #event:cancelButtonTap cancelButtonTap} event of this sap.m.ActionSheet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ActionSheet
itself.
*
* This event is fired when the cancelButton is tapped. For iPad, this event is also fired when showCancelButton is set to true, and Popover is closed by tapping outside.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ActionSheet
itself
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public attachCancelButtonTap(oData: any, fnFunction: Function, oListener?: any): sap.m.ActionSheet;
/**
* Calling this method will make the ActionSheet disappear from the screen.
*/
public close(): void;
/**
* Destroys all the buttons in the aggregation {@link #getButtons buttons}.
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public destroyButtons(): sap.m.ActionSheet;
/**
* Detaches event handler fnFunction
from the {@link #event:afterClose afterClose} event of this sap.m.ActionSheet
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public detachAfterClose(fnFunction: Function, oListener: any): sap.m.ActionSheet;
/**
* Detaches event handler fnFunction
from the {@link #event:afterOpen afterOpen} event of this sap.m.ActionSheet
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public detachAfterOpen(fnFunction: Function, oListener: any): sap.m.ActionSheet;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeClose beforeClose} event of this sap.m.ActionSheet
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public detachBeforeClose(fnFunction: Function, oListener: any): sap.m.ActionSheet;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeOpen beforeOpen} event of this sap.m.ActionSheet
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public detachBeforeOpen(fnFunction: Function, oListener: any): sap.m.ActionSheet;
/**
* Detaches event handler fnFunction
from the {@link #event:cancelButtonPress cancelButtonPress} event of this sap.m.ActionSheet
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public detachCancelButtonPress(fnFunction: Function, oListener: any): sap.m.ActionSheet;
/**
* Detaches event handler fnFunction
from the {@link #event:cancelButtonTap cancelButtonTap} event of this sap.m.ActionSheet
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public detachCancelButtonTap(fnFunction: Function, oListener: any): sap.m.ActionSheet;
/**
* Creates a new subclass of class sap.m.ActionSheet with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:afterClose afterClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
protected fireAfterClose(mParameters?: any): sap.m.ActionSheet;
/**
* Fires event {@link #event:afterOpen afterOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
protected fireAfterOpen(mParameters?: any): sap.m.ActionSheet;
/**
* Fires event {@link #event:beforeClose beforeClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
protected fireBeforeClose(mParameters?: any): sap.m.ActionSheet;
/**
* Fires event {@link #event:beforeOpen beforeOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
protected fireBeforeOpen(mParameters?: any): sap.m.ActionSheet;
/**
* Fires event {@link #event:cancelButtonPress cancelButtonPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
protected fireCancelButtonPress(mParameters?: any): sap.m.ActionSheet;
/**
* Fires event {@link #event:cancelButtonTap cancelButtonTap} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
protected fireCancelButtonTap(mParameters?: any): sap.m.ActionSheet;
/**
* Gets content of aggregation {@link #getButtons buttons}.
*
* These buttons are added to the content area in ActionSheet control. When button is tapped, the ActionSheet is closed before the tap event listener is called.
* @returns {sap.m.Button[]}
*/
public getButtons(): sap.m.Button[];
/**
* Gets current value of property {@link #getCancelButtonText cancelButtonText}.
*
* This is the text displayed in the cancelButton. Default value is "Cancel", and it's translated according to the current locale setting. This property will be ignored when running either in iPad or showCancelButton is set to false.
* @returns {string} Value of property cancelButtonText
*/
public getCancelButtonText(): string;
/**
* Returns a metadata object for class sap.m.ActionSheet.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPlacement placement}.
*
* The ActionSheet behaves as an sap.m.Popover in iPad and this property is the information about on which side will the popover be placed at. Possible values are sap.m.PlacementType.Left, sap.m.PlacementType.Right, sap.m.PlacementType.Top, sap.m.PlacementType.Bottom, sap.m.PlacementType.Horizontal, sap.m.PlacementType.HorizontalPreferedLeft, sap.m.PlacementType.HorizontalPreferedRight, sap.m.PlacementType.Vertical, sap.m.PlacementType.VerticalPreferedTop, sap.m.PlacementType.VerticalPreferedBottom. The default value is sap.m.PlacementType.Bottom.
*
* Default value is Bottom
.
* @returns {sap.m.PlacementType} Value of property placement
*/
public getPlacement(): sap.m.PlacementType;
/**
* Gets the ID of the hidden label
* @returns {string} Id of hidden text
*/
protected getPopupHiddenLabelId(): string;
/**
* Gets current value of property {@link #getShowCancelButton showCancelButton}.
*
* If this is set to true, there will be a cancel button shown below the action buttons. There won't be any cancel button shown in iPad regardless of this property. The default value is set to true.
*
* Default value is true
.
* @returns {boolean} Value of property showCancelButton
*/
public getShowCancelButton(): boolean;
/**
* Gets current value of property {@link #getTitle title}.
*
* Title will be shown in the header area in iPhone and every Android devices. This property will be ignored in tablets and desktop browser.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Checks for the provided sap.m.Button
in the aggregation {@link #getButtons buttons}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Button} oButton - The button whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfButton(oButton: sap.m.Button): number;
/**
* Inserts a button into the aggregation {@link #getButtons buttons}.
* @param {sap.m.Button} oButton - the button to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the button should be inserted at; for a negative value of iIndex
, the button is inserted at position 0; for a value greater than the current size of the aggregation, the button is inserted at the last position
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public insertButton(oButton: sap.m.Button, iIndex: number): sap.m.ActionSheet;
/**
* The method checks if the ActionSheet is open. It returns true when the ActionSheet is currently open (this includes opening and closing animations), otherwise it returns false.
* @returns {boolean}
*/
public isOpen(): boolean;
/**
* Calling this method will make the ActionSheet visible on the screen.
* @param {any} oControl - The ActionSheet behaves as an sap.m.Popover in iPad and the control parameter is the object to which the popover will be placed. It can be not only a UI5 control, but also an existing dom reference. The side of the placement depends on the placement property set in the popover. In other platforms, ActionSheet behaves as a standard dialog and this parameter is ignored because dialog is aligned to the screen.
*/
public openBy(oControl: any): void;
/**
* Removes all the controls from the aggregation {@link #getButtons buttons}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Button[]} An array of the removed elements (might be empty)
*/
public removeAllButtons(): sap.m.Button[];
/**
* Removes a button from the aggregation {@link #getButtons buttons}.
* @param {number|string|sap.m.Button} vButton - The button to remove or its index or id
* @returns {sap.m.Button} The removed button or null
*/
public removeButton(vButton: number|string|sap.m.Button): sap.m.Button;
/**
* Sets a new value for property {@link #getCancelButtonText cancelButtonText}.
*
* This is the text displayed in the cancelButton. Default value is "Cancel", and it's translated according to the current locale setting. This property will be ignored when running either in iPad or showCancelButton is set to false.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sCancelButtonText - New value for property cancelButtonText
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public setCancelButtonText(sCancelButtonText: string): sap.m.ActionSheet;
/**
* Sets a new value for property {@link #getPlacement placement}.
*
* The ActionSheet behaves as an sap.m.Popover in iPad and this property is the information about on which side will the popover be placed at. Possible values are sap.m.PlacementType.Left, sap.m.PlacementType.Right, sap.m.PlacementType.Top, sap.m.PlacementType.Bottom, sap.m.PlacementType.Horizontal, sap.m.PlacementType.HorizontalPreferedLeft, sap.m.PlacementType.HorizontalPreferedRight, sap.m.PlacementType.Vertical, sap.m.PlacementType.VerticalPreferedTop, sap.m.PlacementType.VerticalPreferedBottom. The default value is sap.m.PlacementType.Bottom.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Bottom
.
* @param {sap.m.PlacementType} sPlacement - New value for property placement
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public setPlacement(sPlacement: sap.m.PlacementType): sap.m.ActionSheet;
/**
* Sets a new value for property {@link #getShowCancelButton showCancelButton}.
*
* If this is set to true, there will be a cancel button shown below the action buttons. There won't be any cancel button shown in iPad regardless of this property. The default value is set to true.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowCancelButton - New value for property showCancelButton
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public setShowCancelButton(bShowCancelButton: boolean): sap.m.ActionSheet;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Title will be shown in the header area in iPhone and every Android devices. This property will be ignored in tablets and desktop browser.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.ActionSheet} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.ActionSheet;
}
/**
* App is the root element of a UI5 mobile application. It inherits from NavContainer and thus provides its navigation capabilities.
* It also adds certain header tags to the HTML page which are considered useful for mobile apps.
*/
export class App extends sap.m.NavContainer {
/**
* Constructor for a new App.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:orientationChange orientationChange} event of this sap.m.App
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.App
itself.
*
* Fired when the orientation (portrait/landscape) of the device is changed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.App
itself
* @returns {sap.m.App} Reference to this
in order to allow method chaining
*/
public attachOrientationChange(fnFunction: Function, oListener?: any): sap.m.App;
/**
* Attaches event handler fnFunction
to the {@link #event:orientationChange orientationChange} event of this sap.m.App
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.App
itself.
*
* Fired when the orientation (portrait/landscape) of the device is changed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.App
itself
* @returns {sap.m.App} Reference to this
in order to allow method chaining
*/
public attachOrientationChange(oData: any, fnFunction: Function, oListener?: any): sap.m.App;
/**
* Detaches event handler fnFunction
from the {@link #event:orientationChange orientationChange} event of this sap.m.App
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.App} Reference to this
in order to allow method chaining
*/
public detachOrientationChange(fnFunction: Function, oListener: any): sap.m.App;
/**
* Creates a new subclass of class sap.m.App with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.NavContainer.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:orientationChange orientationChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.App} Reference to this
in order to allow method chaining
*/
protected fireOrientationChange(mParameters?: any): sap.m.App;
/**
* Gets current value of property {@link #getBackgroundColor backgroundColor}.
*
* Background color of the App. If set, this color will override the default background defined by the theme. So this should only be set when really required.
* Any configured background image will be placed above this colored background. But any theme adaptation in the Theme Designer will override this setting.
* Use the "backgroundRepeat" property to define whether this image should be stretched to cover the complete App or whether it should be tiled.
* @returns {string} Value of property backgroundColor
*/
public getBackgroundColor(): string;
/**
* Gets current value of property {@link #getBackgroundImage backgroundImage}.
*
* Background image of the App. If set, this image will override the default background defined by the theme. So this should only be set when really required.
* This background image will be placed above any color set for the background. But any theme adaptation in the Theme Designer will override this image setting.
* Use the "backgroundRepeat" property to define whether this image should be stretched to cover the complete App or whether it should be tiled.
* @returns {sap.ui.core.URI} Value of property backgroundImage
*/
public getBackgroundImage(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getBackgroundOpacity backgroundOpacity}.
*
* Opacity of the background image. The opacity can be set between 0 (fully transparent) and 1 fully opaque).
* This can be used to make the application content better readable by making the background image partly transparent.
*
* Default value is 1
.
* @returns {number} Value of property backgroundOpacity
*/
public getBackgroundOpacity(): number;
/**
* Gets current value of property {@link #getBackgroundRepeat backgroundRepeat}.
*
* Whether the background image (if configured) should be proportionally stretched to cover the whole App (false) or whether it should be tiled (true).
*
* Default value is false
.
* @returns {boolean} Value of property backgroundRepeat
*/
public getBackgroundRepeat(): boolean;
/**
* Gets current value of property {@link #getHomeIcon homeIcon}.
*
* The icon to be displayed on the home screen of iOS devices after the user does "add to home screen".
*
* Note that only the first attempt to set the homeIcon will be executed, subsequent settings are ignored.
*
* This icon must be in PNG format. The property can either hold the URL of one single icon which is used for all devices (and possibly scaled, which looks not perfect), or an object holding icon URLs for the different required sizes.
*
* A desktop icon (used for bookmarks and overriding the favicon) can also be configured. This requires an object to be given and the "icon" property of this object then defines the desktop bookmark icon. For this icon, PNG is not supported by Internet Explorer. The ICO format is supported by all browsers. ICO is also preferred for this desktop icon setting because the file can contain different images for different resolutions.
*
* One example is:
*
* app.setHomeIcon({
* 'phone':'phone-icon.png',
* 'phone@2':'phone-retina.png',
* 'tablet':'tablet-icon.png',
* 'tablet@2':'tablet-retina.png',
* 'icon':'desktop.ico'
* });
*
* The respective image sizes are 57/114 px for the phone and 72/144 px for the tablet.
* If an object is given but one of the sizes is not given, the largest given icon will be used for this size.
*
* On Android these icons may or may not be used by the device. Apparently chances can be improved by adding glare effect and rounded corners, setting the file name so it ends with "-precomposed.png" and setting the "homeIconPrecomposed" property to "true".
* @returns {any} Value of property homeIcon
*/
public getHomeIcon(): any;
/**
* Returns a metadata object for class sap.m.App.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets a new value for property {@link #getBackgroundColor backgroundColor}.
*
* Background color of the App. If set, this color will override the default background defined by the theme. So this should only be set when really required.
* Any configured background image will be placed above this colored background. But any theme adaptation in the Theme Designer will override this setting.
* Use the "backgroundRepeat" property to define whether this image should be stretched to cover the complete App or whether it should be tiled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sBackgroundColor - New value for property backgroundColor
* @returns {sap.m.App} Reference to this
in order to allow method chaining
*/
public setBackgroundColor(sBackgroundColor: string): sap.m.App;
/**
* Sets a new value for property {@link #getBackgroundImage backgroundImage}.
*
* Background image of the App. If set, this image will override the default background defined by the theme. So this should only be set when really required.
* This background image will be placed above any color set for the background. But any theme adaptation in the Theme Designer will override this image setting.
* Use the "backgroundRepeat" property to define whether this image should be stretched to cover the complete App or whether it should be tiled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sBackgroundImage - New value for property backgroundImage
* @returns {sap.m.App} Reference to this
in order to allow method chaining
*/
public setBackgroundImage(sBackgroundImage: sap.ui.core.URI): sap.m.App;
/**
* Sets a new value for property {@link #getBackgroundOpacity backgroundOpacity}.
*
* Opacity of the background image. The opacity can be set between 0 (fully transparent) and 1 fully opaque).
* This can be used to make the application content better readable by making the background image partly transparent.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} fBackgroundOpacity - New value for property backgroundOpacity
* @returns {sap.m.App} Reference to this
in order to allow method chaining
*/
public setBackgroundOpacity(fBackgroundOpacity: number): sap.m.App;
/**
* Sets a new value for property {@link #getBackgroundRepeat backgroundRepeat}.
*
* Whether the background image (if configured) should be proportionally stretched to cover the whole App (false) or whether it should be tiled (true).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bBackgroundRepeat - New value for property backgroundRepeat
* @returns {sap.m.App} Reference to this
in order to allow method chaining
*/
public setBackgroundRepeat(bBackgroundRepeat: boolean): sap.m.App;
/**
* Sets a new value for property {@link #getHomeIcon homeIcon}.
*
* The icon to be displayed on the home screen of iOS devices after the user does "add to home screen".
*
* Note that only the first attempt to set the homeIcon will be executed, subsequent settings are ignored.
*
* This icon must be in PNG format. The property can either hold the URL of one single icon which is used for all devices (and possibly scaled, which looks not perfect), or an object holding icon URLs for the different required sizes.
*
* A desktop icon (used for bookmarks and overriding the favicon) can also be configured. This requires an object to be given and the "icon" property of this object then defines the desktop bookmark icon. For this icon, PNG is not supported by Internet Explorer. The ICO format is supported by all browsers. ICO is also preferred for this desktop icon setting because the file can contain different images for different resolutions.
*
* One example is:
*
* app.setHomeIcon({
* 'phone':'phone-icon.png',
* 'phone@2':'phone-retina.png',
* 'tablet':'tablet-icon.png',
* 'tablet@2':'tablet-retina.png',
* 'icon':'desktop.ico'
* });
*
* The respective image sizes are 57/114 px for the phone and 72/144 px for the tablet.
* If an object is given but one of the sizes is not given, the largest given icon will be used for this size.
*
* On Android these icons may or may not be used by the device. Apparently chances can be improved by adding glare effect and rounded corners, setting the file name so it ends with "-precomposed.png" and setting the "homeIconPrecomposed" property to "true".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oHomeIcon - New value for property homeIcon
* @returns {sap.m.App} Reference to this
in order to allow method chaining
*/
public setHomeIcon(oHomeIcon: any): sap.m.App;
}
/**
* Available Background Design.
*/
export enum BackgroundDesign {
/**
* A solid background color dependent on the theme.
*/
Solid = "Solid",
/**
* A translucent background depending on the opacity value of the theme.
*/
Translucent = "Translucent",
/**
* Transparent background.
*/
Transparent = "Transparent",
}
/**
* Helper for rendering themable background.
*/
namespace BackgroundHelper {
/**
* Adds CSS classes and styles to the given RenderManager, depending on the given configuration for background color and background image.
* To be called by control renderers supporting the global themable background image within their root tag, before they call writeClasses() and writeStyles().
* @param {sap.ui.core.RenderManager} rm - the RenderManager
* @param {string} sBgColor - a configured custom background color for the control, if any
* @param {sap.ui.core.URI} sBgImgUrl - the configured custom background image for the control, if any
*/
function addBackgroundColorStyles(rm: sap.ui.core.RenderManager, sBgColor?: string, sBgImgUrl?: sap.ui.core.URI): void;
/**
* Renders an HTML tag into the given RenderManager which carries the background image which is either configured and given or coming from the current theme.
* Should be called right after the opening root tag has been completed, so this is the first child element inside the control.
* @param {any} rm - the RenderManager
* @param {sap.ui.core.Control} oControl - the control within which the tag will be rendered; its ID will be used to generate the element ID
* @param {string|string[]} vCssClass - a css class or an array of css classes to add to the element
* @param {sap.ui.core.URI} sBgImgUrl - the image of a configured background image; if this is not given, the theme background will be used and also the other settings are ignored.
* @param {boolean} bRepeat - whether the background image should be repeated/tiled (or stretched)
* @param {number} fOpacity - the background image opacity, if any
*/
function renderBackgroundImageTag(rm: any, oControl: sap.ui.core.Control, vCssClass: string|string[], sBgImgUrl?: sap.ui.core.URI, bRepeat?: boolean, fOpacity?: number): void;
}
/**
* The Bar control can be used as a header, sub-header and a footer in a page.
* It has the capability to center a content like a title, while having other controls on the left and right side.
*/
export class Bar extends sap.ui.core.Control {
/**
* Sets classes according to the context of the page. Possible contexts are header, footer and subheader.
*/
protected _applyContextClassFor: any;
/**
* Sets HTML tag according to the context of the page. Possible contexts are header, footer and subheader.
*/
protected _applyTag: any;
/**
* Sets classes and HTML tag according to the context of the page. Possible contexts are header, footer and subheader.
*/
protected applyTagAndContextClassFor: any;
/**
* Gets the available Bar contexts.
*/
protected getContext: any;
/**
* Gets the HTML tag of the root element.
*/
protected getHTMLTag: any;
/**
* Determines whether the Bar is sensitive to the container context.
*
* Implementation of the IBar interface.
*/
protected isContextSensitive: any;
/**
* Sets the HTML tag of the root element.
*/
protected setHTMLTag: any;
/**
* Constructor for a new Bar.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.Bar} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Bar;
/**
* Adds some contentLeft to the aggregation {@link #getContentLeft contentLeft}.
* @param {sap.ui.core.Control} oContentLeft - the contentLeft to add; if empty, nothing is inserted
* @returns {sap.m.Bar} Reference to this
in order to allow method chaining
*/
public addContentLeft(oContentLeft: sap.ui.core.Control): sap.m.Bar;
/**
* Adds some contentMiddle to the aggregation {@link #getContentMiddle contentMiddle}.
* @param {sap.ui.core.Control} oContentMiddle - the contentMiddle to add; if empty, nothing is inserted
* @returns {sap.m.Bar} Reference to this
in order to allow method chaining
*/
public addContentMiddle(oContentMiddle: sap.ui.core.Control): sap.m.Bar;
/**
* Adds some contentRight to the aggregation {@link #getContentRight contentRight}.
* @param {sap.ui.core.Control} oContentRight - the contentRight to add; if empty, nothing is inserted
* @returns {sap.m.Bar} Reference to this
in order to allow method chaining
*/
public addContentRight(oContentRight: sap.ui.core.Control): sap.m.Bar;
/**
* Destroys all the contentLeft in the aggregation {@link #getContentLeft contentLeft}.
* @returns {sap.m.Bar} Reference to this
in order to allow method chaining
*/
public destroyContentLeft(): sap.m.Bar;
/**
* Destroys all the contentMiddle in the aggregation {@link #getContentMiddle contentMiddle}.
* @returns {sap.m.Bar} Reference to this
in order to allow method chaining
*/
public destroyContentMiddle(): sap.m.Bar;
/**
* Destroys all the contentRight in the aggregation {@link #getContentRight contentRight}.
* @returns {sap.m.Bar} Reference to this
in order to allow method chaining
*/
public destroyContentRight(): sap.m.Bar;
/**
* Creates a new subclass of class sap.m.Bar with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets content of aggregation {@link #getContentLeft contentLeft}.
*
* Represents the left content area, usually containing a button or an app icon. If it is overlapped by the right content, its content will disappear and the text will show an ellipsis.
* @returns {sap.ui.core.Control[]}
*/
public getContentLeft(): sap.ui.core.Control[];
/**
* Gets content of aggregation {@link #getContentMiddle contentMiddle}.
*
* Represents the middle content area. Controls such as label, segmented buttons or select can be placed here. The content is centrally positioned if there is enough space. If the right or left content overlaps the middle content, the middle content will be centered in the space between the left and the right content.
* @returns {sap.ui.core.Control[]}
*/
public getContentMiddle(): sap.ui.core.Control[];
/**
* Gets content of aggregation {@link #getContentRight contentRight}.
*
* Represents the right content area. Controls such as action buttons or search field can be placed here.
* @returns {sap.ui.core.Control[]}
*/
public getContentRight(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getDesign design}.
*
* Determines the design of the bar. If set to auto, it becomes dependent on the place where the bar is placed.
*
* Default value is Auto
.
* @returns {sap.m.BarDesign} Value of property design
*/
public getDesign(): sap.m.BarDesign;
/**
* Gets current value of property {@link #getEnableFlexBox enableFlexBox}.
*
* If this flag is set to true, contentMiddle will be rendered as a HBox and layoutData can be used to allocate available space.
*
* Default value is false
.
* @returns {boolean} Value of property enableFlexBox
*/
public getEnableFlexBox(): boolean;
/**
* Returns a metadata object for class sap.m.Bar.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTranslucent translucent}.
*
* Indicates whether the Bar is partially translucent.
* It is only applied for touch devices.
*
* Default value is false
.
* @returns {boolean} Value of property translucent
*/
public getTranslucent(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContentLeft contentLeft}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContentLeft - The contentLeft whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContentLeft(oContentLeft: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContentMiddle contentMiddle}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContentMiddle - The contentMiddle whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContentMiddle(oContentMiddle: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContentRight contentRight}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContentRight - The contentRight whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContentRight(oContentRight: sap.ui.core.Control): number;
/**
* Inserts a contentLeft into the aggregation {@link #getContentLeft contentLeft}.
* @param {sap.ui.core.Control} oContentLeft - the contentLeft to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the contentLeft should be inserted at; for a negative value of iIndex
, the contentLeft is inserted at position 0; for a value greater than the current size of the aggregation, the contentLeft is inserted at the last position
* @returns {sap.m.Bar} Reference to this
in order to allow method chaining
*/
public insertContentLeft(oContentLeft: sap.ui.core.Control, iIndex: number): sap.m.Bar;
/**
* Inserts a contentMiddle into the aggregation {@link #getContentMiddle contentMiddle}.
* @param {sap.ui.core.Control} oContentMiddle - the contentMiddle to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the contentMiddle should be inserted at; for a negative value of iIndex
, the contentMiddle is inserted at position 0; for a value greater than the current size of the aggregation, the contentMiddle is inserted at the last position
* @returns {sap.m.Bar} Reference to this
in order to allow method chaining
*/
public insertContentMiddle(oContentMiddle: sap.ui.core.Control, iIndex: number): sap.m.Bar;
/**
* Inserts a contentRight into the aggregation {@link #getContentRight contentRight}.
* @param {sap.ui.core.Control} oContentRight - the contentRight to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the contentRight should be inserted at; for a negative value of iIndex
, the contentRight is inserted at position 0; for a value greater than the current size of the aggregation, the contentRight is inserted at the last position
* @returns {sap.m.Bar} Reference to this
in order to allow method chaining
*/
public insertContentRight(oContentRight: sap.ui.core.Control, iIndex: number): sap.m.Bar;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getContentLeft contentLeft}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContentLeft(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getContentMiddle contentMiddle}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContentMiddle(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getContentRight contentRight}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContentRight(): sap.ui.core.Control[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a contentLeft from the aggregation {@link #getContentLeft contentLeft}.
* @param {number|string|sap.ui.core.Control} vContentLeft - The contentLeft to remove or its index or id
* @returns {sap.ui.core.Control} The removed contentLeft or null
*/
public removeContentLeft(vContentLeft: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a contentMiddle from the aggregation {@link #getContentMiddle contentMiddle}.
* @param {number|string|sap.ui.core.Control} vContentMiddle - The contentMiddle to remove or its index or id
* @returns {sap.ui.core.Control} The removed contentMiddle or null
*/
public removeContentMiddle(vContentMiddle: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a contentRight from the aggregation {@link #getContentRight contentRight}.
* @param {number|string|sap.ui.core.Control} vContentRight - The contentRight to remove or its index or id
* @returns {sap.ui.core.Control} The removed contentRight or null
*/
public removeContentRight(vContentRight: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getDesign design}.
*
* Determines the design of the bar. If set to auto, it becomes dependent on the place where the bar is placed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.m.BarDesign} sDesign - New value for property design
* @returns {sap.m.Bar} Reference to this
in order to allow method chaining
*/
public setDesign(sDesign: sap.m.BarDesign): sap.m.Bar;
/**
* Sets a new value for property {@link #getEnableFlexBox enableFlexBox}.
*
* If this flag is set to true, contentMiddle will be rendered as a HBox and layoutData can be used to allocate available space.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableFlexBox - New value for property enableFlexBox
* @returns {sap.m.Bar} Reference to this
in order to allow method chaining
*/
public setEnableFlexBox(bEnableFlexBox: boolean): sap.m.Bar;
/**
* Sets a new value for property {@link #getTranslucent translucent}.
*
* Indicates whether the Bar is partially translucent.
* It is only applied for touch devices.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bTranslucent - New value for property translucent
* @returns {sap.m.Bar} Reference to this
in order to allow method chaining
*/
public setTranslucent(bTranslucent: boolean): sap.m.Bar;
}
/**
* Types of the Bar design
*/
export enum BarDesign {
/**
* The Bar can be inserted into other controls and if the design is "Auto" then it inherits the design from parent control.
*/
Auto = "Auto",
/**
* The bar will be styled like a footer of the page.
*/
Footer = "Footer",
/**
* The bar will be styled like a header of the page.
*/
Header = "Header",
/**
* The bar will be styled like a subheader of the page.
*/
SubHeader = "SubHeader",
}
/**
* Enables users to navigate between items by providing a list of links to previous steps in the user's
* navigation path. The last three steps can be accessed as links directly The remaining links prior to them
* are available in a drop-down menu.
*/
export class Breadcrumbs extends sap.ui.core.Control {
/**
* Constructor for a new Breadcrumbs
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some link to the aggregation {@link #getLinks links}.
* @param {sap.m.Link} oLink - the link to add; if empty, nothing is inserted
* @returns {sap.m.Breadcrumbs} Reference to this
in order to allow method chaining
*/
public addLink(oLink: sap.m.Link): sap.m.Breadcrumbs;
/**
* Destroys all the links in the aggregation {@link #getLinks links}.
* @returns {sap.m.Breadcrumbs} Reference to this
in order to allow method chaining
*/
public destroyLinks(): sap.m.Breadcrumbs;
/**
* Creates a new subclass of class sap.m.Breadcrumbs with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getCurrentLocationText currentLocationText}.
*
* Determines the text of current/last element in the Breadcrumbs path.
* @returns {string} Value of property currentLocationText
*/
public getCurrentLocationText(): string;
/**
* Gets content of aggregation {@link #getLinks links}.
*
* A list of all the active link elements in the Breadcrumbs control.
* Note: Enabling the property wrapping
of the link will not work
* since it's incompatible with the concept of the control.
* The other properties will work, but their effect may be undesirable.
* @returns {sap.m.Link[]}
*/
public getLinks(): sap.m.Link[];
/**
* Returns a metadata object for class sap.m.Breadcrumbs.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.m.Link
in the aggregation {@link #getLinks links}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Link} oLink - The link whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfLink(oLink: sap.m.Link): number;
/**
* Inserts a link into the aggregation {@link #getLinks links}.
* @param {sap.m.Link} oLink - the link to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the link should be inserted at; for a negative value of iIndex
, the link is inserted at position 0; for a value greater than the current size of the aggregation, the link is inserted at the last position
* @returns {sap.m.Breadcrumbs} Reference to this
in order to allow method chaining
*/
public insertLink(oLink: sap.m.Link, iIndex: number): sap.m.Breadcrumbs;
/**
* Removes all the controls from the aggregation {@link #getLinks links}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Link[]} An array of the removed elements (might be empty)
*/
public removeAllLinks(): sap.m.Link[];
/**
* Removes a link from the aggregation {@link #getLinks links}.
* @param {number|string|sap.m.Link} vLink - The link to remove or its index or id
* @returns {sap.m.Link} The removed link or null
*/
public removeLink(vLink: number|string|sap.m.Link): sap.m.Link;
/**
* Sets a new value for property {@link #getCurrentLocationText currentLocationText}.
*
* Determines the text of current/last element in the Breadcrumbs path.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sCurrentLocationText - New value for property currentLocationText
* @returns {sap.m.Breadcrumbs} Reference to this
in order to allow method chaining
*/
public setCurrentLocationText(sCurrentLocationText: string): sap.m.Breadcrumbs;
}
/**
* BusyDialog is used to indicate that the system is busy and the user has to wait.
*/
export class BusyDialog extends sap.ui.core.Control {
/**
* Constructor for a new BusyDialog.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given.
* @param {any} mSettings - Initial settings for the new control.
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.BusyDialog} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.BusyDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:close close} event of this sap.m.BusyDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.BusyDialog
itself.
*
* Fires when the busy dialog is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.BusyDialog
itself
* @returns {sap.m.BusyDialog} Reference to this
in order to allow method chaining
*/
public attachClose(fnFunction: Function, oListener?: any): sap.m.BusyDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:close close} event of this sap.m.BusyDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.BusyDialog
itself.
*
* Fires when the busy dialog is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.BusyDialog
itself
* @returns {sap.m.BusyDialog} Reference to this
in order to allow method chaining
*/
public attachClose(oData: any, fnFunction: Function, oListener?: any): sap.m.BusyDialog;
/**
* Closes the BusyDialog.
* @returns {sap.m.BusyDialog}
*/
public close(): sap.m.BusyDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:close close} event of this sap.m.BusyDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.BusyDialog} Reference to this
in order to allow method chaining
*/
public detachClose(fnFunction: Function, oListener: any): sap.m.BusyDialog;
/**
* Creates a new subclass of class sap.m.BusyDialog with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:close close} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.BusyDialog} Reference to this
in order to allow method chaining
*/
protected fireClose(mParameters?: any): sap.m.BusyDialog;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getCancelButtonText cancelButtonText}.
*
* The text of the cancel button. The default text is "Cancel" (translated to the respective language).
*
* Default value is
.
* @returns {string} Value of property cancelButtonText
*/
public getCancelButtonText(): string;
/**
* Gets current value of property {@link #getCustomIcon customIcon}.
*
* Icon, used from the BusyIndicator. This icon is invisible in iOS platform and it is density aware. You can use the density convention (@2, @1.5, etc.) to provide higher resolution image for higher density screens.
*
* Default value is
.
* @returns {sap.ui.core.URI} Value of property customIcon
*/
public getCustomIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getCustomIconDensityAware customIconDensityAware}.
*
* If this is set to false
, the source image will be loaded directly without attempting to fetch the density perfect image for high density devices.
* By default, this is set to true
but then one or more requests are sent trying to get the density perfect version of the image.
*
* If bandwidth is the key for the application, set this value to false
.
*
* Default value is true
.
* @returns {boolean} Value of property customIconDensityAware
*/
public getCustomIconDensityAware(): boolean;
/**
* Gets current value of property {@link #getCustomIconHeight customIconHeight}.
*
* Height of the provided icon with default value "44px".
*
* Default value is 44px
.
* @returns {sap.ui.core.CSSSize} Value of property customIconHeight
*/
public getCustomIconHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getCustomIconRotationSpeed customIconRotationSpeed}.
*
* Defines the rotation speed of the given image. If GIF file is used, the speed has to be set to 0. The value is in milliseconds.
*
* Default value is 1000
.
* @returns {number} Value of property customIconRotationSpeed
*/
public getCustomIconRotationSpeed(): number;
/**
* Gets current value of property {@link #getCustomIconWidth customIconWidth}.
*
* Width of the provided icon with default value "44px".
*
* Default value is 44px
.
* @returns {sap.ui.core.CSSSize} Value of property customIconWidth
*/
public getCustomIconWidth(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.m.BusyDialog.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowCancelButton showCancelButton}.
*
* Indicates if the cancel button will be rendered inside the busy dialog. The default value is set to false
.
*
* Default value is false
.
* @returns {boolean} Value of property showCancelButton
*/
public getShowCancelButton(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* Optional text displayed inside the dialog.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTitle title}.
*
* Sets the title of the BusyDialog. The default value is an empty string.
*
* Default value is
.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Opens the BusyDialog.
* @returns {sap.m.BusyDialog}
*/
public open(): sap.m.BusyDialog;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getCancelButtonText cancelButtonText}.
*
* The text of the cancel button. The default text is "Cancel" (translated to the respective language).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sCancelButtonText - New value for property cancelButtonText
* @returns {sap.m.BusyDialog} Reference to this
in order to allow method chaining
*/
public setCancelButtonText(sCancelButtonText: string): sap.m.BusyDialog;
/**
* Sets a new value for property {@link #getCustomIcon customIcon}.
*
* Icon, used from the BusyIndicator. This icon is invisible in iOS platform and it is density aware. You can use the density convention (@2, @1.5, etc.) to provide higher resolution image for higher density screens.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.URI} sCustomIcon - New value for property customIcon
* @returns {sap.m.BusyDialog} Reference to this
in order to allow method chaining
*/
public setCustomIcon(sCustomIcon: sap.ui.core.URI): sap.m.BusyDialog;
/**
* Sets a new value for property {@link #getCustomIconDensityAware customIconDensityAware}.
*
* If this is set to false
, the source image will be loaded directly without attempting to fetch the density perfect image for high density devices.
* By default, this is set to true
but then one or more requests are sent trying to get the density perfect version of the image.
*
* If bandwidth is the key for the application, set this value to false
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bCustomIconDensityAware - New value for property customIconDensityAware
* @returns {sap.m.BusyDialog} Reference to this
in order to allow method chaining
*/
public setCustomIconDensityAware(bCustomIconDensityAware: boolean): sap.m.BusyDialog;
/**
* Sets a new value for property {@link #getCustomIconHeight customIconHeight}.
*
* Height of the provided icon with default value "44px".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 44px
.
* @param {sap.ui.core.CSSSize} sCustomIconHeight - New value for property customIconHeight
* @returns {sap.m.BusyDialog} Reference to this
in order to allow method chaining
*/
public setCustomIconHeight(sCustomIconHeight: sap.ui.core.CSSSize): sap.m.BusyDialog;
/**
* Sets a new value for property {@link #getCustomIconRotationSpeed customIconRotationSpeed}.
*
* Defines the rotation speed of the given image. If GIF file is used, the speed has to be set to 0. The value is in milliseconds.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1000
.
* @param {number} iCustomIconRotationSpeed - New value for property customIconRotationSpeed
* @returns {sap.m.BusyDialog} Reference to this
in order to allow method chaining
*/
public setCustomIconRotationSpeed(iCustomIconRotationSpeed: number): sap.m.BusyDialog;
/**
* Sets a new value for property {@link #getCustomIconWidth customIconWidth}.
*
* Width of the provided icon with default value "44px".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 44px
.
* @param {sap.ui.core.CSSSize} sCustomIconWidth - New value for property customIconWidth
* @returns {sap.m.BusyDialog} Reference to this
in order to allow method chaining
*/
public setCustomIconWidth(sCustomIconWidth: sap.ui.core.CSSSize): sap.m.BusyDialog;
/**
* Sets a new value for property {@link #getShowCancelButton showCancelButton}.
*
* Indicates if the cancel button will be rendered inside the busy dialog. The default value is set to false
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowCancelButton - New value for property showCancelButton
* @returns {sap.m.BusyDialog} Reference to this
in order to allow method chaining
*/
public setShowCancelButton(bShowCancelButton: boolean): sap.m.BusyDialog;
/**
* Sets a new value for property {@link #getText text}.
*
* Optional text displayed inside the dialog.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sText - New value for property text
* @returns {sap.m.BusyDialog} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.BusyDialog;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Sets the title of the BusyDialog. The default value is an empty string.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sTitle - New value for property title
* @returns {sap.m.BusyDialog} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.BusyDialog;
}
/**
* Control to indicate that the system is busy with some task and the user has to wait.
*/
export class BusyIndicator extends sap.ui.core.Control {
/**
* Constructor for a new BusyIndicator.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.BusyIndicator} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.BusyIndicator;
/**
* Creates a new subclass of class sap.m.BusyIndicator with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getCustomIcon customIcon}.
*
* Icon URL if an icon is used as the busy indicator.
*
* Default value is
.
* @returns {sap.ui.core.URI} Value of property customIcon
*/
public getCustomIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getCustomIconDensityAware customIconDensityAware}.
*
* If this is set to false, the src image will be loaded directly without attempting
* to fetch the density perfect image for high density device.
* By default, this is set to true but then one or more requests are sent to the server,
* trying to get the density perfect version of the specified image.
* If bandwidth is the key for the application, set this value to false.
*
* Default value is true
.
* @returns {boolean} Value of property customIconDensityAware
*/
public getCustomIconDensityAware(): boolean;
/**
* Gets current value of property {@link #getCustomIconHeight customIconHeight}.
*
* Height of the provided icon. By default 44px are used.
*
* Default value is 44px
.
* @returns {sap.ui.core.CSSSize} Value of property customIconHeight
*/
public getCustomIconHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getCustomIconRotationSpeed customIconRotationSpeed}.
*
* Defines the rotation speed of the given image.
* If a .gif is used, the speed has to be set to 0.
* The unit is in ms.
* Note: Values are considered valid when greater than or equal to 0.
* If invalid value is provided the speed defaults to 0.
*
* Default value is 1000
.
* @returns {number} Value of property customIconRotationSpeed
*/
public getCustomIconRotationSpeed(): number;
/**
* Gets current value of property {@link #getCustomIconWidth customIconWidth}.
*
* Width of the provided icon. By default 44px are used.
*
* Default value is 44px
.
* @returns {sap.ui.core.CSSSize} Value of property customIconWidth
*/
public getCustomIconWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getDesign design}.
*
* Setting this property will not have any effect on the appearance of the BusyIndicator
* in versions greater than or equal to 1.32.1
*
* Default value is auto
.
* @returns {string} Value of property design
*/
public getDesign(): string;
/**
* Returns a metadata object for class sap.m.BusyIndicator.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSize size}.
*
* Defines the size of the busy indicator.
* The animation consists of three circles, each of which will be this size.
* Therefore the total width of the control amounts to three times the given size.
*
* Default value is 1rem
.
* @returns {sap.ui.core.CSSSize} Value of property size
*/
public getSize(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getText text}.
*
* Defines text to be displayed below the busy indicator.
* It can be used to inform the user of the current operation.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Options for the text direction are RTL and LTR.
* Alternatively, the control can inherit the text direction from its parent container.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getCustomIcon customIcon}.
*
* Icon URL if an icon is used as the busy indicator.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.URI} sCustomIcon - New value for property customIcon
* @returns {sap.m.BusyIndicator} Reference to this
in order to allow method chaining
*/
public setCustomIcon(sCustomIcon: sap.ui.core.URI): sap.m.BusyIndicator;
/**
* Sets a new value for property {@link #getCustomIconDensityAware customIconDensityAware}.
*
* If this is set to false, the src image will be loaded directly without attempting
* to fetch the density perfect image for high density device.
* By default, this is set to true but then one or more requests are sent to the server,
* trying to get the density perfect version of the specified image.
* If bandwidth is the key for the application, set this value to false.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bCustomIconDensityAware - New value for property customIconDensityAware
* @returns {sap.m.BusyIndicator} Reference to this
in order to allow method chaining
*/
public setCustomIconDensityAware(bCustomIconDensityAware: boolean): sap.m.BusyIndicator;
/**
* Sets a new value for property {@link #getCustomIconHeight customIconHeight}.
*
* Height of the provided icon. By default 44px are used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 44px
.
* @param {sap.ui.core.CSSSize} sCustomIconHeight - New value for property customIconHeight
* @returns {sap.m.BusyIndicator} Reference to this
in order to allow method chaining
*/
public setCustomIconHeight(sCustomIconHeight: sap.ui.core.CSSSize): sap.m.BusyIndicator;
/**
* Sets a new value for property {@link #getCustomIconRotationSpeed customIconRotationSpeed}.
*
* Defines the rotation speed of the given image.
* If a .gif is used, the speed has to be set to 0.
* The unit is in ms.
* Note: Values are considered valid when greater than or equal to 0.
* If invalid value is provided the speed defaults to 0.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1000
.
* @param {number} iCustomIconRotationSpeed - New value for property customIconRotationSpeed
* @returns {sap.m.BusyIndicator} Reference to this
in order to allow method chaining
*/
public setCustomIconRotationSpeed(iCustomIconRotationSpeed: number): sap.m.BusyIndicator;
/**
* Sets a new value for property {@link #getCustomIconWidth customIconWidth}.
*
* Width of the provided icon. By default 44px are used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 44px
.
* @param {sap.ui.core.CSSSize} sCustomIconWidth - New value for property customIconWidth
* @returns {sap.m.BusyIndicator} Reference to this
in order to allow method chaining
*/
public setCustomIconWidth(sCustomIconWidth: sap.ui.core.CSSSize): sap.m.BusyIndicator;
/**
* Sets a new value for property {@link #getDesign design}.
*
* Setting this property will not have any effect on the appearance of the BusyIndicator
* in versions greater than or equal to 1.32.1
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {string} sDesign - New value for property design
* @returns {sap.m.BusyIndicator} Reference to this
in order to allow method chaining
*/
public setDesign(sDesign: string): sap.m.BusyIndicator;
/**
* Sets a new value for property {@link #getSize size}.
*
* Defines the size of the busy indicator.
* The animation consists of three circles, each of which will be this size.
* Therefore the total width of the control amounts to three times the given size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1rem
.
* @param {sap.ui.core.CSSSize} sSize - New value for property size
* @returns {sap.m.BusyIndicator} Reference to this
in order to allow method chaining
*/
public setSize(sSize: sap.ui.core.CSSSize): sap.m.BusyIndicator;
/**
* Sets a new value for property {@link #getText text}.
*
* Defines text to be displayed below the busy indicator.
* It can be used to inform the user of the current operation.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sText - New value for property text
* @returns {sap.m.BusyIndicator} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.BusyIndicator;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Options for the text direction are RTL and LTR.
* Alternatively, the control can inherit the text direction from its parent container.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.BusyIndicator} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.BusyIndicator;
}
/**
* Enables users to trigger actions. For the button UI, you can define some text or an icon, or both.
*/
export class Button extends sap.ui.core.Control {
/**
* Constructor for a new Button.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Button;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Button;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.Button
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Button
itself.
*
* Event is fired when the user clicks on the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Button
itself
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.Button;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.Button
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Button
itself.
*
* Event is fired when the user clicks on the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Button
itself
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.Button;
/**
* Attaches event handler fnFunction
to the {@link #event:tap tap} event of this sap.m.Button
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Button
itself.
*
* Event is fired when the user taps the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Button
itself
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
public attachTap(fnFunction: Function, oListener?: any): sap.m.Button;
/**
* Attaches event handler fnFunction
to the {@link #event:tap tap} event of this sap.m.Button
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Button
itself.
*
* Event is fired when the user taps the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Button
itself
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
public attachTap(oData: any, fnFunction: Function, oListener?: any): sap.m.Button;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.Button
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.Button;
/**
* Detaches event handler fnFunction
from the {@link #event:tap tap} event of this sap.m.Button
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
public detachTap(fnFunction: Function, oListener: any): sap.m.Button;
/**
* Creates a new subclass of class sap.m.Button with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.Button;
/**
* Fires event {@link #event:tap tap} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
protected fireTap(mParameters?: any): sap.m.Button;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getActiveIcon activeIcon}.
*
* The source property of an alternative icon for the active (depressed) state of the button.
* Both active and default icon properties should be defined and have the same type: image or icon font.
* If the icon
property is not set or has a different type, the active icon is not displayed.
* @returns {sap.ui.core.URI} Value of property activeIcon
*/
public getActiveIcon(): sap.ui.core.URI;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Boolean property to enable the control (default is true). Buttons that are disabled have other colors than enabled ones, depending on custom settings
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Icon to be displayed as graphical element within the button. This can be an image or an icon from the icon font.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconDensityAware iconDensityAware}.
*
* By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
*
* If only one version of image is provided, set this value to false to avoid the attempt of fetching density perfect image.
*
* Default value is true
.
* @returns {boolean} Value of property iconDensityAware
*/
public getIconDensityAware(): boolean;
/**
* Gets current value of property {@link #getIconFirst iconFirst}.
*
* If set to true (default), the display sequence is 1. icon 2. control text
*
* Default value is true
.
* @returns {boolean} Value of property iconFirst
*/
public getIconFirst(): boolean;
/**
* Returns a metadata object for class sap.m.Button.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Defines to which DOM reference the Popup should be docked
* @returns {HTMLElement} the DOM reference that Popup should dock to
*/
protected getPopupAnchorDomRef(): HTMLElement;
/**
* Gets current value of property {@link #getText text}.
*
* Button text
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* This property specifies the element's text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getType type}.
*
* Type of a button (e.g. Default, Accept, Reject, Back, etc.)
*
* Default value is Default
.
* @returns {sap.m.ButtonType} Value of property type
*/
public getType(): sap.m.ButtonType;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the button.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getActiveIcon activeIcon}.
*
* The source property of an alternative icon for the active (depressed) state of the button.
* Both active and default icon properties should be defined and have the same type: image or icon font.
* If the icon
property is not set or has a different type, the active icon is not displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sActiveIcon - New value for property activeIcon
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
public setActiveIcon(sActiveIcon: sap.ui.core.URI): sap.m.Button;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Boolean property to enable the control (default is true). Buttons that are disabled have other colors than enabled ones, depending on custom settings
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.Button;
/**
* Property setter for the icon
* @param {sap.ui.core.URI} sIcon - new value of the Icon property
* @returns {sap.m.Button} this to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.Button;
/**
* Sets a new value for property {@link #getIconDensityAware iconDensityAware}.
*
* By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
*
* If only one version of image is provided, set this value to false to avoid the attempt of fetching density perfect image.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconDensityAware - New value for property iconDensityAware
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
public setIconDensityAware(bIconDensityAware: boolean): sap.m.Button;
/**
* Sets a new value for property {@link #getIconFirst iconFirst}.
*
* If set to true (default), the display sequence is 1. icon 2. control text
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconFirst - New value for property iconFirst
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
public setIconFirst(bIconFirst: boolean): sap.m.Button;
/**
* Property setter for the text
* @param {string} sText - new value of the Text attribute
* @returns {sap.m.Button} this to allow method chaining
*/
public setText(sText: string): sap.m.Button;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* This property specifies the element's text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.Button;
/**
* Sets a new value for property {@link #getType type}.
*
* Type of a button (e.g. Default, Accept, Reject, Back, etc.)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Default
.
* @param {sap.m.ButtonType} sType - New value for property type
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.m.ButtonType): sap.m.Button;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the button.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.Button} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.Button;
}
/**
* Different types for a button (predefined types)
*/
export enum ButtonType {
/**
* accept type (green button)
*/
Accept = "Accept",
/**
* back type (back navigation button for header)
*/
Back = "Back",
/**
* default type (no special styling)
*/
Default = "Default",
/**
* emphasized type
*/
Emphasized = "Emphasized",
/**
* reject style (red button)
*/
Reject = "Reject",
/**
* transparent type
*/
Transparent = "Transparent",
/**
* Unstyled type (no styling)
*/
Unstyled = "Unstyled",
/**
* up type (up navigation button for header)
*/
Up = "Up",
}
/**
* The Carousel control can be used to navigate through a list of sap.m controls just like flipping through the pages of a book by swiping right or left. mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some page to the aggregation {@link #getPages pages}.
* @param {sap.ui.core.Control} oPage - the page to add; if empty, nothing is inserted
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public addPage(oPage: sap.ui.core.Control): sap.m.Carousel;
/**
* Attaches event handler fnFunction
to the {@link #event:loadPage loadPage} event of this sap.m.Carousel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Carousel
itself.
*
* Carousel requires a new page to be loaded. This event may be used to fill the content of that page
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Carousel
itself
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public attachLoadPage(fnFunction: Function, oListener?: any): sap.m.Carousel;
/**
* Attaches event handler fnFunction
to the {@link #event:loadPage loadPage} event of this sap.m.Carousel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Carousel
itself.
*
* Carousel requires a new page to be loaded. This event may be used to fill the content of that page
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Carousel
itself
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public attachLoadPage(oData: any, fnFunction: Function, oListener?: any): sap.m.Carousel;
/**
* Attaches event handler fnFunction
to the {@link #event:pageChanged pageChanged} event of this sap.m.Carousel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Carousel
itself.
*
* This event is fired after a carousel swipe has been completed. It is triggered both by physical swipe events and through API carousel manipulations such as calling 'next', 'previous' or 'setActivePageId' functions.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Carousel
itself
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public attachPageChanged(fnFunction: Function, oListener?: any): sap.m.Carousel;
/**
* Attaches event handler fnFunction
to the {@link #event:pageChanged pageChanged} event of this sap.m.Carousel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Carousel
itself.
*
* This event is fired after a carousel swipe has been completed. It is triggered both by physical swipe events and through API carousel manipulations such as calling 'next', 'previous' or 'setActivePageId' functions.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Carousel
itself
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public attachPageChanged(oData: any, fnFunction: Function, oListener?: any): sap.m.Carousel;
/**
* Attaches event handler fnFunction
to the {@link #event:unloadPage unloadPage} event of this sap.m.Carousel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Carousel
itself.
*
* Carousel does not display a page any longer and unloads it. This event may be used to clean up the content of that page.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Carousel
itself
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public attachUnloadPage(fnFunction: Function, oListener?: any): sap.m.Carousel;
/**
* Attaches event handler fnFunction
to the {@link #event:unloadPage unloadPage} event of this sap.m.Carousel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Carousel
itself.
*
* Carousel does not display a page any longer and unloads it. This event may be used to clean up the content of that page.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Carousel
itself
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public attachUnloadPage(oData: any, fnFunction: Function, oListener?: any): sap.m.Carousel;
/**
* Destroys all the pages in the aggregation {@link #getPages pages}.
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public destroyPages(): sap.m.Carousel;
/**
* Detaches event handler fnFunction
from the {@link #event:loadPage loadPage} event of this sap.m.Carousel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public detachLoadPage(fnFunction: Function, oListener: any): sap.m.Carousel;
/**
* Detaches event handler fnFunction
from the {@link #event:pageChanged pageChanged} event of this sap.m.Carousel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public detachPageChanged(fnFunction: Function, oListener: any): sap.m.Carousel;
/**
* Detaches event handler fnFunction
from the {@link #event:unloadPage unloadPage} event of this sap.m.Carousel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public detachUnloadPage(fnFunction: Function, oListener: any): sap.m.Carousel;
/**
* Creates a new subclass of class sap.m.Carousel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:loadPage loadPage} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
protected fireLoadPage(mParameters?: any): sap.m.Carousel;
/**
* Fires event {@link #event:pageChanged pageChanged} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
protected firePageChanged(mParameters?: any): sap.m.Carousel;
/**
* Fires event {@link #event:unloadPage unloadPage} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
protected fireUnloadPage(mParameters?: any): sap.m.Carousel;
/**
* ID of the element which is the current target of the association {@link #getActivePage activePage}, or null
.
* @returns {sap.ui.core.ID}
*/
public getActivePage(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getArrowsPlacement arrowsPlacement}.
*
* Defines where the carousel's arrows are placed. Default is sap.m.CarouselArrowsPlacement.Content
used to
* place the arrows on the sides of the carousel. Alternatively sap.m.CarouselArrowsPlacement.PageIndicator
can
* be used to place the arrows on the sides of the page indicator.
*
* Default value is Content
.
* @returns {sap.m.CarouselArrowsPlacement} Value of property arrowsPlacement
*/
public getArrowsPlacement(): sap.m.CarouselArrowsPlacement;
/**
* Gets current value of property {@link #getBusyIndicatorSize busyIndicatorSize}.
*
* Size of the busy indicators which can be displayed in the carousel.
*
* Default value is 6em
.
* @returns {sap.ui.core.CSSSize} Value of property busyIndicatorSize
*/
public getBusyIndicatorSize(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getHeight height}.
*
* The height of the carousel. Note that when a percentage value is used, the height of the surrounding container must be defined.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getLoop loop}.
*
* Defines whether the carousel should loop, i.e show the first page after the last page is reached and vice versa.
*
* Default value is false
.
* @returns {boolean} Value of property loop
*/
public getLoop(): boolean;
/**
* Returns a metadata object for class sap.m.Carousel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPageIndicatorPlacement pageIndicatorPlacement}.
*
* Defines where the carousel's page indicator is displayed. Possible values are sap.m.PlacementType.Top, sap.m.PlacementType.Bottom. Other values are ignored and the default value will be applied. The default value is sap.m.PlacementType.Bottom.
*
* Default value is Bottom
.
* @returns {sap.m.PlacementType} Value of property pageIndicatorPlacement
*/
public getPageIndicatorPlacement(): sap.m.PlacementType;
/**
* Gets content of aggregation {@link #getPages pages}.
*
* The content which the carousel displays.
* @returns {sap.ui.core.Control[]}
*/
public getPages(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getShowBusyIndicator showBusyIndicator}.
*
* Show or hide busy indicator in the carousel when loading pages after swipe.
*
* Default value is true
.
* @returns {boolean} Value of property showBusyIndicator
*/
public getShowBusyIndicator(): boolean;
/**
* Gets current value of property {@link #getShowPageIndicator showPageIndicator}.
*
* Show or hide carousel's page indicator.
*
* Default value is true
.
* @returns {boolean} Value of property showPageIndicator
*/
public getShowPageIndicator(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* The width of the carousel. Note that when a percentage value is used, the height of the surrounding container must be defined.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getPages pages}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oPage - The page whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfPage(oPage: sap.ui.core.Control): number;
/**
* Inserts a page into the aggregation {@link #getPages pages}.
* @param {sap.ui.core.Control} oPage - the page to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the page should be inserted at; for a negative value of iIndex
, the page is inserted at position 0; for a value greater than the current size of the aggregation, the page is inserted at the last position
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public insertPage(oPage: sap.ui.core.Control, iIndex: number): sap.m.Carousel;
/**
* Call this method to display the next page (corresponds to a swipe right). Returns 'this' for method chaining.
* @returns {sap.m.Carousel}
*/
public next(): sap.m.Carousel;
/**
* Call this method to display the previous page (corresponds to a swipe left). Returns 'this' for method chaining.
* @returns {sap.m.Carousel}
*/
public previous(): sap.m.Carousel;
/**
* Removes all the controls from the aggregation {@link #getPages pages}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllPages(): sap.ui.core.Control[];
/**
* Removes a page from the aggregation {@link #getPages pages}.
* @param {number|string|sap.ui.core.Control} vPage - The page to remove or its index or id
* @returns {sap.ui.core.Control} The removed page or null
*/
public removePage(vPage: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets the associated {@link #getActivePage activePage}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oActivePage - ID of an element which becomes the new target of this activePage association; alternatively, an element instance may be given
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public setActivePage(oActivePage: sap.ui.core.ID|sap.ui.core.Control): sap.m.Carousel;
/**
* Sets a new value for property {@link #getArrowsPlacement arrowsPlacement}.
*
* Defines where the carousel's arrows are placed. Default is sap.m.CarouselArrowsPlacement.Content
used to
* place the arrows on the sides of the carousel. Alternatively sap.m.CarouselArrowsPlacement.PageIndicator
can
* be used to place the arrows on the sides of the page indicator.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Content
.
* @param {sap.m.CarouselArrowsPlacement} sArrowsPlacement - New value for property arrowsPlacement
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public setArrowsPlacement(sArrowsPlacement: sap.m.CarouselArrowsPlacement): sap.m.Carousel;
/**
* Sets a new value for property {@link #getBusyIndicatorSize busyIndicatorSize}.
*
* Size of the busy indicators which can be displayed in the carousel.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 6em
.
* @param {sap.ui.core.CSSSize} sBusyIndicatorSize - New value for property busyIndicatorSize
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public setBusyIndicatorSize(sBusyIndicatorSize: sap.ui.core.CSSSize): sap.m.Carousel;
/**
* Sets a new value for property {@link #getHeight height}.
*
* The height of the carousel. Note that when a percentage value is used, the height of the surrounding container must be defined.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.m.Carousel;
/**
* Sets a new value for property {@link #getLoop loop}.
*
* Defines whether the carousel should loop, i.e show the first page after the last page is reached and vice versa.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bLoop - New value for property loop
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public setLoop(bLoop: boolean): sap.m.Carousel;
/**
* Sets a new value for property {@link #getPageIndicatorPlacement pageIndicatorPlacement}.
*
* Defines where the carousel's page indicator is displayed. Possible values are sap.m.PlacementType.Top, sap.m.PlacementType.Bottom. Other values are ignored and the default value will be applied. The default value is sap.m.PlacementType.Bottom.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Bottom
.
* @param {sap.m.PlacementType} sPageIndicatorPlacement - New value for property pageIndicatorPlacement
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public setPageIndicatorPlacement(sPageIndicatorPlacement: sap.m.PlacementType): sap.m.Carousel;
/**
* Sets a new value for property {@link #getShowBusyIndicator showBusyIndicator}.
*
* Show or hide busy indicator in the carousel when loading pages after swipe.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowBusyIndicator - New value for property showBusyIndicator
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public setShowBusyIndicator(bShowBusyIndicator: boolean): sap.m.Carousel;
/**
* Sets a new value for property {@link #getShowPageIndicator showPageIndicator}.
*
* Show or hide carousel's page indicator.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowPageIndicator - New value for property showPageIndicator
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public setShowPageIndicator(bShowPageIndicator: boolean): sap.m.Carousel;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The width of the carousel. Note that when a percentage value is used, the height of the surrounding container must be defined.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.Carousel} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.Carousel;
}
/**
* Carousel arrows align
*/
export enum CarouselArrowsPlacement {
/**
* Carousel arrows are placed on the sides of the current Carousel page.
*/
Content = "Content",
/**
* Carousel arrows are placed on the sides of the page indicator of the Carousel.
*/
PageIndicator = "PageIndicator",
}
/**
* The CheckBox control allows the user to select one or multiple items from a list. To select each item the user has to select the square box in front of it.
*/
export class CheckBox extends sap.ui.core.Control {
/**
* Constructor for a new CheckBox.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - The ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - The Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.CheckBox} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.CheckBox;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.CheckBox} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.CheckBox;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.CheckBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.CheckBox
itself.
*
* Event is triggered when the control status is changed by the user by selecting or deselecting the checkbox.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.CheckBox
itself
* @returns {sap.m.CheckBox} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.m.CheckBox;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.CheckBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.CheckBox
itself.
*
* Event is triggered when the control status is changed by the user by selecting or deselecting the checkbox.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.CheckBox
itself
* @returns {sap.m.CheckBox} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.m.CheckBox;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.m.CheckBox
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.CheckBox} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.m.CheckBox;
/**
* Creates a new subclass of class sap.m.CheckBox with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.CheckBox} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.m.CheckBox;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getActiveHandling activeHandling}.
*
* Flag to switch on activeHandling, when it is switched off, there will be no visual changes on active state. Default value is 'true'
*
* Default value is true
.
* @returns {boolean} Value of property activeHandling
*/
public getActiveHandling(): boolean;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEditable editable}.
*
* Specifies whether the user shall be allowed to edit the state of the checkbox
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Disables the Checkbox. Disabled controls are not interactive and are rendered differently according to the theme.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Returns a metadata object for class sap.m.CheckBox.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* The 'name' property to be used in the HTML code, for example for HTML forms that send data to the server via submit.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets current value of property {@link #getSelected selected}.
*
* Stores the state of the checkbox whether it is selected or not.
*
* Default value is false
.
* @returns {boolean} Value of property selected
*/
public getSelected(): boolean;
/**
* Returns the CheckBox`s tab index.
* @returns {number} iTabIndex for Checkbox
*/
protected getTabIndex(): number;
/**
* Gets current value of property {@link #getText text}.
*
* Defines the text displayed next to the checkbox
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextAlign textAlign}.
*
* Aligns the text of the checkbox. Available alignment settings are "Begin", "Center", "End", "Left", and "Right".
*
* Default value is Begin
.
* @returns {sap.ui.core.TextAlign} Value of property textAlign
*/
public getTextAlign(): sap.ui.core.TextAlign;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Options for the text direction are RTL and LTR. Alternatively, the control can inherit the text direction from its parent container.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Accepts the core enumeration ValueState.type that supports 'None', 'Error', 'Warning' and 'Success'.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the checkbox`s label
*
* Default value is
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getActiveHandling activeHandling}.
*
* Flag to switch on activeHandling, when it is switched off, there will be no visual changes on active state. Default value is 'true'
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bActiveHandling - New value for property activeHandling
* @returns {sap.m.CheckBox} Reference to this
in order to allow method chaining
*/
public setActiveHandling(bActiveHandling: boolean): sap.m.CheckBox;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Specifies whether the user shall be allowed to edit the state of the checkbox
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.m.CheckBox} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.m.CheckBox;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Disables the Checkbox. Disabled controls are not interactive and are rendered differently according to the theme.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.CheckBox} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.CheckBox;
/**
* Sets a new value for property {@link #getName name}.
*
* The 'name' property to be used in the HTML code, for example for HTML forms that send data to the server via submit.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.m.CheckBox} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.m.CheckBox;
/**
* Sets the tab index of the control
* @param {number} iTabIndex - The tab index should be greater than or equal -1
* @returns {sap.m.CheckBox}
*/
protected setTabIndex(iTabIndex: number): sap.m.CheckBox;
/**
* Sets a new value for property {@link #getText text}.
*
* Defines the text displayed next to the checkbox
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.m.CheckBox} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.CheckBox;
/**
* Sets a new value for property {@link #getTextAlign textAlign}.
*
* Aligns the text of the checkbox. Available alignment settings are "Begin", "Center", "End", "Left", and "Right".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Begin
.
* @param {sap.ui.core.TextAlign} sTextAlign - New value for property textAlign
* @returns {sap.m.CheckBox} Reference to this
in order to allow method chaining
*/
public setTextAlign(sTextAlign: sap.ui.core.TextAlign): sap.m.CheckBox;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Options for the text direction are RTL and LTR. Alternatively, the control can inherit the text direction from its parent container.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.CheckBox} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.CheckBox;
/**
* Sets a new value for property {@link #getValueState valueState}.
*
* Accepts the core enumeration ValueState.type that supports 'None', 'Error', 'Warning' and 'Success'.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sValueState - New value for property valueState
* @returns {sap.m.CheckBox} Reference to this
in order to allow method chaining
*/
public setValueState(sValueState: sap.ui.core.ValueState): sap.m.CheckBox;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of the checkbox`s label
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.CheckBox} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.CheckBox;
}
/**
* The sap.m.Column
allows to define column specific properties that will be applied when rendering the sap.m.Table
.
*/
export class Column extends sap.ui.core.Element {
/**
* Constructor for a new Column.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Apply text alignment of the Column to Text/Label/Link...
*
* TODO: This is so ugly to check content functions
* instead we should document how to use our controls
* to inherit text-alignment and we should add a new
* sap.ui.core.TextAlign type called "Inherit"
* @param {sap.ui.core.Control} oControl - List control
* @param {string} sAlign - TextAlign enumeration
* @returns {sap.ui.core.Control} oControl
*/
protected applyAlignTo(oControl: sap.ui.core.Control, sAlign?: string): sap.ui.core.Control;
/**
* Clears the last value of the column if mergeDuplicates property is true
* @returns {sap.m.Column}
*/
protected clearLastValue(): sap.m.Column;
/**
* Destroys the footer in the aggregation {@link #getFooter footer}.
* @returns {sap.m.Column} Reference to this
in order to allow method chaining
*/
public destroyFooter(): sap.m.Column;
/**
* Destroys the header in the aggregation {@link #getHeader header}.
* @returns {sap.m.Column} Reference to this
in order to allow method chaining
*/
public destroyHeader(): sap.m.Column;
/**
* Creates a new subclass of class sap.m.Column with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns CSS alignment according to column hAlign setting or given parameter
* for Begin/End values checks the locale settings
* @param {string} sAlign - TextAlign enumeration
* @returns {string} left|center|right
*/
protected getCssAlign(sAlign?: string): string;
/**
* Gets current value of property {@link #getDemandPopin demandPopin}.
*
* According to your minScreenWidth settings, the column can be hidden in different screen sizes.
* Setting this property to true, shows this column as pop-in instead of hiding it.
*
* Default value is false
.
* @returns {boolean} Value of property demandPopin
*/
public getDemandPopin(): boolean;
/**
* Gets content of aggregation {@link #getFooter footer}.
*
* Control to be displayed in the column footer.
* @returns {sap.ui.core.Control}
*/
public getFooter(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getHAlign hAlign}.
*
* Horizontal alignment of the column content. Available alignment settings are "Begin", "Center", "End", "Left", and "Right".
*
* NOTE: Control with a "textAlign" property inherits the horizontal alignment.
*
* Default value is Begin
.
* @returns {sap.ui.core.TextAlign} Value of property hAlign
*/
public getHAlign(): sap.ui.core.TextAlign;
/**
* Gets content of aggregation {@link #getHeader header}.
*
* Control to be displayed in the column header.
* @returns {sap.ui.core.Control}
*/
public getHeader(): sap.ui.core.Control;
/**
* Gets the initial order of the column
* @returns {number} initial order of the column
*/
protected getInitialOrder(): number;
/**
* Gets the last value of the column
* @returns {any}
*/
protected getLastValue(): any;
/**
* Gets current value of property {@link #getMergeDuplicates mergeDuplicates}.
*
* Set "true" to merge repeating cells(duplicates) into one cell block.
* Please see "mergeFunctionName" property to customize this property.
* Note: This feature must not be used together with two-way binding. This property is ignored if a column is shown in the pop-in.
*
* Default value is false
.
* @returns {boolean} Value of property mergeDuplicates
*/
public getMergeDuplicates(): boolean;
/**
* Gets current value of property {@link #getMergeFunctionName mergeFunctionName}.
*
* Defines the value getter(serialization) function if "mergeDuplicates" property is set "true"
* Control itself uses this function to compare values of two repeating cells.
* Default value "getText" is suitable for Label and Text control.
* e.g. For "Icon" control "getSrc" can be used.
* Note: You can pass one string parameter to given function after "#" sign. e.g. "data#myparameter"
*
* Default value is getText
.
* @returns {string} Value of property mergeFunctionName
*/
public getMergeFunctionName(): string;
/**
* Returns a metadata object for class sap.m.Column.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinScreenWidth minScreenWidth}.
*
* By default column is always shown. If you set this property, control checks the minimum width of the screen to show or hide this column.
* As you can give specific CSS sizes(e.g: "480px" or "40em"), you can also use sap.m.ScreenSize enumeration(e.g: "Phone", "Tablet", "Desktop", "Small", "Medium", "Large", ....).
*
* sap.m.Column.MediaQuery1->Range1 = 199
*
* This property can be used for responsive design. e.g: "40em"(or "640px" or "Tablet") setting shows this column in iPad(and Desktop) but hides in iPhone.
* Please also see "demandPopin" property
* @returns {string} Value of property minScreenWidth
*/
public getMinScreenWidth(): string;
/**
* Gets the order of the column
* @returns {number} nOrder order of the column
*/
protected getOrder(): number;
/**
* Gets current value of property {@link #getPopinDisplay popinDisplay}.
*
* Defines enumerated display options for the pop-in.
*
* Default value is Block
.
* @returns {sap.m.PopinDisplay} Value of property popinDisplay
*/
public getPopinDisplay(): sap.m.PopinDisplay;
/**
* Gets current value of property {@link #getPopinHAlign popinHAlign}.
*
* Horizontal alignment of the pop-in content. Available alignment settings are "Begin", "Center", "End", "Left", and "Right".
*
* NOTE: Controls with a text align do not inherit the horizontal alignment.
*
* Default value is Begin
.
* @returns {sap.ui.core.TextAlign} Value of property popinHAlign
*/
public getPopinHAlign(): sap.ui.core.TextAlign;
/**
* Gets current value of property {@link #getStyleClass styleClass}.
*
* CSS class name for column contents(header, cells and footer of column). This property can be used for different column styling. If column is shown as pop-in then this class name is applied to related pop-in row.
* @returns {string} Value of property styleClass
*/
public getStyleClass(): string;
/**
* Gets current value of property {@link #getVAlign vAlign}.
*
* Vertical alignment of the cells in a column. Possible values are "Inherit", "Top", "Middle", "Bottom"
* This property does not affect the vertical alignment of header and footer.
*
* Default value is Inherit
.
* @returns {sap.ui.core.VerticalAlign} Value of property vAlign
*/
public getVAlign(): sap.ui.core.VerticalAlign;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Specifies whether or not the column is visible. Invisible columns are not rendered.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the column. If you leave it empty then this column covers the remaining space.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Determines whether the column will be hidden via media queries or not
*/
protected isHidden(): void;
/**
* Determines whether the column will be shown as pop-in or not
*/
protected isPopin(): void;
/**
* Gets called from the Table when the all items are removed
*/
protected onItemsRemoved(): void;
/**
* Sets a new value for property {@link #getDemandPopin demandPopin}.
*
* According to your minScreenWidth settings, the column can be hidden in different screen sizes.
* Setting this property to true, shows this column as pop-in instead of hiding it.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bDemandPopin - New value for property demandPopin
* @returns {sap.m.Column} Reference to this
in order to allow method chaining
*/
public setDemandPopin(bDemandPopin: boolean): sap.m.Column;
/**
* Display or hide the column from given table
* This does not set the visibility property of the column
* @param {Object} oTableDomRef - Table DOM reference
* @param {boolean} bDisplay - whether visible or not
*/
protected setDisplay(oTableDomRef: Object, bDisplay?: boolean): void;
/**
* Display or hide the column from given table via checking media query changes
* @param {Object} oTableDomRef - Table DOM reference
*/
protected setDisplayViaMedia(oTableDomRef: Object): void;
/**
* Sets the aggregated {@link #getFooter footer}.
* @param {sap.ui.core.Control} oFooter - The footer to set
* @returns {sap.m.Column} Reference to this
in order to allow method chaining
*/
public setFooter(oFooter: sap.ui.core.Control): sap.m.Column;
/**
* Sets a new value for property {@link #getHAlign hAlign}.
*
* Horizontal alignment of the column content. Available alignment settings are "Begin", "Center", "End", "Left", and "Right".
*
* NOTE: Control with a "textAlign" property inherits the horizontal alignment.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Begin
.
* @param {sap.ui.core.TextAlign} sHAlign - New value for property hAlign
* @returns {sap.m.Column} Reference to this
in order to allow method chaining
*/
public setHAlign(sHAlign: sap.ui.core.TextAlign): sap.m.Column;
/**
* Sets the aggregated {@link #getHeader header}.
* @param {sap.ui.core.Control} oHeader - The header to set
* @returns {sap.m.Column} Reference to this
in order to allow method chaining
*/
public setHeader(oHeader: sap.ui.core.Control): sap.m.Column;
/**
* Sets the visible column index
* Negative index values can be used to clear
* @param {number} nIndex - index of the visible column
*/
protected setIndex(nIndex: number): void;
/**
* Sets the initial order of the column
* @param {number} nOrder - initial order of the column
*/
protected setInitialOrder(nOrder: number): void;
/**
* Sets the last value of the column if mergeDuplicates property is true
* @param {any} value - Any Value
* @returns {sap.m.Column}
*/
protected setLastValue(value: any): sap.m.Column;
/**
* Sets a new value for property {@link #getMergeDuplicates mergeDuplicates}.
*
* Set "true" to merge repeating cells(duplicates) into one cell block.
* Please see "mergeFunctionName" property to customize this property.
* Note: This feature must not be used together with two-way binding. This property is ignored if a column is shown in the pop-in.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bMergeDuplicates - New value for property mergeDuplicates
* @returns {sap.m.Column} Reference to this
in order to allow method chaining
*/
public setMergeDuplicates(bMergeDuplicates: boolean): sap.m.Column;
/**
* Sets a new value for property {@link #getMergeFunctionName mergeFunctionName}.
*
* Defines the value getter(serialization) function if "mergeDuplicates" property is set "true"
* Control itself uses this function to compare values of two repeating cells.
* Default value "getText" is suitable for Label and Text control.
* e.g. For "Icon" control "getSrc" can be used.
* Note: You can pass one string parameter to given function after "#" sign. e.g. "data#myparameter"
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is getText
.
* @param {string} sMergeFunctionName - New value for property mergeFunctionName
* @returns {sap.m.Column} Reference to this
in order to allow method chaining
*/
public setMergeFunctionName(sMergeFunctionName: string): sap.m.Column;
/**
* Sets a new value for property {@link #getMinScreenWidth minScreenWidth}.
*
* By default column is always shown. If you set this property, control checks the minimum width of the screen to show or hide this column.
* As you can give specific CSS sizes(e.g: "480px" or "40em"), you can also use sap.m.ScreenSize enumeration(e.g: "Phone", "Tablet", "Desktop", "Small", "Medium", "Large", ....).
*
* sap.m.Column.MediaQuery1->Range1 = 199
*
* This property can be used for responsive design. e.g: "40em"(or "640px" or "Tablet") setting shows this column in iPad(and Desktop) but hides in iPhone.
* Please also see "demandPopin" property
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sMinScreenWidth - New value for property minScreenWidth
* @returns {sap.m.Column} Reference to this
in order to allow method chaining
*/
public setMinScreenWidth(sMinScreenWidth: string): sap.m.Column;
/**
* Sets the order of the column
* Does not do the visual effect
* Table should be invalidate to re-render
* @param {number} nOrder - order of the column
*/
protected setOrder(nOrder: number): void;
/**
* Sets a new value for property {@link #getPopinDisplay popinDisplay}.
*
* Defines enumerated display options for the pop-in.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Block
.
* @param {sap.m.PopinDisplay} sPopinDisplay - New value for property popinDisplay
* @returns {sap.m.Column} Reference to this
in order to allow method chaining
*/
public setPopinDisplay(sPopinDisplay: sap.m.PopinDisplay): sap.m.Column;
/**
* Sets a new value for property {@link #getPopinHAlign popinHAlign}.
*
* Horizontal alignment of the pop-in content. Available alignment settings are "Begin", "Center", "End", "Left", and "Right".
*
* NOTE: Controls with a text align do not inherit the horizontal alignment.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Begin
.
* @param {sap.ui.core.TextAlign} sPopinHAlign - New value for property popinHAlign
* @returns {sap.m.Column} Reference to this
in order to allow method chaining
*/
public setPopinHAlign(sPopinHAlign: sap.ui.core.TextAlign): sap.m.Column;
/**
* Sets a new value for property {@link #getStyleClass styleClass}.
*
* CSS class name for column contents(header, cells and footer of column). This property can be used for different column styling. If column is shown as pop-in then this class name is applied to related pop-in row.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sStyleClass - New value for property styleClass
* @returns {sap.m.Column} Reference to this
in order to allow method chaining
*/
public setStyleClass(sStyleClass: string): sap.m.Column;
/**
* Sets a new value for property {@link #getVAlign vAlign}.
*
* Vertical alignment of the cells in a column. Possible values are "Inherit", "Top", "Middle", "Bottom"
* This property does not affect the vertical alignment of header and footer.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.VerticalAlign} sVAlign - New value for property vAlign
* @returns {sap.m.Column} Reference to this
in order to allow method chaining
*/
public setVAlign(sVAlign: sap.ui.core.VerticalAlign): sap.m.Column;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Specifies whether or not the column is visible. Invisible columns are not rendered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.Column} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.Column;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the column. If you leave it empty then this column covers the remaining space.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.Column} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.Column;
}
/**
* sap.m.ColumnListItem
can be used with the cells
aggregation to create rows for the sap.m.Table
control.
* The columns
aggregation of the sap.m.Table
should match with the cells aggregation.
*
* Note: This control should only be used within the sap.m.Table
control.
* The inherited counter
property of sap.m.ListItemBase
is not supported.
*/
export class ColumnListItem extends sap.m.ListItemBase {
/**
* Constructor for a new ColumnListItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Returns pop-in DOMRef as a jQuery Object
*/
protected $Popin(): void;
/**
* Adds some cell to the aggregation {@link #getCells cells}.
* @param {sap.ui.core.Control} oCell - the cell to add; if empty, nothing is inserted
* @returns {sap.m.ColumnListItem} Reference to this
in order to allow method chaining
*/
public addCell(oCell: sap.ui.core.Control): sap.m.ColumnListItem;
/**
* Binds aggregation {@link #getCells cells} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.ColumnListItem} Reference to this
in order to allow method chaining
*/
public bindCells(oBindingInfo: any): sap.m.ColumnListItem;
/**
* Destroys all the cells in the aggregation {@link #getCells cells}.
* @returns {sap.m.ColumnListItem} Reference to this
in order to allow method chaining
*/
public destroyCells(): sap.m.ColumnListItem;
/**
* Creates a new subclass of class sap.m.ColumnListItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ListItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getCells cells}.
*
* Every control
inside the cells
aggregation defines one cell of the row.
* Note: The order of the cells
aggregation must match the order of the columns
aggregation of sap.m.Table
.
* @returns {sap.ui.core.Control[]}
*/
public getCells(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.m.ColumnListItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the pop-in element.
* @returns {any}
*/
protected getPopin(): any;
/**
* Returns the tabbable DOM elements as a jQuery collection
* When popin is available this separated dom should also be included
* @returns {JQuery} jQuery object
*/
protected getTabbables(): JQuery;
/**
* Gets current value of property {@link #getVAlign vAlign}.
*
* Sets the vertical alignment of all the cells within the table row (including selection and navigation).
* Note: vAlign
property of sap.m.Column
overrides the property for cell vertical alignment if both are set.
*
* Default value is Inherit
.
* @returns {sap.ui.core.VerticalAlign} Value of property vAlign
*/
public getVAlign(): sap.ui.core.VerticalAlign;
/**
* Determines whether control has pop-in or not.
*/
protected hasPopin(): void;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getCells cells}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oCell - The cell whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfCell(oCell: sap.ui.core.Control): number;
/**
* Inserts a cell into the aggregation {@link #getCells cells}.
* @param {sap.ui.core.Control} oCell - the cell to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the cell should be inserted at; for a negative value of iIndex
, the cell is inserted at position 0; for a value greater than the current size of the aggregation, the cell is inserted at the last position
* @returns {sap.m.ColumnListItem} Reference to this
in order to allow method chaining
*/
public insertCell(oCell: sap.ui.core.Control, iIndex: number): sap.m.ColumnListItem;
/**
* Removes all the controls from the aggregation {@link #getCells cells}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllCells(): sap.ui.core.Control[];
/**
* Removes a cell from the aggregation {@link #getCells cells}.
* @param {number|string|sap.ui.core.Control} vCell - The cell to remove or its index or id
* @returns {sap.ui.core.Control} The removed cell or null
*/
public removeCell(vCell: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Pemove pop-in from DOM
*/
protected removePopin(): void;
/**
* Sets a new value for property {@link #getVAlign vAlign}.
*
* Sets the vertical alignment of all the cells within the table row (including selection and navigation).
* Note: vAlign
property of sap.m.Column
overrides the property for cell vertical alignment if both are set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.VerticalAlign} sVAlign - New value for property vAlign
* @returns {sap.m.ColumnListItem} Reference to this
in order to allow method chaining
*/
public setVAlign(sVAlign: sap.ui.core.VerticalAlign): sap.m.ColumnListItem;
/**
* Unbinds aggregation {@link #getCells cells} from model data.
* @returns {sap.m.ColumnListItem} Reference to this
in order to allow method chaining
*/
public unbindCells(): sap.m.ColumnListItem;
}
/**
* A drop-down list for selecting and filtering values.
* showSecondaryValues
property, the combo box can display an additional value for each option (if there is one). Filtering is done only on the first option.
* mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.ComboBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ComboBox
itself.
*
* This event is fired when the value in the text input field is changed in combination with one of
* the following actions:
*
* sap.m.ComboBox
itself
* @returns {sap.m.ComboBox} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.m.ComboBox;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.ComboBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ComboBox
itself.
*
* This event is fired when the value in the text input field is changed in combination with one of
* the following actions:
*
* sap.m.ComboBox
itself
* @returns {sap.m.ComboBox} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.m.ComboBox;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChange selectionChange} event of this sap.m.ComboBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ComboBox
itself.
*
* This event is fired when the user types something that matches with an item in the list;
* it is also fired when the user presses on a list item, or when navigating via keyboard.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ComboBox
itself
* @returns {sap.m.ComboBox} Reference to this
in order to allow method chaining
*/
public attachSelectionChange(fnFunction: Function, oListener?: any): sap.m.ComboBox;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChange selectionChange} event of this sap.m.ComboBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ComboBox
itself.
*
* This event is fired when the user types something that matches with an item in the list;
* it is also fired when the user presses on a list item, or when navigating via keyboard.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ComboBox
itself
* @returns {sap.m.ComboBox} Reference to this
in order to allow method chaining
*/
public attachSelectionChange(oData: any, fnFunction: Function, oListener?: any): sap.m.ComboBox;
/**
* Creates a picker popup container where the selection should take place.
*
* To be overwritten by subclasses.
* @param {string} sPickerType
* @returns {sap.m.Popover|sap.m.Dialog} The picker popup to be used.
*/
protected createPicker(sPickerType: string): sap.m.Popover|sap.m.Dialog;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.m.ComboBox
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ComboBox} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.m.ComboBox;
/**
* Detaches event handler fnFunction
from the {@link #event:selectionChange selectionChange} event of this sap.m.ComboBox
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ComboBox} Reference to this
in order to allow method chaining
*/
public detachSelectionChange(fnFunction: Function, oListener: any): sap.m.ComboBox;
/**
* Creates a new subclass of class sap.m.ComboBox with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ComboBoxBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ComboBox} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.m.ComboBox;
/**
* Fires event {@link #event:selectionChange selectionChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ComboBox} Reference to this
in order to allow method chaining
*/
protected fireSelectionChange(mParameters?: any): sap.m.ComboBox;
/**
* Gets the default selected item from the aggregation named items
.
* @returns {null}
*/
protected getDefaultSelectedItem(): null;
/**
* Gets current value of property {@link #getFilterSecondaryValues filterSecondaryValues}.
*
* Indicates whether the filter should check in both the text
and the additionalText
property of the
* {@link sap.ui.core.ListItem} for the suggestion.
*
* Default value is false
.
* @returns {boolean} Value of property filterSecondaryValues
*/
public getFilterSecondaryValues(): boolean;
/**
* Gets aggregation items
.
*
* Note: This is the default aggregation.
* @returns {sap.ui.core.Item[]}
*/
public getItems(): sap.ui.core.Item[];
/**
* Returns a metadata object for class sap.m.ComboBox.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets the selected item object from the aggregation named items
.
* @returns {sap.ui.core.Item|null} The current target of the selectedItem
association, or null
.
*/
public getSelectedItem(): sap.ui.core.Item|null;
/**
* Gets current value of property {@link #getSelectedItemId selectedItemId}.
*
* ID of the selected item.
*
* Default value is
.
* @returns {string} Value of property selectedItemId
*/
public getSelectedItemId(): string;
/**
* Gets current value of property {@link #getSelectedKey selectedKey}.
*
* Key of the selected item.
*
* Note: If duplicate keys exist, the first item matching the key is used.
*
* Default value is
.
* @returns {string} Value of property selectedKey
*/
public getSelectedKey(): string;
/**
* Gets current value of property {@link #getShowSecondaryValues showSecondaryValues}.
*
* Indicates whether the text values of the additionalText
property of a
* {@link sap.ui.core.ListItem} are shown.
*
* Default value is false
.
* @returns {boolean} Value of property showSecondaryValues
*/
public getShowSecondaryValues(): boolean;
/**
* This event handler is called before the picker popup is opened.
*/
protected onBeforeOpen(): void;
/**
* Removes an item from the aggregation named items
.
* @param {number|string|sap.ui.core.Item} vItem - The item to be removed or its index or ID.
* @returns {sap.ui.core.Item} The removed item or null
.
*/
public removeItem(vItem: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Sets the start and end positions of the current text selection.
* @param {number} iSelectionStart - The index of the first selected character.
* @param {number} iSelectionEnd - The index of the character after the last selected character.
* @returns {sap.m.ComboBox}
*/
protected selectText(iSelectionStart: number, iSelectionEnd: number): sap.m.ComboBox;
/**
* Sets a new value for property {@link #getFilterSecondaryValues filterSecondaryValues}.
*
* Indicates whether the filter should check in both the text
and the additionalText
property of the
* {@link sap.ui.core.ListItem} for the suggestion.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bFilterSecondaryValues - New value for property filterSecondaryValues
* @returns {sap.m.ComboBox} Reference to this
in order to allow method chaining
*/
public setFilterSecondaryValues(bFilterSecondaryValues: boolean): sap.m.ComboBox;
/**
* Sets the selectedItem
association.
*
* Default value is null
.
* @param {string|sap.ui.core.Item|null} vItem - New value for the selectedItem
association. If an ID of a sap.ui.core.Item
is given, the item with this ID becomes the selectedItem
association. Alternatively, a sap.ui.core.Item
instance may be given or null
to clear the selection.
* @returns {sap.m.ComboBox} this
to allow method chaining.
*/
public setSelectedItem(vItem: string|sap.ui.core.Item|null): sap.m.ComboBox;
/**
* Sets the selectedItemId
property.
*
* Default value is an empty string ""
or undefined
.
* @param {string|any} vItem - New value for property selectedItemId
. If the provided vItem
is an empty string ""
or undefined
, the selection is cleared. If the ID has no corresponding aggregated item, the selected item is not changed.
* @returns {sap.m.ComboBox} this
to allow method chaining.
*/
public setSelectedItemId(vItem: string|any): sap.m.ComboBox;
/**
* Sets the selectedKey
property.
*
* Default value is an empty string ""
or undefined
.
* @param {string} sKey - New value for property selectedKey
. If the provided sKey
is an empty string ""
or undefined
, the selection is cleared. If duplicate keys exist, the first item matching the key is selected.
* @returns {sap.m.ComboBox} this
to allow method chaining.
*/
public setSelectedKey(sKey: string): sap.m.ComboBox;
/**
* Sets a new value for property {@link #getShowSecondaryValues showSecondaryValues}.
*
* Indicates whether the text values of the additionalText
property of a
* {@link sap.ui.core.ListItem} are shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowSecondaryValues - New value for property showSecondaryValues
* @returns {sap.m.ComboBox} Reference to this
in order to allow method chaining
*/
public setShowSecondaryValues(bShowSecondaryValues: boolean): sap.m.ComboBox;
/**
* Synchronizes the selectedItem
association and the selectedItemId
property.
*/
protected synchronizeSelection(): void;
}
/**
* An abstract class for combo boxes.
*/
export class ComboBoxBase extends sap.m.ComboBoxTextField {
/**
* Constructor for a new sap.m.ComboBoxBase
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given.
* @param {any} mSettings - Initial settings for the new control.
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds an item to the aggregation named items
.
* @param {sap.ui.core.Item} oItem - The item to be added; if empty, nothing is added.
* @returns {sap.m.ComboBoxBase} this
to allow method chaining.
*/
public addItem(oItem: sap.ui.core.Item): sap.m.ComboBoxBase;
/**
* Attaches event handler fnFunction
to the {@link #event:loadItems loadItems} event of this sap.m.ComboBoxBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ComboBoxBase
itself.
*
* This event is fired when the end user clicks the combo box button to open the dropdown list and
* the data used to display items is not already loaded.
* Alternatively, it is fired after the user moves the cursor to the combo box text
* field and perform an action that requires data to be loaded. For example,
* pressing F4 to open the dropdown list or typing something in the text field fires the event.
*
* Note: Use this feature in performance critical scenarios only.
* Loading the data lazily (on demand) to defer initialization has several implications for the
* end user experience. For example, the busy indicator has to be shown while the items are being
* loaded and assistive technology software also has to announce the state changes
* (which may be confusing for some screen reader users).
*
* Note: Currently the sap.m.MultiComboBox
does not support this event.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ComboBoxBase
itself
* @returns {sap.m.ComboBoxBase} Reference to this
in order to allow method chaining
*/
public attachLoadItems(fnFunction: Function, oListener?: any): sap.m.ComboBoxBase;
/**
* Attaches event handler fnFunction
to the {@link #event:loadItems loadItems} event of this sap.m.ComboBoxBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ComboBoxBase
itself.
*
* This event is fired when the end user clicks the combo box button to open the dropdown list and
* the data used to display items is not already loaded.
* Alternatively, it is fired after the user moves the cursor to the combo box text
* field and perform an action that requires data to be loaded. For example,
* pressing F4 to open the dropdown list or typing something in the text field fires the event.
*
* Note: Use this feature in performance critical scenarios only.
* Loading the data lazily (on demand) to defer initialization has several implications for the
* end user experience. For example, the busy indicator has to be shown while the items are being
* loaded and assistive technology software also has to announce the state changes
* (which may be confusing for some screen reader users).
*
* Note: Currently the sap.m.MultiComboBox
does not support this event.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ComboBoxBase
itself
* @returns {sap.m.ComboBoxBase} Reference to this
in order to allow method chaining
*/
public attachLoadItems(oData: any, fnFunction: Function, oListener?: any): sap.m.ComboBoxBase;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.ComboBoxBase} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.m.ComboBoxBase;
/**
* Clears the selection.
* To be overwritten by subclasses.
*/
protected clearSelection(): void;
/**
* Closes the control's picker popup.
* @returns {sap.m.ComboBoxBase} this
to allow method chaining.
*/
public close(): sap.m.ComboBoxBase;
/**
* Creates a picker popup container where the selection should take place.
* To be overwritten by subclasses.
* @param {string} sPickerType
* @returns {sap.m.Popover|sap.m.Dialog} The picker popup to be used.
*/
protected createPicker(sPickerType: string): sap.m.Popover|sap.m.Dialog;
/**
* Creates an instance of sap.m.Bar
.
* @returns {sap.m.Bar} Picker's header
*/
protected createPickerHeader(): sap.m.Bar;
/**
* Destroys all the items in the aggregation named items
.
* @returns {sap.m.ComboBox} this
to allow method chaining.
*/
public destroyItems(): sap.m.ComboBox;
/**
* Detaches event handler fnFunction
from the {@link #event:loadItems loadItems} event of this sap.m.ComboBoxBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ComboBoxBase} Reference to this
in order to allow method chaining
*/
public detachLoadItems(fnFunction: Function, oListener: any): sap.m.ComboBoxBase;
/**
* Creates a new subclass of class sap.m.ComboBoxBase with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ComboBoxTextField.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:loadItems loadItems} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ComboBoxBase} Reference to this
in order to allow method chaining
*/
protected fireLoadItems(mParameters?: any): sap.m.ComboBoxBase;
/**
* Gets the enabled items from the aggregation named items
.
* @param {sap.ui.core.Item[]} aItems - Items to filter.
* @returns {sap.ui.core.Item[]} An array containing the enabled items.
*/
public getEnabledItems(aItems?: sap.ui.core.Item[]): sap.ui.core.Item[];
/**
* Gets the first item from the aggregation named items
.
* @returns {sap.ui.core.Item} The first item, or null if there are no items.
*/
public getFirstItem(): sap.ui.core.Item;
/**
* Gets the item from the aggregation named items
at the given 0-based index.
* @param {number} iIndex - Index of the item to return.
* @returns {sap.ui.core.Item} Item at the given index, or null if none.
*/
public getItemAt(iIndex: number): sap.ui.core.Item;
/**
* Gets the item with the given key from the aggregation named items
.
*
* Note: If duplicate keys exist, the first item matching the key is returned.
* @param {string} sKey - An item key that specifies the item to retrieve.
* @returns {sap.ui.core.Item}
*/
public getItemByKey(sKey: string): sap.ui.core.Item;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Defines the items contained within this control.
* @returns {sap.ui.core.Item[]}
*/
public getItems(): sap.ui.core.Item[];
/**
* Gets the last item from the aggregation named items
.
* @returns {sap.ui.core.Item} The last item, or null if there are no items.
*/
public getLastItem(): sap.ui.core.Item;
/**
* Gets the list
.
* @returns {sap.m.SelectList} The list instance object or null
.
*/
protected getList(): sap.m.SelectList;
/**
* Returns a metadata object for class sap.m.ComboBoxBase.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets the control's picker popup.
* @returns {sap.m.Dialog|sap.m.Popover|null} The picker instance, creating it if necessary by calling the createPicker()
method.
*/
protected getPicker(): sap.m.Dialog|sap.m.Popover|null;
/**
* Gets the ID of the hidden label
* @returns {string} Id of hidden text
*/
protected getPickerInvisibleTextId(): string;
/**
* Gets the control's input from the picker.
* @returns {sap.m.ComboBoxTextField|sap.m.Input|null} Picker's input for filtering the list
*/
protected getPickerTextField(): sap.m.ComboBoxTextField|sap.m.Input|null;
/**
* Gets the property _sPickerType
* @returns {string}
*/
protected getPickerType(): string;
/**
* Checks for the provided sap.ui.core.Item
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Item} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.core.Item): number;
/**
* Inserts an item into the aggregation named items
.
* @param {sap.ui.core.Item} oItem - The item to be inserted; if empty, nothing is inserted.
* @param {number} iIndex - The 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position.
* @returns {sap.m.ComboBoxBase} this
to allow method chaining.
*/
public insertItem(oItem: sap.ui.core.Item, iIndex: number): sap.m.ComboBoxBase;
/**
* Indicates whether the control's picker popup is open.
* @returns {boolean} Determines whether the control's picker popup is currently open (this includes opening and closing animations).
*/
public isOpen(): boolean;
/**
* Opens the control's picker popup.
* @returns {sap.m.ComboBoxBase} this
to allow method chaining.
*/
protected open(): sap.m.ComboBoxBase;
/**
* Removes all the controls in the aggregation named items
.
* Additionally unregisters them from the hosting UIArea and clears the selection.
* @returns {sap.ui.core.Item[]} An array of the removed items (might be empty).
*/
public removeAllItems(): sap.ui.core.Item[];
/**
* Removes an item from the aggregation named items
.
* @param {number|string|sap.ui.core.Item} vItem - The item to remove or its index or ID.
* @returns {sap.ui.core.Item} The removed item or null.
*/
public removeItem(vItem: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Sets the property _sPickerType
.
* @param {string} sPickerType
*/
protected setPickerType(sPickerType: string): void;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.m.ComboBoxBase} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.m.ComboBoxBase;
}
/**
* The sap.m.ComboBoxTextField
.
*/
export class ComboBoxTextField extends sap.m.InputBase {
/**
* Constructor for a new sap.m.ComboBoxTextField
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given.
* @param {any} mSettings - Initial settings for the new control.
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.ComboBoxTextField with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.InputBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getMaxWidth maxWidth}.
*
* Sets the maximum width of the text field.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property maxWidth
*/
public getMaxWidth(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.m.ComboBoxTextField.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowButton showButton}.
*
* Indicates whether the dropdown downward-facing arrow button is shown.
*
* Default value is true
.
* @returns {boolean} Value of property showButton
*/
public getShowButton(): boolean;
/**
* Gets the value
.
*
* Default value is an empty string.
* @returns {string} The value of property value
*/
public getValue(): string;
/**
* Sets a new value for property {@link #getMaxWidth maxWidth}.
*
* Sets the maximum width of the text field.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sMaxWidth - New value for property maxWidth
* @returns {sap.m.ComboBoxTextField} Reference to this
in order to allow method chaining
*/
public setMaxWidth(sMaxWidth: sap.ui.core.CSSSize): sap.m.ComboBoxTextField;
/**
* Sets a new value for property {@link #getShowButton showButton}.
*
* Indicates whether the dropdown downward-facing arrow button is shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowButton - New value for property showButton
* @returns {sap.m.ComboBoxTextField} Reference to this
in order to allow method chaining
*/
public setShowButton(bShowButton: boolean): sap.m.ComboBoxTextField;
}
/**
* This control with a content aggregation can be used to customize standard list items that we don't provide. List mode and ListItem type are applied to CustomListItems as well.
* Note: Even though the content aggregation allows any control, complex responsive layout controls (e.g. Table, Form
) should not be aggregated as content.
*/
export class CustomListItem extends sap.m.ListItemBase {
/**
* Constructor for a new CustomListItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.CustomListItem} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.CustomListItem;
/**
* Binds aggregation {@link #getContent content} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.CustomListItem} Reference to this
in order to allow method chaining
*/
public bindContent(oBindingInfo: any): sap.m.CustomListItem;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.CustomListItem} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.CustomListItem;
/**
* Creates a new subclass of class sap.m.CustomListItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ListItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content of this list item
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.m.CustomListItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.CustomListItem} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.CustomListItem;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Unbinds aggregation {@link #getContent content} from model data.
* @returns {sap.m.CustomListItem} Reference to this
in order to allow method chaining
*/
public unbindContent(): sap.m.CustomListItem;
}
/**
* Use the CustomTile control to display application specific content in the Tile control.
* The tile width is 8.5em and height is 10em.
*/
export class CustomTile extends sap.m.Tile {
/**
* Constructor for a new CustomTile.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Destroys the content in the aggregation {@link #getContent content}.
* @returns {sap.m.CustomTile} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.CustomTile;
/**
* Creates a new subclass of class sap.m.CustomTile with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.Tile.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Defines the content of the CustomTile.
* @returns {sap.ui.core.Control}
*/
public getContent(): sap.ui.core.Control;
/**
* Returns a metadata object for class sap.m.CustomTile.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets the aggregated {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - The content to set
* @returns {sap.m.CustomTile} Reference to this
in order to allow method chaining
*/
public setContent(oContent: sap.ui.core.Control): sap.m.CustomTile;
}
/**
* The CustomTreeItem
control with a content aggregation is used to customize the tree items within the Tree
* control.Table, Form
etc, should not be aggregated as content.
*/
export class CustomTreeItem extends sap.m.TreeItemBase {
/**
* Constructor for a new CustomTreeItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.CustomTreeItem} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.CustomTreeItem;
/**
* Binds aggregation {@link #getContent content} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.CustomTreeItem} Reference to this
in order to allow method chaining
*/
public bindContent(oBindingInfo: any): sap.m.CustomTreeItem;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.CustomTreeItem} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.CustomTreeItem;
/**
* Creates a new subclass of class sap.m.CustomTreeItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.TreeItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content of this tree item.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.m.CustomTreeItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.CustomTreeItem} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.CustomTreeItem;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Unbinds aggregation {@link #getContent content} from model data.
* @returns {sap.m.CustomTreeItem} Reference to this
in order to allow method chaining
*/
public unbindContent(): sap.m.CustomTreeItem;
}
/**
* Enables the users to select a localized date.
*
* DatePicker
lets the users select a localized date using touch,
* mouse, or keyboard input. It consists of two parts: the date input field and the
* date picker.
*
* Note: The {@link sap.ui.unified.Calendar} is used internally only if the
* DatePicker
is opened (not used for the initial rendering). If the
* sap.ui.unified
library is not loaded before the
* DatePicker
is opened, it will be loaded upon opening. This could
* lead to a waiting time when the DatePicker
is opened for the
* first time. To prevent this, apps using the DatePicker
should also
* load the sap.ui.unified
library.
*
* DatePicker
- as a string to the value
property or as
* a JavaScript Date object to the dateValue
property (only one of
* these properties should be used at a time):
*
* value
property if you want to bind the
* DatePicker
to a model using the sap.ui.model.type.Date
value
property if the date is provided as a string from
* the backend or inside the app (for example, as ABAP type DATS field)dateValue
property if the date is already provided as a
* JavaScript Date object or you want to work with a JavaScript Date objectvalueFormat
is "yyyy-MM-dd",
* the displayFormat
is "MMM d, y", and the used locale is English, a
* valid value string is "2015-07-30", which leads to an output of "Jul 30, 2015".
*
* If no placeholder is set to the DatePicker
, the used
* displayFormat
is displayed as a placeholder. If another placeholder
* is needed, it must be set.
*
* Note: If the string does NOT match the displayFormat
* (from user input) or the valueFormat
(on app level), the
* {@link sap.ui.core.format.DateFormat} makes an attempt to parse it based on the
* locale settings. For more information, see the respective documentation in the
* API Reference.
*
* DatePicker
is smaller in compact mode and provides a
* touch-friendly size in cozy mode.
*
* On mobile devices, one tap on the input field opens the DatePicker
* in full screen. To close the window, the user can select a date (which triggers
* the close event), or select Cancel.
*/
export class DatePicker extends sap.m.InputBase {
/**
* Constructor for a new DatePicker
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some specialDate
to the aggregation specialDates
.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to add; if empty, nothing is added
* @returns {sap.m.DatePicker} Reference to this
in order to allow method chaining
*/
public addSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): sap.m.DatePicker;
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.m.DatePicker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.DatePicker
itself.
*
* Fired when navigating in Calendar
popup.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.DatePicker
itself
* @returns {sap.m.DatePicker} Reference to this
in order to allow method chaining
*/
public attachNavigate(fnFunction: Function, oListener?: any): sap.m.DatePicker;
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.m.DatePicker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.DatePicker
itself.
*
* Fired when navigating in Calendar
popup.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.DatePicker
itself
* @returns {sap.m.DatePicker} Reference to this
in order to allow method chaining
*/
public attachNavigate(oData: any, fnFunction: Function, oListener?: any): sap.m.DatePicker;
/**
* Destroys all the specialDates in the aggregation {@link #getSpecialDates specialDates}.
* @returns {sap.m.DatePicker} Reference to this
in order to allow method chaining
*/
public destroySpecialDates(): sap.m.DatePicker;
/**
* Detaches event handler fnFunction
from the {@link #event:navigate navigate} event of this sap.m.DatePicker
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.DatePicker} Reference to this
in order to allow method chaining
*/
public detachNavigate(fnFunction: Function, oListener: any): sap.m.DatePicker;
/**
* Creates a new subclass of class sap.m.DatePicker with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.InputBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event change to attached listeners.
*
* Expects following event parameters:
* string
The new value of the sap.m.DatePicker
.boolean
Indicator for a valid date.this
to allow method chaining
*/
protected fireChange(mArguments?: { [key: string]: any }): sap.m.DatePicker;
/**
* Fires event {@link #event:navigate navigate} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.DatePicker} Reference to this
in order to allow method chaining
*/
protected fireNavigate(mParameters?: any): sap.m.DatePicker;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getDateValue dateValue}.
*
* The date as JavaScript Date object. This is independent from any formatter.
*
* Note: If this property is used, the value
property should not be changed from the caller.
* @returns {any} Value of property dateValue
*/
public getDateValue(): any;
/**
* Gets current value of property {@link #getDisplayFormat displayFormat}.
*
* The date is displayed in the input field using this format. By default, the medium format of the used locale is used.
*
* Supported format options are pattern-based on Unicode LDML Date Format notation. {@link http://unicode.org/reports/tr35/#Date_Field_Symbol_Table}
* Note: If you use data binding on the value
property with type sap.ui.model.type.Date
this property will be ignored.
* The format defined in the binding will be used.
* @returns {string} Value of property displayFormat
*/
public getDisplayFormat(): string;
/**
* Gets current value of property {@link #getDisplayFormatType displayFormatType}.
*
* Displays date in this given type in input field. Default value is taken from locale settings.
* Accepted are values of sap.ui.core.CalendarType
or an empty string. If no type is set, the default type of the
* configuration is used.
* Note: If data binding on value
property with type sap.ui.model.type.Date
is used, this property will be ignored.
*
* Default value is
.
* @returns {string} Value of property displayFormatType
*/
public getDisplayFormatType(): string;
/**
* ID of the element which is the current target of the association {@link #getLegend legend}, or null
.
* @returns {sap.ui.core.ID}
*/
public getLegend(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getMaxDate maxDate}.
*
* Maximum date that can be shown and selected in the DatePicker
. This must be a JavaScript date object.
*
* Note: If the maxDate
is set to be before the minDate
,
* the maxDate
and the minDate
are switched before rendering.
* @returns {any} Value of property maxDate
*/
public getMaxDate(): any;
/**
* Returns a metadata object for class sap.m.DatePicker.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinDate minDate}.
*
* Minimum date that can be shown and selected in the DatePicker
. This must be a JavaScript date object.
*
* Note: If the minDate
is set to be after the maxDate
,
* the maxDate
and the minDate
are switched before rendering.
* @returns {any} Value of property minDate
*/
public getMinDate(): any;
/**
* Gets current value of property {@link #getSecondaryCalendarType secondaryCalendarType}.
*
* If set, the days in the calendar popup are also displayed in this calendar type
* If not set, the dates are only displayed in the primary calendar type
* @returns {sap.ui.core.CalendarType} Value of property secondaryCalendarType
*/
public getSecondaryCalendarType(): sap.ui.core.CalendarType;
/**
* Gets content of aggregation {@link #getSpecialDates specialDates}.
*
* Date Range with type to visualize special days in the Calendar.
* If one day is assigned to more than one Type, only the first one will be used.
*
* To set a single date (instead of a range), set only the startDate property of the sap.ui.unified.DateRange class.
*
* Note: Since 1.48 you could set a non-working day via the sap.ui.unified.CalendarDayType.NonWorking
* enum type just as any other special date type using sap.ui.unified.DateRangeType.
* @returns {sap.ui.core.Element[]}
*/
public getSpecialDates(): sap.ui.core.Element[];
/**
* Getter for property value
.
*
* Returns a date as a string in the format defined in property valueFormat
.
*
* Note: The value is always expected and updated in Gregorian calendar format. (If data binding is used the format of the binding is used.)
*
* If this property is used, the dateValue
property should not be changed from the caller.
* @returns {string} the value of property value
*/
public getValue(): string;
/**
* Gets current value of property {@link #getValueFormat valueFormat}.
*
* The date string expected and returned in the value
property uses this format. By default the short format of the used locale is used.
*
*
* Supported format options are pattern-based on Unicode LDML Date Format notation. {@link http://unicode.org/reports/tr35/#Date_Field_Symbol_Table}
*
* For example, if the date string represents an ABAP DATS type, the format should be "yyyyMMdd".
*
* Note: If data binding on value
property with type sap.ui.model.type.Date
is used, this property will be ignored.
* The format defined in the binding will be used.
* @returns {string} Value of property valueFormat
*/
public getValueFormat(): string;
/**
* Checks for the provided sap.ui.core.Element
in the aggregation {@link #getSpecialDates specialDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Element} oSpecialDate - The specialDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSpecialDate(oSpecialDate: sap.ui.core.Element): number;
/**
* Inserts a specialDate
to the aggregation specialDates
.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0-based index the specialDate
should be inserted at; for a negative value of iIndex
, the specialDate
is inserted at position 0; for a value greater than the current size of the aggregation, the specialDate
is inserted at the last position
* @returns {sap.m.DatePicker} Reference to this
in order to allow method chaining
*/
public insertSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange, iIndex: number): sap.m.DatePicker;
/**
* Removes all the controls from the aggregation {@link #getSpecialDates specialDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Element[]} An array of the removed elements (might be empty)
*/
public removeAllSpecialDates(): sap.ui.core.Element[];
/**
* Removes a specialDate
from the aggregation specialDates
.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - The specialDate
to remove or its index or id
* @returns {sap.ui.unified.DateTypeRange} The removed specialDate
or null
*/
public removeSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): sap.ui.unified.DateTypeRange;
/**
* Sets a new value for property {@link #getDateValue dateValue}.
*
* The date as JavaScript Date object. This is independent from any formatter.
*
* Note: If this property is used, the value
property should not be changed from the caller.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oDateValue - New value for property dateValue
* @returns {sap.m.DatePicker} Reference to this
in order to allow method chaining
*/
public setDateValue(oDateValue: any): sap.m.DatePicker;
/**
* Sets a new value for property {@link #getDisplayFormat displayFormat}.
*
* The date is displayed in the input field using this format. By default, the medium format of the used locale is used.
*
* Supported format options are pattern-based on Unicode LDML Date Format notation. {@link http://unicode.org/reports/tr35/#Date_Field_Symbol_Table}
* Note: If you use data binding on the value
property with type sap.ui.model.type.Date
this property will be ignored.
* The format defined in the binding will be used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sDisplayFormat - New value for property displayFormat
* @returns {sap.m.DatePicker} Reference to this
in order to allow method chaining
*/
public setDisplayFormat(sDisplayFormat: string): sap.m.DatePicker;
/**
* Sets a new value for property {@link #getDisplayFormatType displayFormatType}.
*
* Displays date in this given type in input field. Default value is taken from locale settings.
* Accepted are values of sap.ui.core.CalendarType
or an empty string. If no type is set, the default type of the
* configuration is used.
* Note: If data binding on value
property with type sap.ui.model.type.Date
is used, this property will be ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sDisplayFormatType - New value for property displayFormatType
* @returns {sap.m.DatePicker} Reference to this
in order to allow method chaining
*/
public setDisplayFormatType(sDisplayFormatType: string): sap.m.DatePicker;
/**
* Sets the associated legend.
* @param {sap.ui.core.ID|sap.ui.unified.CalendarLegend} oLegend - ID of an element which becomes the new target of this legend
association; alternatively, an element instance may be given
* @returns {sap.m.DatePicker} Reference to this
in order to allow method chaining
*/
public setLegend(oLegend: sap.ui.core.ID|sap.ui.unified.CalendarLegend): sap.m.DatePicker;
/**
* Sets a new value for property {@link #getMaxDate maxDate}.
*
* Maximum date that can be shown and selected in the DatePicker
. This must be a JavaScript date object.
*
* Note: If the maxDate
is set to be before the minDate
,
* the maxDate
and the minDate
are switched before rendering.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oMaxDate - New value for property maxDate
* @returns {sap.m.DatePicker} Reference to this
in order to allow method chaining
*/
public setMaxDate(oMaxDate: any): sap.m.DatePicker;
/**
* Sets a new value for property {@link #getMinDate minDate}.
*
* Minimum date that can be shown and selected in the DatePicker
. This must be a JavaScript date object.
*
* Note: If the minDate
is set to be after the maxDate
,
* the maxDate
and the minDate
are switched before rendering.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oMinDate - New value for property minDate
* @returns {sap.m.DatePicker} Reference to this
in order to allow method chaining
*/
public setMinDate(oMinDate: any): sap.m.DatePicker;
/**
* Sets a new value for property {@link #getSecondaryCalendarType secondaryCalendarType}.
*
* If set, the days in the calendar popup are also displayed in this calendar type
* If not set, the dates are only displayed in the primary calendar type
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CalendarType} sSecondaryCalendarType - New value for property secondaryCalendarType
* @returns {sap.m.DatePicker} Reference to this
in order to allow method chaining
*/
public setSecondaryCalendarType(sSecondaryCalendarType: sap.ui.core.CalendarType): sap.m.DatePicker;
/**
* Setter for property value
.
*
* Expects a date as a string in the format defined in property valueFormat
.
*
* Note: The value is always expected and updated in Gregorian calendar format. (If data binding is used the format of the binding is used.)
*
* If this property is used, the dateValue
property should not be changed from the caller.
*
* If Data binding using a sap.ui.model.type.Date
is used, please set the formatOption
stricktParsing
to true
.
* This prevents unwanted automatic corrections of wrong input.
* @param {string} sValue - The new value of the input.
* @returns {sap.m.DatePicker} this
to allow method chaining
*/
public setValue(sValue: string): sap.m.DatePicker;
/**
* Sets a new value for property {@link #getValueFormat valueFormat}.
*
* The date string expected and returned in the value
property uses this format. By default the short format of the used locale is used.
*
*
* Supported format options are pattern-based on Unicode LDML Date Format notation. {@link http://unicode.org/reports/tr35/#Date_Field_Symbol_Table}
*
* For example, if the date string represents an ABAP DATS type, the format should be "yyyyMMdd".
*
* Note: If data binding on value
property with type sap.ui.model.type.Date
is used, this property will be ignored.
* The format defined in the binding will be used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sValueFormat - New value for property valueFormat
* @returns {sap.m.DatePicker} Reference to this
in order to allow method chaining
*/
public setValueFormat(sValueFormat: string): sap.m.DatePicker;
/**
* Defines the width of the DatePicker. Default value is 100%
* @param {string} sWidth - new value for width
* @returns {sap.m.DatePicker} this
to allow method chaining
*/
public setWidth(sWidth: string): sap.m.DatePicker;
}
/**
* A single-field input control that enables the users to enter a localized date range.
*
* DateRangeSelection
enables the users to enter a localized
* date range using touch, mouse, keyboard input, or by selecting a date range in
* the calendar. They can also navigate directly from one month or year to another.
*
* Note: The {@link sap.ui.unified.Calendar} is used internally only if the
* DateRangeSelection
is opened (not used for the initial rendering).
* If the sap.ui.unified
library is not loaded before the
* DateRangeSelection
is opened, it will be loaded upon opening.
* This could lead to a waiting time when the DateRangeSelection
is
* opened for the first time. To prevent this, apps using the
* DateRangeSelection
should also load the sap.ui.unified
* library.
*
* DateRangeSelection
- date range as a string to the
* value
property or JavaScript Date objects to the
* dateValue
and secondDateValue
properties (only one of
* these options should be used at a time):
*
* value
property if the date range is already provided as
* a formatted stringdateValue
and secondDateValue
properties
* if the date range is already provided as JavaScript Date objects or you want to
* work with JavaScript Date objectsdisplayFormat
is "MMM d, y", delimiter is "-",
* and the used locale is English, a valid value string is "Jul 29, 2015 - Jul 31,
* 2015" and it is displayed in the same way in the input field.
*
* If no placeholder is set to the DateRangeSelection
, the used
* displayFormat
is displayed as a placeholder. If another placeholder
* is needed, it must be set.
*
* Note: If the string does NOT match the displayFormat
* (from user input) or the valueFormat
(on app level), the
* {@link sap.ui.core.format.DateFormat} makes an attempt to parse it based on the
* locale settings. For more information, see the respective documentation in the
* API Reference.
*
* DateRangeSelection
is fully responsive. It is smaller in
* compact mode and provides a touch-friendly size in cozy mode.
*/
export class DateRangeSelection extends sap.m.DatePicker {
/**
* Constructor for a new DateRangeSelection
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.DateRangeSelection with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.DatePicker.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event change to attached listeners.
*
* Expects following event parameters:
* string
The new value of the sap.m.DateRangeSelection
.boolean
Indicator for a valid date.object
Current start date after change.object
Current end date after change.this
to allow method chaining
*/
protected fireChange(mArguments?: { [key: string]: any }): sap.m.DateRangeSelection;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Getter for property dateValue
.
*
* The start date of the range as JavaScript Date object. This is independent from any formatter.
*
* Note: If this property is used, the value
property should not be changed from the caller.
* @returns {any} the value of property dateValue
*/
public getDateValue(): any;
/**
* Gets current value of property {@link #getDelimiter delimiter}.
*
* Delimiter between start and end date. Default value is "-".
* If no delimiter is given, the one defined for the used locale is used.
*
* Default value is -
.
* @returns {string} Value of property delimiter
*/
public getDelimiter(): string;
/**
* Gets current value of property {@link #getFrom from}.
*
* Start date of the range.
* @returns {any} Value of property from
*/
public getFrom(): any;
/**
* Returns a metadata object for class sap.m.DateRangeSelection.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSecondDateValue secondDateValue}.
*
* The end date of the range as JavaScript Date object. This is independent from any formatter.
*
* Note: If this property is used, the value
property should not be changed from the caller.
* @returns {any} Value of property secondDateValue
*/
public getSecondDateValue(): any;
/**
* Gets current value of property {@link #getTo to}.
*
* End date of the range.
* @returns {any} Value of property to
*/
public getTo(): any;
/**
* Getter for property value
.
*
* Returns a date as a string in the format defined in property displayFormat
.
*
* Note: As the value string always used the displayFormat
, it is both locale-dependent and calendar-type-dependent.
*
* If this property is used, the dateValue
property should not be changed from the caller.
* @returns {string} the value of property value
*/
public getValue(): string;
/**
* Getter for property valueFormat
.
*
* Note: Property valueFormat
is not supported in the sap.m.DateRangeSelection
control.
* @returns {string} the value of property valueFormat
*/
public getValueFormat(): string;
/**
* This file defines behavior for the control
*/
public init(): void;
/**
* Setter for property dateValue
.
*
* The start date of the range as JavaScript Date object. This is independent from any formatter.
*
* Note: If this property is used, the value
property should not be changed from the caller.
* @param {any} oDateValue - New value for property dateValue
* @returns {sap.m.DateRangeSelection} this
to allow method chaining.
*/
public setDateValue(oDateValue: any): sap.m.DateRangeSelection;
/**
* Sets a new value for property {@link #getDelimiter delimiter}.
*
* Delimiter between start and end date. Default value is "-".
* If no delimiter is given, the one defined for the used locale is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -
.
* @param {string} sDelimiter - New value for property delimiter
* @returns {sap.m.DateRangeSelection} Reference to this
in order to allow method chaining
*/
public setDelimiter(sDelimiter: string): sap.m.DateRangeSelection;
/**
* Sets a new value for property {@link #getFrom from}.
*
* Start date of the range.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oFrom - New value for property from
* @returns {sap.m.DateRangeSelection} Reference to this
in order to allow method chaining
*/
public setFrom(oFrom: any): sap.m.DateRangeSelection;
/**
* Sets a new value for property {@link #getSecondDateValue secondDateValue}.
*
* The end date of the range as JavaScript Date object. This is independent from any formatter.
*
* Note: If this property is used, the value
property should not be changed from the caller.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oSecondDateValue - New value for property secondDateValue
* @returns {sap.m.DateRangeSelection} Reference to this
in order to allow method chaining
*/
public setSecondDateValue(oSecondDateValue: any): sap.m.DateRangeSelection;
/**
* Sets a new value for property {@link #getTo to}.
*
* End date of the range.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oTo - New value for property to
* @returns {sap.m.DateRangeSelection} Reference to this
in order to allow method chaining
*/
public setTo(oTo: any): sap.m.DateRangeSelection;
/**
* Setter for property value
.
*
* Expects a date as a string in the format defined in property displayFormat
.
*
* Note: As the value string always used the displayFormat
, it is both locale-dependent and calendar-type-dependent.
*
* If this property is used, the dateValue
property should not be changed from the caller.
* @param {string} sValue - The new value of the input.
* @returns {sap.m.DateRangeSelection} this
to allow method chaining.
*/
public setValue(sValue: string): sap.m.DateRangeSelection;
/**
* Setter for property valueFormat
.
*
* Note: Property valueFormat
is not supported in the sap.m.DateRangeSelection
control.
* @param {string} sValueFormat - New value for property valueFormat
* @returns {sap.m.DateRangeSelection} this
to allow method chaining
*/
public setValueFormat(sValueFormat: string): sap.m.DateRangeSelection;
}
/**
* Allows end users to interact with date and/or time and select from a date and/or time pad.
*
* Note: This control should not be used any longer, instead please use the dedicated sap.m.DatePicker
, sap.m.TimePicker
or sap.m.DateTimePicker
control.
*/
export class DateTimeInput extends sap.ui.core.Control {
/**
* Constructor for a new DateTimeInput.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.DateTimeInput;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.DateTimeInput
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.DateTimeInput
itself.
*
* This event gets fired when the selection has finished and the value has changed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.DateTimeInput
itself
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.m.DateTimeInput;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.DateTimeInput
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.DateTimeInput
itself.
*
* This event gets fired when the selection has finished and the value has changed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.DateTimeInput
itself
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.m.DateTimeInput;
/**
* Binds property {@link #getValue value} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a
* detailed description of the possible properties of oBindingInfo
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public bindValue(oBindingInfo: any): sap.m.DateTimeInput;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.m.DateTimeInput
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.m.DateTimeInput;
/**
* Creates a new subclass of class sap.m.DateTimeInput with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.m.DateTimeInput;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getDateValue dateValue}.
*
* This property as JavaScript Date Object can be used to assign a new value which is independent from valueFormat.
* @returns {any} Value of property dateValue
*/
public getDateValue(): any;
/**
* Gets current value of property {@link #getDisplayFormat displayFormat}.
*
* Displays date value in this given format in text field. Default value is taken from locale settings.
* If you use data-binding on value property with type sap.ui.model.type.Date then you can ignore this property or the latter wins.
* If the user's browser supports native picker then this property is overwritten by browser with locale settings.
* @returns {string} Value of property displayFormat
*/
public getDisplayFormat(): string;
/**
* Gets current value of property {@link #getEditable editable}.
*
* Defines whether the control can be modified by the user or not.
* Note: A user can tab to non-editable control, highlight it, and copy the text from it.
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Indicates whether the user can interact with the control or not.
* Note: Disabled controls cannot be focused and they are out of the tab-chain.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Returns a metadata object for class sap.m.DateTimeInput.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* Defines the name of the control for the purposes of form submission.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets current value of property {@link #getPlaceholder placeholder}.
*
* Defines a short hint intended to aid the user with data entry when the control has no value.
* @returns {string} Value of property placeholder
*/
public getPlaceholder(): string;
/**
* Gets current value of property {@link #getShowValueStateMessage showValueStateMessage}.
*
* Indicates whether the value state message should be shown or not.
*
* Default value is true
.
* @returns {boolean} Value of property showValueStateMessage
*/
public getShowValueStateMessage(): boolean;
/**
* Gets current value of property {@link #getTextAlign textAlign}.
*
* Defines the horizontal alignment of the text that is shown inside the input field.
*
* Default value is Initial
.
* @returns {sap.ui.core.TextAlign} Value of property textAlign
*/
public getTextAlign(): sap.ui.core.TextAlign;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Defines the text directionality of the input field, e.g. RTL
, LTR
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getType type}.
*
* Type of DateTimeInput (e.g. Date, Time, DateTime)
*
* Default value is Date
.
* @returns {sap.m.DateTimeInputType} Value of property type
*/
public getType(): sap.m.DateTimeInputType;
/**
* Gets current value of property {@link #getValue value}.
*
* Defines the value of the control.
*
* The new value must be in the format set by valueFormat
.
*
* The "Now" literal can also be assigned as a parameter to show the current date and/or time.
* @returns {string} Value of property value
*/
public getValue(): string;
/**
* Gets current value of property {@link #getValueFormat valueFormat}.
*
* Given value property should match with valueFormat to parse date. Default value is taken from locale settings.
* You can only set and get value in this format.
* If you use data-binding on value property with type sap.ui.model.type.Date you can ignore this property or the latter wins.
* @returns {string} Value of property valueFormat
*/
public getValueFormat(): string;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Visualizes the validation state of the control, e.g. Error
, Warning
, Success
.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getValueStateText valueStateText}.
*
* Defines the text that appears in the value state message pop-up. If this is not specified, a default text is shown from the resource bundle.
* @returns {string} Value of property valueStateText
*/
public getValueStateText(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the control.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getDateValue dateValue}.
*
* This property as JavaScript Date Object can be used to assign a new value which is independent from valueFormat.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oDateValue - New value for property dateValue
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public setDateValue(oDateValue: any): sap.m.DateTimeInput;
/**
* Sets a new value for property {@link #getDisplayFormat displayFormat}.
*
* Displays date value in this given format in text field. Default value is taken from locale settings.
* If you use data-binding on value property with type sap.ui.model.type.Date then you can ignore this property or the latter wins.
* If the user's browser supports native picker then this property is overwritten by browser with locale settings.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sDisplayFormat - New value for property displayFormat
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public setDisplayFormat(sDisplayFormat: string): sap.m.DateTimeInput;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Defines whether the control can be modified by the user or not.
* Note: A user can tab to non-editable control, highlight it, and copy the text from it.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.m.DateTimeInput;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Indicates whether the user can interact with the control or not.
* Note: Disabled controls cannot be focused and they are out of the tab-chain.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.DateTimeInput;
/**
* Sets a new value for property {@link #getName name}.
*
* Defines the name of the control for the purposes of form submission.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.m.DateTimeInput;
/**
* Sets a new value for property {@link #getPlaceholder placeholder}.
*
* Defines a short hint intended to aid the user with data entry when the control has no value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sPlaceholder - New value for property placeholder
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public setPlaceholder(sPlaceholder: string): sap.m.DateTimeInput;
/**
* Sets a new value for property {@link #getShowValueStateMessage showValueStateMessage}.
*
* Indicates whether the value state message should be shown or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowValueStateMessage - New value for property showValueStateMessage
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public setShowValueStateMessage(bShowValueStateMessage: boolean): sap.m.DateTimeInput;
/**
* Sets a new value for property {@link #getTextAlign textAlign}.
*
* Defines the horizontal alignment of the text that is shown inside the input field.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Initial
.
* @param {sap.ui.core.TextAlign} sTextAlign - New value for property textAlign
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public setTextAlign(sTextAlign: sap.ui.core.TextAlign): sap.m.DateTimeInput;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Defines the text directionality of the input field, e.g. RTL
, LTR
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.DateTimeInput;
/**
* Sets a new value for property {@link #getType type}.
*
* Type of DateTimeInput (e.g. Date, Time, DateTime)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Date
.
* @param {sap.m.DateTimeInputType} sType - New value for property type
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.m.DateTimeInputType): sap.m.DateTimeInput;
/**
* Sets a new value for property {@link #getValue value}.
*
* Defines the value of the control.
*
* The new value must be in the format set by valueFormat
.
*
* The "Now" literal can also be assigned as a parameter to show the current date and/or time.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sValue - New value for property value
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public setValue(sValue: string): sap.m.DateTimeInput;
/**
* Sets a new value for property {@link #getValueFormat valueFormat}.
*
* Given value property should match with valueFormat to parse date. Default value is taken from locale settings.
* You can only set and get value in this format.
* If you use data-binding on value property with type sap.ui.model.type.Date you can ignore this property or the latter wins.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sValueFormat - New value for property valueFormat
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public setValueFormat(sValueFormat: string): sap.m.DateTimeInput;
/**
* Sets a new value for property {@link #getValueState valueState}.
*
* Visualizes the validation state of the control, e.g. Error
, Warning
, Success
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sValueState - New value for property valueState
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public setValueState(sValueState: sap.ui.core.ValueState): sap.m.DateTimeInput;
/**
* Sets a new value for property {@link #getValueStateText valueStateText}.
*
* Defines the text that appears in the value state message pop-up. If this is not specified, a default text is shown from the resource bundle.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sValueStateText - New value for property valueStateText
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public setValueStateText(sValueStateText: string): sap.m.DateTimeInput;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.DateTimeInput;
/**
* Unbinds property {@link #getValue value} from model data.
* @returns {sap.m.DateTimeInput} Reference to this
in order to allow method chaining
*/
public unbindValue(): sap.m.DateTimeInput;
}
/**
* A subset of DateTimeInput types that fit to a simple API returning one string.
*/
export enum DateTimeInputType {
/**
* An input control for specifying a date value. The user can select a month, day of the month, and year.
*/
Date = "Date",
/**
* An input control for specifying a date and time value. The user can select a month, day of the month, year, and time of day.
*/
DateTime = "DateTime",
/**
* An input control for specifying a time value. The user can select the hour, minute, and optionally AM or PM.
*/
Time = "Time",
}
/**
* Enables the users to select date and time values in a combined input.
*
* DateTimePicker
control consists of two parts: the input field and the
* date/time picker.
*
* Note: The {@link sap.ui.unified.Calendar} is used internally only if the
* DateTimePicker
is opened (not used for the initial rendering). If
* the sap.ui.unified
library is not loaded before the
* DateTimePicker
is opened, it will be loaded upon opening. This
* could lead to a waiting time when the DateTimePicker
is opened for
* the first time. To prevent this, apps using the DateTimePicker
* should also load the sap.ui.unified
library.
*
* DateTimePicker
- as a string to the value
property
* or as a JavaScript Date object to the dateValue
property (only one
* of these properties should be used at a time):
*
* value
property if you want to bind the
* DateTimePicker
to a model using the
* sap.ui.model.type.DateTime
value
property if the date is provided as a string from
* the backend or inside the app (for example, as ABAP type DATS field)dateValue
property if the date is already provided as a
* JavaScript Date object or you want to work with a JavaScript Date objectvalueFormat
is "yyyy-MM-dd-HH-mm-ss", the
* displayFormat
is "MMM d, y, HH:mm:ss", and the used locale is
* English, a valid value string is "2015-07-30-10-30-15", which leads to an output
* of "Jul 30, 2015, 10:30:15".
*
* If no placeholder is set to the DateTimePicker
, the used
* displayFormat
is displayed as a placeholder. If another placeholder
* is needed, it must be set.
*
* Note: If the string does NOT match the displayFormat
* (from user input) or the valueFormat
(on app level), the
* {@link sap.ui.core.format.DateFormat} makes an attempt to parse it based on the
* locale settings. For more information, see the respective documentation in the
* API Reference.
*
* DateTimePicker
is responsive and fully adapts to all devices.
* For larger screens, such as tablet or desktop, it opens as a popover. For
* mobile devices, it opens in full screen.
*/
export class DateTimePicker extends sap.m.DatePicker {
/**
* Constructor for a new DateTimePicker
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.DateTimePicker with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.DatePicker.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Returns a metadata object for class sap.m.DateTimePicker.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Enum of the available deviation markers for the NumericContent control.
*/
export enum DeviationIndicator {
/**
* The actual value is less than the target value.
*/
Down = "Down",
/**
* No value.
*/
None = "None",
/**
* The actual value is more than the target value.
*/
Up = "Up",
}
/**
* A popup that interrupts the current processing and prompts the user for an action or an input, in a modal mode.
* resizable
and draggable
accordingly.
*
* There are other specialized types of dialogs:
* stretch
property is set to true, the dialog displays on full screen.contentWidth
and/or contentHeight
properties are set, the dialog will try to fill those sizes.mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Returns the custom header instance when the customHeader aggregation is set. Otherwise it returns the internal managed
* header instance. This method can be called within composite controls which use sap.m.Dialog inside.
*/
protected _getAnyHeader(): void;
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Dialog;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Dialog;
/**
* Adds some button to the aggregation {@link #getButtons buttons}.
* @param {sap.m.Button} oButton - the button to add; if empty, nothing is inserted
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public addButton(oButton: sap.m.Button): sap.m.Dialog;
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.Dialog;
/**
* Attaches event handler fnFunction
to the {@link #event:afterClose afterClose} event of this sap.m.Dialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Dialog
itself.
*
* This event will be fired after the dialog is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Dialog
itself
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public attachAfterClose(fnFunction: Function, oListener?: any): sap.m.Dialog;
/**
* Attaches event handler fnFunction
to the {@link #event:afterClose afterClose} event of this sap.m.Dialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Dialog
itself.
*
* This event will be fired after the dialog is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Dialog
itself
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public attachAfterClose(oData: any, fnFunction: Function, oListener?: any): sap.m.Dialog;
/**
* Attaches event handler fnFunction
to the {@link #event:afterOpen afterOpen} event of this sap.m.Dialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Dialog
itself.
*
* This event will be fired after the dialog is opened.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Dialog
itself
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public attachAfterOpen(fnFunction: Function, oListener?: any): sap.m.Dialog;
/**
* Attaches event handler fnFunction
to the {@link #event:afterOpen afterOpen} event of this sap.m.Dialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Dialog
itself.
*
* This event will be fired after the dialog is opened.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Dialog
itself
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public attachAfterOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.Dialog;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.Dialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Dialog
itself.
*
* This event will be fired before the dialog is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Dialog
itself
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public attachBeforeClose(fnFunction: Function, oListener?: any): sap.m.Dialog;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.Dialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Dialog
itself.
*
* This event will be fired before the dialog is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Dialog
itself
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public attachBeforeClose(oData: any, fnFunction: Function, oListener?: any): sap.m.Dialog;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.Dialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Dialog
itself.
*
* This event will be fired before the dialog is opened.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Dialog
itself
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(fnFunction: Function, oListener?: any): sap.m.Dialog;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.Dialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Dialog
itself.
*
* This event will be fired before the dialog is opened.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Dialog
itself
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.Dialog;
/**
* Close the dialog.
*/
public close(): void;
/**
* Destroys the beginButton in the aggregation {@link #getBeginButton beginButton}.
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public destroyBeginButton(): sap.m.Dialog;
/**
* Destroys all the buttons in the aggregation {@link #getButtons buttons}.
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public destroyButtons(): sap.m.Dialog;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.Dialog;
/**
* Destroys the customHeader in the aggregation {@link #getCustomHeader customHeader}.
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public destroyCustomHeader(): sap.m.Dialog;
/**
* Destroys the endButton in the aggregation {@link #getEndButton endButton}.
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public destroyEndButton(): sap.m.Dialog;
/**
* Destroys the subHeader in the aggregation {@link #getSubHeader subHeader}.
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public destroySubHeader(): sap.m.Dialog;
/**
* Detaches event handler fnFunction
from the {@link #event:afterClose afterClose} event of this sap.m.Dialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public detachAfterClose(fnFunction: Function, oListener: any): sap.m.Dialog;
/**
* Detaches event handler fnFunction
from the {@link #event:afterOpen afterOpen} event of this sap.m.Dialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public detachAfterOpen(fnFunction: Function, oListener: any): sap.m.Dialog;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeClose beforeClose} event of this sap.m.Dialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public detachBeforeClose(fnFunction: Function, oListener: any): sap.m.Dialog;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeOpen beforeOpen} event of this sap.m.Dialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public detachBeforeOpen(fnFunction: Function, oListener: any): sap.m.Dialog;
/**
* Creates a new subclass of class sap.m.Dialog with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:afterClose afterClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
protected fireAfterClose(mParameters?: any): sap.m.Dialog;
/**
* Fires event {@link #event:afterOpen afterOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
protected fireAfterOpen(mParameters?: any): sap.m.Dialog;
/**
* Fires event {@link #event:beforeClose beforeClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
protected fireBeforeClose(mParameters?: any): sap.m.Dialog;
/**
* Fires event {@link #event:beforeOpen beforeOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
protected fireBeforeOpen(mParameters?: any): sap.m.Dialog;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets content of aggregation {@link #getBeginButton beginButton}.
*
* The button which is rendered to the left side (right side in RTL mode) of the endButton in the footer area inside the dialog. From UI5 version 1.21.1, there's a new aggregation "buttons" created with which more than 2 buttons can be added to the footer area of dialog. If the new "buttons" aggregation is set, any change made to this aggregation has no effect anymore. When runs on the phone, this button (and the endButton together when set) is (are) rendered at the center of the footer area. When runs on the other platforms, this button (and the endButton together when set) is (are) rendered at the right side (left side in RTL mode) of the footer area.
* @returns {sap.m.Button}
*/
public getBeginButton(): sap.m.Button;
/**
* Gets content of aggregation {@link #getButtons buttons}.
*
* Buttons can be added to the footer area of dialog through this aggregation. When this aggregation is set, any change to beginButton and endButton has no effect anymore. Buttons which are inside this aggregation are aligned at the right side (left side in RTL mode) of the footer instead of in the middle of the footer.
* @returns {sap.m.Button[]}
*/
public getButtons(): sap.m.Button[];
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content inside the dialog.Dialog
is comprised of controls that use position: absolute
, such as SplitContainer
, the dialog has to have either stretch: true
or contentHeight
set.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getContentHeight contentHeight}.
*
* Preferred height of content in Dialog. If the preferred height is bigger than the available space on screen, it will be overwritten by the maximum available height on screen in order to make sure that dialog isn't cut off.
* @returns {sap.ui.core.CSSSize} Value of property contentHeight
*/
public getContentHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getContentWidth contentWidth}.
*
* Preferred width of content in Dialog. This property affects the width of dialog on phone in landscape mode, tablet or desktop, because the dialog has a fixed width on phone in portrait mode. If the preferred width is less than the minimum width of dilaog or more than the available width of the screen, it will be overwritten by the min or max value. The current mininum value of dialog width on tablet is 400px.
* @returns {sap.ui.core.CSSSize} Value of property contentWidth
*/
public getContentWidth(): sap.ui.core.CSSSize;
/**
* Gets content of aggregation {@link #getCustomHeader customHeader}.
*
* CustomHeader is only supported in some themes. When it's set, the icon, title and showHeader are properties ignored. Only the customHeader is shown as the header of the dialog.
* @returns {sap.m.IBar}
*/
public getCustomHeader(): sap.m.IBar;
/**
* Gets current value of property {@link #getDraggable draggable}.
*
* Indicates whether the dialog is draggable. If this property is set to true, the dialog will be draggable by it's header. This property has a default value false. The Dialog can be draggable only in desktop mode.
*
* Default value is false
.
* @returns {boolean} Value of property draggable
*/
public getDraggable(): boolean;
/**
* Gets content of aggregation {@link #getEndButton endButton}.
*
* The button which is rendered to the right side (left side in RTL mode) of the beginButton in the footer area inside the dialog. From UI5 version 1.21.1, there's a new aggregation "buttons" created with which more than 2 buttons can be added to the footer area of dialog. If the new "buttons" aggregation is set, any change made to this aggregation has no effect anymore. When runs on the phone, this button (and the beginButton together when set) is (are) rendered at the center of the footer area. When runs on the other platforms, this button (and the beginButton together when set) is (are) rendered at the right side (left side in RTL mode) of the footer area.
* @returns {sap.m.Button}
*/
public getEndButton(): sap.m.Button;
/**
* Gets current value of property {@link #getEscapeHandler escapeHandler}.
*
* This property expects a function with one parameter of type Promise
. In the function you should call either resolve()
or reject()
on the Promise
object.escapeHandler
*/
public getEscapeHandler(): any;
/**
* Gets current value of property {@link #getHorizontalScrolling horizontalScrolling}.
*
* Indicates if user can scroll horizontally inside dialog when the content is bigger than the content area.
* Dialog detects if there's sap.m.NavContainer, sap.m.Page, sap.m.ScrollContainer or sap.m.SplitContainer as direct child added to dialog. If there is, dialog will turn off scrolling by setting this property to false automatically ignoring the existing value of this property.
*
* Default value is true
.
* @returns {boolean} Value of property horizontalScrolling
*/
public getHorizontalScrolling(): boolean;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Icon displayed in the dialog's header. This icon is invisible on the iOS platform and it's density aware. You can use the density convention (@2, @1.5, etc.) to provide higher resolution image for higher density screen.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* ID of the element which is the current target of the association {@link #getInitialFocus initialFocus}, or null
.
* @returns {sap.ui.core.ID}
*/
public getInitialFocus(): sap.ui.core.ID;
/**
* ID of the element which is the current target of the association {@link #getLeftButton leftButton}, or null
.
* @returns {sap.ui.core.ID}
*/
public getLeftButton(): sap.ui.core.ID;
/**
* Returns a metadata object for class sap.m.Dialog.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getResizable resizable}.
*
* Indicates whether the dialog is resizable. the dialog is resizable. If this property is set to true, the dialog will have a resize handler in it's bottom right corner. This property has a default value false. The Dialog can be resizable only in desktop mode.
*
* Default value is false
.
* @returns {boolean} Value of property resizable
*/
public getResizable(): boolean;
/**
* ID of the element which is the current target of the association {@link #getRightButton rightButton}, or null
.
* @returns {sap.ui.core.ID}
*/
public getRightButton(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getShowHeader showHeader}.
*
* Determines whether the header is shown inside the dialog. If this property is set to true, the text and icon property are ignored. This property has a default value true.
*
* Default value is true
.
* @returns {boolean} Value of property showHeader
*/
public getShowHeader(): boolean;
/**
* Gets current value of property {@link #getState state}.
*
* The state affects the icon and the title color. If other than "None" is set, a predefined icon will be added to the dialog. Setting icon property will overwrite the predefined icon. The default value is "None" which doesn't add any icon to the Dialog control. This property is by now only supported by blue crystal theme.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property state
*/
public getState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getStretch stretch}.
*
* Determines if the dialog will be stretched to full screen. This property is only applicable to standard dialog and message type dialog ignores this property.
*
* Default value is false
.
* @returns {boolean} Value of property stretch
*/
public getStretch(): boolean;
/**
* Gets current value of property {@link #getStretchOnPhone stretchOnPhone}.
*
* Determines whether the dialog will displayed on full screen on a phone.
*
* Default value is false
.
* @returns {boolean} Value of property stretchOnPhone
*/
public getStretchOnPhone(): boolean;
/**
* Gets content of aggregation {@link #getSubHeader subHeader}.
*
* When subHeader is assigned to Dialog, it's rendered directly after the main header in Dialog. SubHeader is out of the content area and won't be scrolled when content's size is bigger than the content area's size.
* @returns {sap.m.IBar}
*/
public getSubHeader(): sap.m.IBar;
/**
* Gets current value of property {@link #getTitle title}.
*
* Title text appears in the dialog header.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getType type}.
*
* The type of the dialog. In some themes, the type "message" will limit the dialog's width within 480px on tablet and desktop.
*
* Default value is Standard
.
* @returns {sap.m.DialogType} Value of property type
*/
public getType(): sap.m.DialogType;
/**
* Gets current value of property {@link #getVerticalScrolling verticalScrolling}.
*
* Indicates if user can scroll vertically inside dialog when the content is bigger than the content area.
* Dialog detects if there's sap.m.NavContainer, sap.m.Page, sap.m.ScrollContainer or sap.m.SplitContainer as direct child added to dialog. If there is, dialog will turn off scrolling by setting this property to false automatically ignoring the existing value of this property.
*
* Default value is true
.
* @returns {boolean} Value of property verticalScrolling
*/
public getVerticalScrolling(): boolean;
/**
* Checks for the provided sap.m.Button
in the aggregation {@link #getButtons buttons}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Button} oButton - The button whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfButton(oButton: sap.m.Button): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a button into the aggregation {@link #getButtons buttons}.
* @param {sap.m.Button} oButton - the button to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the button should be inserted at; for a negative value of iIndex
, the button is inserted at position 0; for a value greater than the current size of the aggregation, the button is inserted at the last position
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public insertButton(oButton: sap.m.Button, iIndex: number): sap.m.Dialog;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.Dialog;
/**
* The method checks if the Dialog is open. It returns true when the Dialog is currently open (this includes opening and closing animations), otherwise it returns false.
* @returns {any} boolean
*/
public isOpen(): any;
/**
* Open the dialog.
*/
public open(): void;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getButtons buttons}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Button[]} An array of the removed elements (might be empty)
*/
public removeAllButtons(): sap.m.Button[];
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a button from the aggregation {@link #getButtons buttons}.
* @param {number|string|sap.m.Button} vButton - The button to remove or its index or id
* @returns {sap.m.Button} The removed button or null
*/
public removeButton(vButton: number|string|sap.m.Button): sap.m.Button;
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets the aggregated {@link #getBeginButton beginButton}.
* @param {sap.m.Button} oBeginButton - The beginButton to set
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setBeginButton(oBeginButton: sap.m.Button): sap.m.Dialog;
/**
* Sets a new value for property {@link #getContentHeight contentHeight}.
*
* Preferred height of content in Dialog. If the preferred height is bigger than the available space on screen, it will be overwritten by the maximum available height on screen in order to make sure that dialog isn't cut off.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sContentHeight - New value for property contentHeight
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setContentHeight(sContentHeight: sap.ui.core.CSSSize): sap.m.Dialog;
/**
* Sets a new value for property {@link #getContentWidth contentWidth}.
*
* Preferred width of content in Dialog. This property affects the width of dialog on phone in landscape mode, tablet or desktop, because the dialog has a fixed width on phone in portrait mode. If the preferred width is less than the minimum width of dilaog or more than the available width of the screen, it will be overwritten by the min or max value. The current mininum value of dialog width on tablet is 400px.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sContentWidth - New value for property contentWidth
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setContentWidth(sContentWidth: sap.ui.core.CSSSize): sap.m.Dialog;
/**
* Sets the aggregated {@link #getCustomHeader customHeader}.
* @param {sap.m.IBar} oCustomHeader - The customHeader to set
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setCustomHeader(oCustomHeader: sap.m.IBar): sap.m.Dialog;
/**
* Sets a new value for property {@link #getDraggable draggable}.
*
* Indicates whether the dialog is draggable. If this property is set to true, the dialog will be draggable by it's header. This property has a default value false. The Dialog can be draggable only in desktop mode.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bDraggable - New value for property draggable
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setDraggable(bDraggable: boolean): sap.m.Dialog;
/**
* Sets the aggregated {@link #getEndButton endButton}.
* @param {sap.m.Button} oEndButton - The endButton to set
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setEndButton(oEndButton: sap.m.Button): sap.m.Dialog;
/**
* Sets a new value for property {@link #getEscapeHandler escapeHandler}.
*
* This property expects a function with one parameter of type Promise
. In the function you should call either resolve()
or reject()
on the Promise
object.null
or undefined
, the default value of the property will be restored.
* @param {any} oEscapeHandler - New value for property escapeHandler
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setEscapeHandler(oEscapeHandler: any): sap.m.Dialog;
/**
* Sets a new value for property {@link #getHorizontalScrolling horizontalScrolling}.
*
* Indicates if user can scroll horizontally inside dialog when the content is bigger than the content area.
* Dialog detects if there's sap.m.NavContainer, sap.m.Page, sap.m.ScrollContainer or sap.m.SplitContainer as direct child added to dialog. If there is, dialog will turn off scrolling by setting this property to false automatically ignoring the existing value of this property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bHorizontalScrolling - New value for property horizontalScrolling
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setHorizontalScrolling(bHorizontalScrolling: boolean): sap.m.Dialog;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Icon displayed in the dialog's header. This icon is invisible on the iOS platform and it's density aware. You can use the density convention (@2, @1.5, etc.) to provide higher resolution image for higher density screen.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.Dialog;
/**
* Sets the associated {@link #getInitialFocus initialFocus}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oInitialFocus - ID of an element which becomes the new target of this initialFocus association; alternatively, an element instance may be given
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setInitialFocus(oInitialFocus: sap.ui.core.ID|sap.ui.core.Control): sap.m.Dialog;
/**
* Sets the associated {@link #getLeftButton leftButton}.
* @param {sap.ui.core.ID|sap.m.Button} oLeftButton - ID of an element which becomes the new target of this leftButton association; alternatively, an element instance may be given
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setLeftButton(oLeftButton: sap.ui.core.ID|sap.m.Button): sap.m.Dialog;
/**
* Sets a new value for property {@link #getResizable resizable}.
*
* Indicates whether the dialog is resizable. the dialog is resizable. If this property is set to true, the dialog will have a resize handler in it's bottom right corner. This property has a default value false. The Dialog can be resizable only in desktop mode.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bResizable - New value for property resizable
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setResizable(bResizable: boolean): sap.m.Dialog;
/**
* Sets the associated {@link #getRightButton rightButton}.
* @param {sap.ui.core.ID|sap.m.Button} oRightButton - ID of an element which becomes the new target of this rightButton association; alternatively, an element instance may be given
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setRightButton(oRightButton: sap.ui.core.ID|sap.m.Button): sap.m.Dialog;
/**
* Sets a new value for property {@link #getShowHeader showHeader}.
*
* Determines whether the header is shown inside the dialog. If this property is set to true, the text and icon property are ignored. This property has a default value true.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowHeader - New value for property showHeader
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setShowHeader(bShowHeader: boolean): sap.m.Dialog;
/**
* Sets a new value for property {@link #getState state}.
*
* The state affects the icon and the title color. If other than "None" is set, a predefined icon will be added to the dialog. Setting icon property will overwrite the predefined icon. The default value is "None" which doesn't add any icon to the Dialog control. This property is by now only supported by blue crystal theme.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sState - New value for property state
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setState(sState: sap.ui.core.ValueState): sap.m.Dialog;
/**
* Sets a new value for property {@link #getStretch stretch}.
*
* Determines if the dialog will be stretched to full screen. This property is only applicable to standard dialog and message type dialog ignores this property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bStretch - New value for property stretch
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setStretch(bStretch: boolean): sap.m.Dialog;
/**
* Sets a new value for property {@link #getStretchOnPhone stretchOnPhone}.
*
* Determines whether the dialog will displayed on full screen on a phone.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bStretchOnPhone - New value for property stretchOnPhone
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setStretchOnPhone(bStretchOnPhone: boolean): sap.m.Dialog;
/**
* Sets the aggregated {@link #getSubHeader subHeader}.
* @param {sap.m.IBar} oSubHeader - The subHeader to set
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setSubHeader(oSubHeader: sap.m.IBar): sap.m.Dialog;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Title text appears in the dialog header.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.Dialog;
/**
* Sets a new value for property {@link #getType type}.
*
* The type of the dialog. In some themes, the type "message" will limit the dialog's width within 480px on tablet and desktop.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.m.DialogType} sType - New value for property type
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.m.DialogType): sap.m.Dialog;
/**
* Sets a new value for property {@link #getVerticalScrolling verticalScrolling}.
*
* Indicates if user can scroll vertically inside dialog when the content is bigger than the content area.
* Dialog detects if there's sap.m.NavContainer, sap.m.Page, sap.m.ScrollContainer or sap.m.SplitContainer as direct child added to dialog. If there is, dialog will turn off scrolling by setting this property to false automatically ignoring the existing value of this property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVerticalScrolling - New value for property verticalScrolling
* @returns {sap.m.Dialog} Reference to this
in order to allow method chaining
*/
public setVerticalScrolling(bVerticalScrolling: boolean): sap.m.Dialog;
}
/**
* Enum for the type of sap.m.Dialog control.
*/
export enum DialogType {
/**
* Dialog with type Message looks the same as the Stardard Dialog in Android. And it puts the left, right buttons to the bottom of the Dialog in iOS.
*/
Message = "Message",
/**
* This is the default value for Dialog type. Stardard dialog in iOS has a header on the top and the left, right buttons are put inside the header. In android, the left, right buttons are put to the bottom of the Dialog.
*/
Standard = "Standard",
}
/**
* sap.m.DisplayListItem
can be used to represent a label and a value.
*/
export class DisplayListItem extends sap.m.ListItemBase {
/**
* Constructor for a new DisplayListItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.DisplayListItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ListItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getLabel label}.
*
* Defines the label of the list item.
* @returns {string} Value of property label
*/
public getLabel(): string;
/**
* Returns a metadata object for class sap.m.DisplayListItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getValue value}.
*
* Defines the value of the list item.
* @returns {string} Value of property value
*/
public getValue(): string;
/**
* Gets current value of property {@link #getValueTextDirection valueTextDirection}.
*
* Defines the value
text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property valueTextDirection
*/
public getValueTextDirection(): sap.ui.core.TextDirection;
/**
* Sets a new value for property {@link #getLabel label}.
*
* Defines the label of the list item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sLabel - New value for property label
* @returns {sap.m.DisplayListItem} Reference to this
in order to allow method chaining
*/
public setLabel(sLabel: string): sap.m.DisplayListItem;
/**
* Sets a new value for property {@link #getValue value}.
*
* Defines the value of the list item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sValue - New value for property value
* @returns {sap.m.DisplayListItem} Reference to this
in order to allow method chaining
*/
public setValue(sValue: string): sap.m.DisplayListItem;
/**
* Sets a new value for property {@link #getValueTextDirection valueTextDirection}.
*
* Defines the value
text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sValueTextDirection - New value for property valueTextDirection
* @returns {sap.m.DisplayListItem} Reference to this
in order to allow method chaining
*/
public setValueTextDirection(sValueTextDirection: sap.ui.core.TextDirection): sap.m.DisplayListItem;
}
/**
* A draft indicator is {@link sap.m.Label}.
*/
export class DraftIndicator extends sap.ui.core.Control {
/**
* Constructor for a new DraftIndicator.
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
*/
public constructor(sId?: string);
/**
* Clears the indicator state
*/
public clearDraftState(): void;
/**
* Creates a new subclass of class sap.m.DraftIndicator with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.DraftIndicator.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinDisplayTime minDisplayTime}.
*
* Minimum time in milliseconds for showing the draft indicator
*
* Default value is 1500
.
* @returns {number} Value of property minDisplayTime
*/
public getMinDisplayTime(): number;
/**
* Gets current value of property {@link #getState state}.
*
* State of the indicator. Could be "Saving", "Saved" and "Clear".
*
* Default value is Clear
.
* @returns {sap.m.DraftIndicatorState} Value of property state
*/
public getState(): sap.m.DraftIndicatorState;
/**
* Sets a new value for property {@link #getMinDisplayTime minDisplayTime}.
*
* Minimum time in milliseconds for showing the draft indicator
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1500
.
* @param {number} iMinDisplayTime - New value for property minDisplayTime
* @returns {sap.m.DraftIndicator} Reference to this
in order to allow method chaining
*/
public setMinDisplayTime(iMinDisplayTime: number): sap.m.DraftIndicator;
/**
* Sets the indicator in "Saved" state
*/
public showDraftSaved(): void;
/**
* Sets the indicator in "Saving..." state
*/
public showDraftSaving(): void;
}
/**
* Enum for the state of sap.m.DraftIndicator control.
*/
export enum DraftIndicatorState {
/**
* This is the default value for DraftIndicatorState type. This state has no visual information displayed.
*/
Clear = "Clear",
/**
* Indicates that the draft is already saved
*/
Saved = "Saved",
/**
* Indicates that the draft currently is being saved
*/
Saving = "Saving",
}
/**
* Provides filtering functionality with multiple parameters.
*
* FacetFilter
control is used to provide filtering functionality
* with multiple parameters and supports the users in finding the information they
* need from potentially very large data sets.
*
* Your app can have dependencies between facets where selection of filter items in
* one facet list limits the list of valid filters in another facet list.
*
* The FacetFilter
uses {@link sap.m.FacetFilterList FacetFilterList} and
* {@link sap.m.FacetFilterItem FacetFilterItem} to model facets and their associated
* filters.
*
* Note: {@link sap.m.FacetFilterList FacetFilterList} is a subclass of
* {@link sap.m.List} and supports growing enablement feature via the property
* growing
. When you use this feature, be aware that it only works with
* one-way data binding.
* Having growing feature enabled when the items
aggregation is bound to
* a model with two-way data binding, may lead to unexpected and/or inconsistent
* behavior across browsers, such as unexpected closing of the list.
*
* FacetFilter
if your app displays a large list of
* items that can be grouped by multiple parameters, for example products by category
* and supplier. With the FacetFilter
, you allow the users
* to dynamically filter the list so it only displays products from the categories and
* suppliers they want to see.
*
* While the {@link sap.m.FacetFilterList} popup is opened (when the user selects a button
* corresponding to the list's name), any other activities leading to focus change will
* close it. For example, when the popup is opened and the app developer loads a
* {@link sap.m.BusyDialog} or any other dialog that obtains the focus, the popup will
* be closed.
*
* FacetFilter
supports the following two types, which
* can be configured using the control's type
property:
*
* FacetFilter
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some list to the aggregation {@link #getLists lists}.
* @param {sap.m.FacetFilterList} oList - the list to add; if empty, nothing is inserted
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
public addList(oList: sap.m.FacetFilterList): sap.m.FacetFilter;
/**
* Attaches event handler fnFunction
to the {@link #event:confirm confirm} event of this sap.m.FacetFilter
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FacetFilter
itself.
*
* Fired when the user confirms filter selection.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FacetFilter
itself
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
public attachConfirm(fnFunction: Function, oListener?: any): sap.m.FacetFilter;
/**
* Attaches event handler fnFunction
to the {@link #event:confirm confirm} event of this sap.m.FacetFilter
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FacetFilter
itself.
*
* Fired when the user confirms filter selection.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FacetFilter
itself
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
public attachConfirm(oData: any, fnFunction: Function, oListener?: any): sap.m.FacetFilter;
/**
* Attaches event handler fnFunction
to the {@link #event:reset reset} event of this sap.m.FacetFilter
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FacetFilter
itself.
*
* Fired when the Reset button is pressed to inform that all FacetFilterLists need to be reset.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FacetFilter
itself
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
public attachReset(fnFunction: Function, oListener?: any): sap.m.FacetFilter;
/**
* Attaches event handler fnFunction
to the {@link #event:reset reset} event of this sap.m.FacetFilter
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FacetFilter
itself.
*
* Fired when the Reset button is pressed to inform that all FacetFilterLists need to be reset.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FacetFilter
itself
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
public attachReset(oData: any, fnFunction: Function, oListener?: any): sap.m.FacetFilter;
/**
* Destroys all the lists in the aggregation {@link #getLists lists}.
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
public destroyLists(): sap.m.FacetFilter;
/**
* Detaches event handler fnFunction
from the {@link #event:confirm confirm} event of this sap.m.FacetFilter
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
public detachConfirm(fnFunction: Function, oListener: any): sap.m.FacetFilter;
/**
* Detaches event handler fnFunction
from the {@link #event:reset reset} event of this sap.m.FacetFilter
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
public detachReset(fnFunction: Function, oListener: any): sap.m.FacetFilter;
/**
* Creates a new subclass of class sap.m.FacetFilter with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:confirm confirm} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
protected fireConfirm(mParameters?: any): sap.m.FacetFilter;
/**
* Fires event {@link #event:reset reset} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
protected fireReset(mParameters?: any): sap.m.FacetFilter;
/**
* Gets content of aggregation {@link #getLists lists}.
*
* Collection of FacetFilterList controls.
* @returns {sap.m.FacetFilterList[]}
*/
public getLists(): sap.m.FacetFilterList[];
/**
* Gets current value of property {@link #getLiveSearch liveSearch}.
*
* Enables/disables live search in the search field of all sap.m.FacetFilterList
instances.
*
* Default value is true
.
* @returns {boolean} Value of property liveSearch
*/
public getLiveSearch(): boolean;
/**
* Returns a metadata object for class sap.m.FacetFilter.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowPersonalization showPersonalization}.
*
* If set to true
and the FacetFilter type is Simple
, then the Add Facet icon will be displayed and each facet button will also have a Facet Remove icon displayed beside it, allowing the user to deactivate the facet.
*
* Default value is false
.
* @returns {boolean} Value of property showPersonalization
*/
public getShowPersonalization(): boolean;
/**
* Gets current value of property {@link #getShowPopoverOKButton showPopoverOKButton}.
*
* If set to true
, an OK button is displayed for every FacetFilterList popover. This button allows the user to close the popover from within the popover instead of having to click outside of it.
*
* Default value is false
.
* @returns {boolean} Value of property showPopoverOKButton
*/
public getShowPopoverOKButton(): boolean;
/**
* Gets current value of property {@link #getShowReset showReset}.
*
* Shows/hides the FacetFilter Reset button.
*
* Default value is true
.
* @returns {boolean} Value of property showReset
*/
public getShowReset(): boolean;
/**
* Gets current value of property {@link #getShowSummaryBar showSummaryBar}.
*
* Shows the summary bar instead of the FacetFilter buttons bar when set to true
.
*
* Default value is false
.
* @returns {boolean} Value of property showSummaryBar
*/
public getShowSummaryBar(): boolean;
/**
* Gets current value of property {@link #getType type}.
*
* Defines the default appearance of the FacetFilter on the device. Possible values are Simple
(default) and Light
.
*
* Default value is Simple
.
* @returns {sap.m.FacetFilterType} Value of property type
*/
public getType(): sap.m.FacetFilterType;
/**
* Checks for the provided sap.m.FacetFilterList
in the aggregation {@link #getLists lists}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.FacetFilterList} oList - The list whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfList(oList: sap.m.FacetFilterList): number;
/**
* Inserts a list into the aggregation {@link #getLists lists}.
* @param {sap.m.FacetFilterList} oList - the list to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the list should be inserted at; for a negative value of iIndex
, the list is inserted at position 0; for a value greater than the current size of the aggregation, the list is inserted at the last position
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
public insertList(oList: sap.m.FacetFilterList, iIndex: number): sap.m.FacetFilter;
/**
* Opens the FacetFilter dialog.
* @returns {sap.m.FacetFilter} this pointer for chaining
*/
public openFilterDialog(): sap.m.FacetFilter;
/**
* Removes all the controls from the aggregation {@link #getLists lists}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.FacetFilterList[]} An array of the removed elements (might be empty)
*/
public removeAllLists(): sap.m.FacetFilterList[];
/**
* Removes a list from the aggregation {@link #getLists lists}.
* @param {number|string|sap.m.FacetFilterList} vList - The list to remove or its index or id
* @returns {sap.m.FacetFilterList} The removed list or null
*/
public removeList(vList: number|string|sap.m.FacetFilterList): sap.m.FacetFilterList;
/**
* Sets a new value for property {@link #getLiveSearch liveSearch}.
*
* Enables/disables live search in the search field of all sap.m.FacetFilterList
instances.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bLiveSearch - New value for property liveSearch
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
public setLiveSearch(bLiveSearch: boolean): sap.m.FacetFilter;
/**
* Sets a new value for property {@link #getShowPersonalization showPersonalization}.
*
* If set to true
and the FacetFilter type is Simple
, then the Add Facet icon will be displayed and each facet button will also have a Facet Remove icon displayed beside it, allowing the user to deactivate the facet.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowPersonalization - New value for property showPersonalization
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
public setShowPersonalization(bShowPersonalization: boolean): sap.m.FacetFilter;
/**
* Sets a new value for property {@link #getShowPopoverOKButton showPopoverOKButton}.
*
* If set to true
, an OK button is displayed for every FacetFilterList popover. This button allows the user to close the popover from within the popover instead of having to click outside of it.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowPopoverOKButton - New value for property showPopoverOKButton
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
public setShowPopoverOKButton(bShowPopoverOKButton: boolean): sap.m.FacetFilter;
/**
* Sets a new value for property {@link #getShowReset showReset}.
*
* Shows/hides the FacetFilter Reset button.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowReset - New value for property showReset
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
public setShowReset(bShowReset: boolean): sap.m.FacetFilter;
/**
* Sets a new value for property {@link #getShowSummaryBar showSummaryBar}.
*
* Shows the summary bar instead of the FacetFilter buttons bar when set to true
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowSummaryBar - New value for property showSummaryBar
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
public setShowSummaryBar(bShowSummaryBar: boolean): sap.m.FacetFilter;
/**
* Sets a new value for property {@link #getType type}.
*
* Defines the default appearance of the FacetFilter on the device. Possible values are Simple
(default) and Light
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Simple
.
* @param {sap.m.FacetFilterType} sType - New value for property type
* @returns {sap.m.FacetFilter} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.m.FacetFilterType): sap.m.FacetFilter;
}
/**
* Represents a value for the {@link sap.m.FacetfilterList} control.
*/
export class FacetFilterItem extends sap.m.ListItemBase {
/**
* Constructor for a new FacetFilterItem
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.FacetFilterItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ListItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getCount count}.
*
* Defines the number of objects that match this item in the target data set.
* @returns {number} Value of property count
*/
public getCount(): number;
/**
* Gets current value of property {@link #getKey key}.
*
* Can be used as input for subsequent actions.
* @returns {string} Value of property key
*/
public getKey(): string;
/**
* Returns a metadata object for class sap.m.FacetFilterItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* Determines the text to be displayed for the item.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Sets a new value for property {@link #getCount count}.
*
* Defines the number of objects that match this item in the target data set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iCount - New value for property count
* @returns {sap.m.FacetFilterItem} Reference to this
in order to allow method chaining
*/
public setCount(iCount: number): sap.m.FacetFilterItem;
/**
* Sets a new value for property {@link #getKey key}.
*
* Can be used as input for subsequent actions.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sKey - New value for property key
* @returns {sap.m.FacetFilterItem} Reference to this
in order to allow method chaining
*/
public setKey(sKey: string): sap.m.FacetFilterItem;
/**
* Sets a new value for property {@link #getText text}.
*
* Determines the text to be displayed for the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.m.FacetFilterItem} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.FacetFilterItem;
}
/**
* Represents a list of values for the {@link sap.m.FacetFilter} control.
*
* Note: FacetFilterList
is a subclass of {@link sap.m.List} and supports
* growing enablement feature via the property growing
. When you use this feature,
* be aware that it only works with one-way data binding.
* Having growing feature enabled when the items
aggregation is bound to
* a model with two-way data binding, may lead to unexpected and/or inconsistent
* behavior across browsers, such as unexpected closing of the list.
*
* While the FacetFilterList
popup is opened (when the user selects a button
* corresponding to the list's name), any other activities leading to focus change will
* close it. For example, when the popup is opened and the app developer loads a
* {@link sap.m.BusyDialog} or any other dialog that obtains the focus, the popup will
* be closed.
*/
export class FacetFilterList extends sap.m.List {
/**
* Constructor for a new FacetFilterList
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:listClose listClose} event of this sap.m.FacetFilterList
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FacetFilterList
itself.
*
* Triggered after the list of items is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FacetFilterList
itself
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public attachListClose(fnFunction: Function, oListener?: any): sap.m.FacetFilterList;
/**
* Attaches event handler fnFunction
to the {@link #event:listClose listClose} event of this sap.m.FacetFilterList
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FacetFilterList
itself.
*
* Triggered after the list of items is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FacetFilterList
itself
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public attachListClose(oData: any, fnFunction: Function, oListener?: any): sap.m.FacetFilterList;
/**
* Attaches event handler fnFunction
to the {@link #event:listOpen listOpen} event of this sap.m.FacetFilterList
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FacetFilterList
itself.
*
* Fired before the filter list is opened.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FacetFilterList
itself
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public attachListOpen(fnFunction: Function, oListener?: any): sap.m.FacetFilterList;
/**
* Attaches event handler fnFunction
to the {@link #event:listOpen listOpen} event of this sap.m.FacetFilterList
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FacetFilterList
itself.
*
* Fired before the filter list is opened.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FacetFilterList
itself
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public attachListOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.FacetFilterList;
/**
* Detaches event handler fnFunction
from the {@link #event:listClose listClose} event of this sap.m.FacetFilterList
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public detachListClose(fnFunction: Function, oListener: any): sap.m.FacetFilterList;
/**
* Detaches event handler fnFunction
from the {@link #event:listOpen listOpen} event of this sap.m.FacetFilterList
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public detachListOpen(fnFunction: Function, oListener: any): sap.m.FacetFilterList;
/**
* Creates a new subclass of class sap.m.FacetFilterList with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.List.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:listClose listClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
protected fireListClose(mParameters?: any): sap.m.FacetFilterList;
/**
* Fires event {@link #event:listOpen listOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
protected fireListOpen(mParameters?: any): sap.m.FacetFilterList;
/**
* Gets current value of property {@link #getActive active}.
*
* Indicates that the list is displayed as a button when the FacetFilter type is set to Simple
.
*
* Default value is true
.
* @returns {boolean} Value of property active
*/
public getActive(): boolean;
/**
* Gets current value of property {@link #getAllCount allCount}.
*
* Determines the number of objects that match this item in the target data set when all filter items are selected.
* @returns {number} Value of property allCount
*/
public getAllCount(): number;
/**
* Gets current value of property {@link #getDataType dataType}.
*
* FacetFilterList data type. Only String data type will provide search function.
*
* Default value is String
.
* @returns {sap.m.FacetFilterListDataType} Value of property dataType
*/
public getDataType(): sap.m.FacetFilterListDataType;
/**
* Gets current value of property {@link #getEnableCaseInsensitiveSearch enableCaseInsensitiveSearch}.
*
* If set to true
, enables case-insensitive search for OData.
*
* Default value is false
.
* @returns {boolean} Value of property enableCaseInsensitiveSearch
*/
public getEnableCaseInsensitiveSearch(): boolean;
/**
* Gets current value of property {@link #getKey key}.
*
* Unique identifier for this filter list.
* @returns {string} Value of property key
*/
public getKey(): string;
/**
* Returns a metadata object for class sap.m.FacetFilterList.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMultiSelect multiSelect}.
*
* Specifies whether multiple or single selection is used.
*
* Default value is true
.
* @returns {boolean} Value of property multiSelect
*/
public getMultiSelect(): boolean;
/**
* Gets current value of property {@link #getRetainListSequence retainListSequence}.
*
* Retains the list sequence if it is inactive and made active again.
*
* Default value is false
.
* @returns {boolean} Value of property retainListSequence
*/
public getRetainListSequence(): boolean;
/**
* Returns the keys of the selected elements as an associative array.
* An empty object is returned if no items are selected.
* @returns {any} Object with the selected keys
*/
public getSelectedKeys(): any;
/**
* Gets current value of property {@link #getSequence sequence}.
*
* Sequence that determines the order in which FacetFilterList is shown on the FacetFilter. Lists are rendered by ascending order of sequence.
*
* Default value is -1
.
* @returns {number} Value of property sequence
*/
public getSequence(): number;
/**
* Gets current value of property {@link #getShowRemoveFacetIcon showRemoveFacetIcon}.
*
* Specifies whether remove icon for facet is visible or hidden.
*
* Default value is true
.
* @returns {boolean} Value of property showRemoveFacetIcon
*/
public getShowRemoveFacetIcon(): boolean;
/**
* Gets current value of property {@link #getTitle title}.
*
* Defines the title of the facet. The facet title is displayed on the facet button when the FacetFilter type is set to Simple
. It is also displayed as a list item in the facet page of the dialog.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getWordWrap wordWrap}.
*
* If set to true
, the item text wraps when it is too long.
*
* Default value is false
.
* @returns {boolean} Value of property wordWrap
*/
public getWordWrap(): boolean;
/**
* Removes the specified key from the selected keys cache and deselects the item.
* @param {string} sKey - The key of the selected item to be removed from the cache. If null
then the text parameter will be used as the key.
* @param {string} sText - The text of the selected item to be removed from the cache. If the key parameter is null
then text will be used as the key.
*/
public removeSelectedKey(sKey: string, sText: string): void;
/**
* Removes all selected keys from the selected keys cache and deselects all items.
*/
public removeSelectedKeys(): void;
/**
* Sets a new value for property {@link #getActive active}.
*
* Indicates that the list is displayed as a button when the FacetFilter type is set to Simple
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bActive - New value for property active
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setActive(bActive: boolean): sap.m.FacetFilterList;
/**
* Sets a new value for property {@link #getAllCount allCount}.
*
* Determines the number of objects that match this item in the target data set when all filter items are selected.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iAllCount - New value for property allCount
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setAllCount(iAllCount: number): sap.m.FacetFilterList;
/**
* Sets a new value for property {@link #getDataType dataType}.
*
* FacetFilterList data type. Only String data type will provide search function.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is String
.
* @param {sap.m.FacetFilterListDataType} sDataType - New value for property dataType
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setDataType(sDataType: sap.m.FacetFilterListDataType): sap.m.FacetFilterList;
/**
* Sets a new value for property {@link #getEnableCaseInsensitiveSearch enableCaseInsensitiveSearch}.
*
* If set to true
, enables case-insensitive search for OData.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableCaseInsensitiveSearch - New value for property enableCaseInsensitiveSearch
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setEnableCaseInsensitiveSearch(bEnableCaseInsensitiveSearch: boolean): sap.m.FacetFilterList;
/**
* Sets a new value for property {@link #getKey key}.
*
* Unique identifier for this filter list.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sKey - New value for property key
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setKey(sKey: string): sap.m.FacetFilterList;
/**
* Overrides to allow only MultiSelect and SingleSelectMaster list modes.
* If an invalid mode is given then the mode will not be changed.
* @param {sap.m.ListMode} mode - The list mode
* @returns {sap.m.FacetFilterList}
*/
public setMode(mode: sap.m.ListMode): sap.m.FacetFilterList;
/**
* Sets a new value for property {@link #getMultiSelect multiSelect}.
*
* Specifies whether multiple or single selection is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bMultiSelect - New value for property multiSelect
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setMultiSelect(bMultiSelect: boolean): sap.m.FacetFilterList;
/**
* Sets a new value for property {@link #getRetainListSequence retainListSequence}.
*
* Retains the list sequence if it is inactive and made active again.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bRetainListSequence - New value for property retainListSequence
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setRetainListSequence(bRetainListSequence: boolean): sap.m.FacetFilterList;
/**
* Used to pre-select FacetFilterItems, such as when restoring FacetFilterList selections from a variant.
* Keys are cached separately from the actual FacetFilterItems so that they remain even when the physical items are removed by filtering or sorting.
* If aKeys is undefined
, null
, or {} (empty object) then all keys are deleted.
* After this method completes, only those items with matching keys will be selected. All other items in the list will be deselected.
* @param {any} oAKeys - Associative array indicating which FacetFilterItems should be selected in the list. Each property must be set to the value of a FacetFilterItem.key property. Each property value should be set to the FacetFilterItem.text property value. The text value is used to display the FacetFilterItem text when the FacetFilterList button or FacetFilter summary bar is displayed. If no property value is set then the property key is used for the text.
*/
public setSelectedKeys(oAKeys: any): void;
/**
* Sets a new value for property {@link #getSequence sequence}.
*
* Sequence that determines the order in which FacetFilterList is shown on the FacetFilter. Lists are rendered by ascending order of sequence.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {number} iSequence - New value for property sequence
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setSequence(iSequence: number): sap.m.FacetFilterList;
/**
* Sets a new value for property {@link #getShowRemoveFacetIcon showRemoveFacetIcon}.
*
* Specifies whether remove icon for facet is visible or hidden.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowRemoveFacetIcon - New value for property showRemoveFacetIcon
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setShowRemoveFacetIcon(bShowRemoveFacetIcon: boolean): sap.m.FacetFilterList;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Defines the title of the facet. The facet title is displayed on the facet button when the FacetFilter type is set to Simple
. It is also displayed as a list item in the facet page of the dialog.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.FacetFilterList;
/**
* Sets a new value for property {@link #getWordWrap wordWrap}.
*
* If set to true
, the item text wraps when it is too long.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bWordWrap - New value for property wordWrap
* @returns {sap.m.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setWordWrap(bWordWrap: boolean): sap.m.FacetFilterList;
}
/**
* FacetFilterList data types.
*/
export enum FacetFilterListDataType {
/**
* >An input control for specifying a Boolean value
*/
Boolean = "Boolean",
/**
* An input control for specifying a date value. The user can select a month, day of the month, and year.
*/
Date = "Date",
/**
* An input control for specifying a date and time value. The user can select a month, day of the month, year, and time of day.
*/
DateTime = "DateTime",
/**
* >An input control for specifying a Float value
*/
Float = "Float",
/**
* >An input control for specifying an Integer value
*/
Integer = "Integer",
/**
* >An input control for specifying a String value
*/
String = "String",
/**
* An input control for specifying a time value. The user can select the hour, minute, and optionally AM or PM.
*/
Time = "Time",
}
/**
* Used by the FacetFilter control to adapt its design according to type.
*/
export enum FacetFilterType {
/**
* Forces FacetFilter to display in light mode.
*/
Light = "Light",
/**
* Forces FacetFilter to display facet lists as a row of buttons, one button per facet. The FacetFilter will automatically adapt to the Light type when it detects smart phone sized displays.
*/
Simple = "Simple",
}
/**
* Displays a tile containing the text of the feed, a subheader, and a numeric value.
*/
export class FeedContent extends sap.ui.core.Control {
/**
* Constructor for a new sap.m.FeedContent control.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.FeedContent
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FeedContent
itself.
*
* The event is triggered when the feed content is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FeedContent
itself
* @returns {sap.m.FeedContent} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.FeedContent;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.FeedContent
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FeedContent
itself.
*
* The event is triggered when the feed content is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FeedContent
itself
* @returns {sap.m.FeedContent} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.FeedContent;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.FeedContent
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.FeedContent} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.FeedContent;
/**
* Creates a new subclass of class sap.m.FeedContent with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.FeedContent} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.FeedContent;
/**
* Gets current value of property {@link #getContentText contentText}.
*
* The content text.
* @returns {string} Value of property contentText
*/
public getContentText(): string;
/**
* Returns a metadata object for class sap.m.FeedContent.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSize size}.
*
* Updates the size of the chart. If not set then the default size is applied based on the device tile.
*
* Default value is Auto
.
* @returns {sap.m.Size} Value of property size
*/
public getSize(): sap.m.Size;
/**
* Gets current value of property {@link #getSubheader subheader}.
*
* The subheader.
* @returns {string} Value of property subheader
*/
public getSubheader(): string;
/**
* Gets current value of property {@link #getTruncateValueTo truncateValueTo}.
*
* The number of characters to display for the value property.
*
* Default value is 4
.
* @returns {number} Value of property truncateValueTo
*/
public getTruncateValueTo(): number;
/**
* Gets current value of property {@link #getValue value}.
*
* The actual value.
* @returns {string} Value of property value
*/
public getValue(): string;
/**
* Gets current value of property {@link #getValueColor valueColor}.
*
* The semantic color of the value.
* @returns {sap.m.ValueColor} Value of property valueColor
*/
public getValueColor(): sap.m.ValueColor;
/**
* Sets a new value for property {@link #getContentText contentText}.
*
* The content text.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sContentText - New value for property contentText
* @returns {sap.m.FeedContent} Reference to this
in order to allow method chaining
*/
public setContentText(sContentText: string): sap.m.FeedContent;
/**
* Sets a new value for property {@link #getSize size}.
*
* Updates the size of the chart. If not set then the default size is applied based on the device tile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.m.Size} sSize - New value for property size
* @returns {sap.m.FeedContent} Reference to this
in order to allow method chaining
*/
public setSize(sSize: sap.m.Size): sap.m.FeedContent;
/**
* Sets a new value for property {@link #getSubheader subheader}.
*
* The subheader.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sSubheader - New value for property subheader
* @returns {sap.m.FeedContent} Reference to this
in order to allow method chaining
*/
public setSubheader(sSubheader: string): sap.m.FeedContent;
/**
* Sets a new value for property {@link #getTruncateValueTo truncateValueTo}.
*
* The number of characters to display for the value property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 4
.
* @param {number} iTruncateValueTo - New value for property truncateValueTo
* @returns {sap.m.FeedContent} Reference to this
in order to allow method chaining
*/
public setTruncateValueTo(iTruncateValueTo: number): sap.m.FeedContent;
/**
* Sets a new value for property {@link #getValue value}.
*
* The actual value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sValue - New value for property value
* @returns {sap.m.FeedContent} Reference to this
in order to allow method chaining
*/
public setValue(sValue: string): sap.m.FeedContent;
/**
* Sets a new value for property {@link #getValueColor valueColor}.
*
* The semantic color of the value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.m.ValueColor} sValueColor - New value for property valueColor
* @returns {sap.m.FeedContent} Reference to this
in order to allow method chaining
*/
public setValueColor(sValueColor: sap.m.ValueColor): sap.m.FeedContent;
}
/**
* The Feed Input allows the user to enter text for a new feed entry and then post it.
*/
export class FeedInput extends sap.ui.core.Control {
/**
* Constructor for a new FeedInput.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:post post} event of this sap.m.FeedInput
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FeedInput
itself.
*
* The Post event is triggered when the user has entered a value and pressed the post button. After firing this event, the value is reset.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FeedInput
itself
* @returns {sap.m.FeedInput} Reference to this
in order to allow method chaining
*/
public attachPost(fnFunction: Function, oListener?: any): sap.m.FeedInput;
/**
* Attaches event handler fnFunction
to the {@link #event:post post} event of this sap.m.FeedInput
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FeedInput
itself.
*
* The Post event is triggered when the user has entered a value and pressed the post button. After firing this event, the value is reset.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FeedInput
itself
* @returns {sap.m.FeedInput} Reference to this
in order to allow method chaining
*/
public attachPost(oData: any, fnFunction: Function, oListener?: any): sap.m.FeedInput;
/**
* Detaches event handler fnFunction
from the {@link #event:post post} event of this sap.m.FeedInput
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.FeedInput} Reference to this
in order to allow method chaining
*/
public detachPost(fnFunction: Function, oListener: any): sap.m.FeedInput;
/**
* Creates a new subclass of class sap.m.FeedInput with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:post post} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.FeedInput} Reference to this
in order to allow method chaining
*/
protected firePost(mParameters?: any): sap.m.FeedInput;
/**
* Gets current value of property {@link #getAriaLabelForPicture ariaLabelForPicture}.
*
* Text for Picture which will be read by screenreader.
* If a new ariaLabelForPicture is set, any previously set ariaLabelForPicture is deactivated.
* @returns {string} Value of property ariaLabelForPicture
*/
public getAriaLabelForPicture(): string;
/**
* Gets current value of property {@link #getButtonTooltip buttonTooltip}.
*
* Sets a new tooltip for Submit button. The tooltip can either be a simple string (which in most cases will be rendered as the title attribute of this element)
* or an instance of sap.ui.core.TooltipBase.
* If a new tooltip is set, any previously set tooltip is deactivated.
* The default value is set language dependent.
*
* Default value is Submit
.
* @returns {sap.ui.core.TooltipBase} Value of property buttonTooltip
*/
public getButtonTooltip(): sap.ui.core.TooltipBase;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Set this flag to "false" to disable both text input and post button.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Icon to be displayed as a graphical element within the feed input. This can be an image or an icon from the icon font.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconDensityAware iconDensityAware}.
*
* Some mobile devices support higher resolution images while others do not. Therefore, you should provide image resources for all relevant densities.
* If the property is set to "true", one or more requests are sent to the server to try and get the perfect density version of an image. If an image of a certain density is not available, the image control falls back to the default image, which should be provided.
*
* If you do not have higher resolution images, you should set the property to "false" to avoid unnecessary round-trips.
*
* Please be aware that this property is relevant only for images and not for icons.
*
* Default value is true
.
* @returns {boolean} Value of property iconDensityAware
*/
public getIconDensityAware(): boolean;
/**
* Gets current value of property {@link #getMaxLength maxLength}.
*
* The maximum length (the maximum number of characters) for the feed input's value. By default this is not limited.
*
* Default value is 0
.
* @returns {number} Value of property maxLength
*/
public getMaxLength(): number;
/**
* Returns a metadata object for class sap.m.FeedInput.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPlaceholder placeholder}.
*
* The placeholder text shown in the input area as long as the user has not entered any text value.
*
* Default value is Post something here
.
* @returns {string} Value of property placeholder
*/
public getPlaceholder(): string;
/**
* Gets current value of property {@link #getShowIcon showIcon}.
*
* If set to "true" (default), icons will be displayed. In case no icon is provided the standard placeholder will be displayed. if set to "false" icons are hidden
*
* Default value is true
.
* @returns {boolean} Value of property showIcon
*/
public getShowIcon(): boolean;
/**
* Gets current value of property {@link #getValue value}.
*
* The text value of the feed input. As long as the user has not entered any text the post button is disabled
* @returns {string} Value of property value
*/
public getValue(): string;
/**
* Sets a new value for property {@link #getAriaLabelForPicture ariaLabelForPicture}.
*
* Text for Picture which will be read by screenreader.
* If a new ariaLabelForPicture is set, any previously set ariaLabelForPicture is deactivated.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAriaLabelForPicture - New value for property ariaLabelForPicture
* @returns {sap.m.FeedInput} Reference to this
in order to allow method chaining
*/
public setAriaLabelForPicture(sAriaLabelForPicture: string): sap.m.FeedInput;
/**
* Sets a new value for property {@link #getButtonTooltip buttonTooltip}.
*
* Sets a new tooltip for Submit button. The tooltip can either be a simple string (which in most cases will be rendered as the title attribute of this element)
* or an instance of sap.ui.core.TooltipBase.
* If a new tooltip is set, any previously set tooltip is deactivated.
* The default value is set language dependent.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Submit
.
* @param {sap.ui.core.TooltipBase} sButtonTooltip - New value for property buttonTooltip
* @returns {sap.m.FeedInput} Reference to this
in order to allow method chaining
*/
public setButtonTooltip(sButtonTooltip: sap.ui.core.TooltipBase): sap.m.FeedInput;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Set this flag to "false" to disable both text input and post button.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.FeedInput} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.FeedInput;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Icon to be displayed as a graphical element within the feed input. This can be an image or an icon from the icon font.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.FeedInput} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.FeedInput;
/**
* Sets a new value for property {@link #getIconDensityAware iconDensityAware}.
*
* Some mobile devices support higher resolution images while others do not. Therefore, you should provide image resources for all relevant densities.
* If the property is set to "true", one or more requests are sent to the server to try and get the perfect density version of an image. If an image of a certain density is not available, the image control falls back to the default image, which should be provided.
*
* If you do not have higher resolution images, you should set the property to "false" to avoid unnecessary round-trips.
*
* Please be aware that this property is relevant only for images and not for icons.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconDensityAware - New value for property iconDensityAware
* @returns {sap.m.FeedInput} Reference to this
in order to allow method chaining
*/
public setIconDensityAware(bIconDensityAware: boolean): sap.m.FeedInput;
/**
* Sets a new value for property {@link #getMaxLength maxLength}.
*
* The maximum length (the maximum number of characters) for the feed input's value. By default this is not limited.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iMaxLength - New value for property maxLength
* @returns {sap.m.FeedInput} Reference to this
in order to allow method chaining
*/
public setMaxLength(iMaxLength: number): sap.m.FeedInput;
/**
* Sets a new value for property {@link #getPlaceholder placeholder}.
*
* The placeholder text shown in the input area as long as the user has not entered any text value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Post something here
.
* @param {string} sPlaceholder - New value for property placeholder
* @returns {sap.m.FeedInput} Reference to this
in order to allow method chaining
*/
public setPlaceholder(sPlaceholder: string): sap.m.FeedInput;
/**
* Sets a new value for property {@link #getShowIcon showIcon}.
*
* If set to "true" (default), icons will be displayed. In case no icon is provided the standard placeholder will be displayed. if set to "false" icons are hidden
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowIcon - New value for property showIcon
* @returns {sap.m.FeedInput} Reference to this
in order to allow method chaining
*/
public setShowIcon(bShowIcon: boolean): sap.m.FeedInput;
/**
* Sets a new value for property {@link #getValue value}.
*
* The text value of the feed input. As long as the user has not entered any text the post button is disabled
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sValue - New value for property value
* @returns {sap.m.FeedInput} Reference to this
in order to allow method chaining
*/
public setValue(sValue: string): sap.m.FeedInput;
}
/**
* The control provides a set of properties for text, sender information, time stamp.
* Beginning with release 1.23 the new feature expand / collapse was introduced, which uses the property maxCharacters.
* Beginning with release 1.44, sap.m.FormattedText was introduced which allows html formatted text to be displayed
*/
export class FeedListItem extends sap.m.ListItemBase {
/**
* Constructor for a new FeedListItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:iconPress iconPress} event of this sap.m.FeedListItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FeedListItem
itself.
*
* Event is fired when the icon is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FeedListItem
itself
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public attachIconPress(fnFunction: Function, oListener?: any): sap.m.FeedListItem;
/**
* Attaches event handler fnFunction
to the {@link #event:iconPress iconPress} event of this sap.m.FeedListItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FeedListItem
itself.
*
* Event is fired when the icon is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FeedListItem
itself
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public attachIconPress(oData: any, fnFunction: Function, oListener?: any): sap.m.FeedListItem;
/**
* Attaches event handler fnFunction
to the {@link #event:senderPress senderPress} event of this sap.m.FeedListItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FeedListItem
itself.
*
* Event is fired when name of the sender is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FeedListItem
itself
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public attachSenderPress(fnFunction: Function, oListener?: any): sap.m.FeedListItem;
/**
* Attaches event handler fnFunction
to the {@link #event:senderPress senderPress} event of this sap.m.FeedListItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.FeedListItem
itself.
*
* Event is fired when name of the sender is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.FeedListItem
itself
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public attachSenderPress(oData: any, fnFunction: Function, oListener?: any): sap.m.FeedListItem;
/**
* Detaches event handler fnFunction
from the {@link #event:iconPress iconPress} event of this sap.m.FeedListItem
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public detachIconPress(fnFunction: Function, oListener: any): sap.m.FeedListItem;
/**
* Detaches event handler fnFunction
from the {@link #event:senderPress senderPress} event of this sap.m.FeedListItem
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public detachSenderPress(fnFunction: Function, oListener: any): sap.m.FeedListItem;
/**
* Creates a new subclass of class sap.m.FeedListItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ListItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:iconPress iconPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
protected fireIconPress(mParameters?: any): sap.m.FeedListItem;
/**
* Fires event {@link #event:senderPress senderPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
protected fireSenderPress(mParameters?: any): sap.m.FeedListItem;
/**
* Gets current value of property {@link #getActiveIcon activeIcon}.
*
* Icon displayed when the list item is active.
* @returns {sap.ui.core.URI} Value of property activeIcon
*/
public getActiveIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getConvertedLinksDefaultTarget convertedLinksDefaultTarget}.
*
* Determines the target attribute of the generated HTML anchor tags. Note: Applicable only if ConvertLinksToAnchorTags property is used with a value other than sap.m.LinkConversion.None. Options are the standard values for the target attribute of the HTML anchor tag: _self, _top, _blank, _parent, _search.
*
* Default value is _blank
.
* @returns {string} Value of property convertedLinksDefaultTarget
*/
public getConvertedLinksDefaultTarget(): string;
/**
* Gets current value of property {@link #getConvertLinksToAnchorTags convertLinksToAnchorTags}.
*
* Determines whether strings that appear to be links will be converted to HTML anchor tags, and what are the criteria for recognizing them.
*
* Default value is None
.
* @returns {sap.m.LinkConversion} Value of property convertLinksToAnchorTags
*/
public getConvertLinksToAnchorTags(): sap.m.LinkConversion;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Icon to be displayed as graphical element within the FeedListItem. This can be an image or an icon from the icon font. If no icon is provided, a default person-placeholder icon is displayed.
* Icon is only shown if showIcon = true.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconActive iconActive}.
*
* If true, icon is a link, which will fire 'iconPress' events. If false, icon is normal image
*
* Default value is true
.
* @returns {boolean} Value of property iconActive
*/
public getIconActive(): boolean;
/**
* Gets current value of property {@link #getIconDensityAware iconDensityAware}.
*
* By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
*
* If bandwidth is the key for the application, set this value to false.
*
* Default value is true
.
* @returns {boolean} Value of property iconDensityAware
*/
public getIconDensityAware(): boolean;
/**
* Gets current value of property {@link #getInfo info}.
*
* The Info text.
* @returns {string} Value of property info
*/
public getInfo(): string;
/**
* Gets current value of property {@link #getMaxCharacters maxCharacters}.
*
* The expand and collapse feature is set by default and uses 300 characters on mobile devices and 500 characters on desktops as limits. Based on these values, the text of the FeedListItem is collapsed once text reaches these limits. In this case, only the specified number of characters is displayed. By clicking on the text link More, the entire text can be displayed. The text link Less collapses the text. The application is able to set the value to its needs.
* @returns {number} Value of property maxCharacters
*/
public getMaxCharacters(): number;
/**
* Returns a metadata object for class sap.m.FeedListItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSender sender}.
*
* Sender of the chunk
* @returns {string} Value of property sender
*/
public getSender(): string;
/**
* Gets current value of property {@link #getSenderActive senderActive}.
*
* If true, sender string is a link, which will fire 'senderPress' events. If false, sender is normal text.
*
* Default value is true
.
* @returns {boolean} Value of property senderActive
*/
public getSenderActive(): boolean;
/**
* Gets current value of property {@link #getShowIcon showIcon}.
*
* If set to "true" (default), icons will be displayed, if set to false icons are hidden
*
* Default value is true
.
* @returns {boolean} Value of property showIcon
*/
public getShowIcon(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* The FeedListItem text. It supports html formatted tags as described in the documentation of sap.m.FormattedText
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTimestamp timestamp}.
*
* This chunks timestamp
* @returns {string} Value of property timestamp
*/
public getTimestamp(): string;
/**
* Sets a new value for property {@link #getActiveIcon activeIcon}.
*
* Icon displayed when the list item is active.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sActiveIcon - New value for property activeIcon
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public setActiveIcon(sActiveIcon: sap.ui.core.URI): sap.m.FeedListItem;
/**
* Sets a new value for property {@link #getConvertedLinksDefaultTarget convertedLinksDefaultTarget}.
*
* Determines the target attribute of the generated HTML anchor tags. Note: Applicable only if ConvertLinksToAnchorTags property is used with a value other than sap.m.LinkConversion.None. Options are the standard values for the target attribute of the HTML anchor tag: _self, _top, _blank, _parent, _search.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is _blank
.
* @param {string} sConvertedLinksDefaultTarget - New value for property convertedLinksDefaultTarget
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public setConvertedLinksDefaultTarget(sConvertedLinksDefaultTarget: string): sap.m.FeedListItem;
/**
* Sets a new value for property {@link #getConvertLinksToAnchorTags convertLinksToAnchorTags}.
*
* Determines whether strings that appear to be links will be converted to HTML anchor tags, and what are the criteria for recognizing them.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.m.LinkConversion} sConvertLinksToAnchorTags - New value for property convertLinksToAnchorTags
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public setConvertLinksToAnchorTags(sConvertLinksToAnchorTags: sap.m.LinkConversion): sap.m.FeedListItem;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Icon to be displayed as graphical element within the FeedListItem. This can be an image or an icon from the icon font. If no icon is provided, a default person-placeholder icon is displayed.
* Icon is only shown if showIcon = true.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.FeedListItem;
/**
* Sets a new value for property {@link #getIconActive iconActive}.
*
* If true, icon is a link, which will fire 'iconPress' events. If false, icon is normal image
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconActive - New value for property iconActive
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public setIconActive(bIconActive: boolean): sap.m.FeedListItem;
/**
* Sets a new value for property {@link #getIconDensityAware iconDensityAware}.
*
* By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
*
* If bandwidth is the key for the application, set this value to false.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconDensityAware - New value for property iconDensityAware
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public setIconDensityAware(bIconDensityAware: boolean): sap.m.FeedListItem;
/**
* Sets a new value for property {@link #getInfo info}.
*
* The Info text.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sInfo - New value for property info
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public setInfo(sInfo: string): sap.m.FeedListItem;
/**
* Sets a new value for property {@link #getMaxCharacters maxCharacters}.
*
* The expand and collapse feature is set by default and uses 300 characters on mobile devices and 500 characters on desktops as limits. Based on these values, the text of the FeedListItem is collapsed once text reaches these limits. In this case, only the specified number of characters is displayed. By clicking on the text link More, the entire text can be displayed. The text link Less collapses the text. The application is able to set the value to its needs.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iMaxCharacters - New value for property maxCharacters
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public setMaxCharacters(iMaxCharacters: number): sap.m.FeedListItem;
/**
* Sets a new value for property {@link #getSender sender}.
*
* Sender of the chunk
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sSender - New value for property sender
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public setSender(sSender: string): sap.m.FeedListItem;
/**
* Sets a new value for property {@link #getSenderActive senderActive}.
*
* If true, sender string is a link, which will fire 'senderPress' events. If false, sender is normal text.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bSenderActive - New value for property senderActive
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public setSenderActive(bSenderActive: boolean): sap.m.FeedListItem;
/**
* Sets a new value for property {@link #getShowIcon showIcon}.
*
* If set to "true" (default), icons will be displayed, if set to false icons are hidden
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowIcon - New value for property showIcon
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public setShowIcon(bShowIcon: boolean): sap.m.FeedListItem;
/**
* Sets a new value for property {@link #getText text}.
*
* The FeedListItem text. It supports html formatted tags as described in the documentation of sap.m.FormattedText
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.FeedListItem;
/**
* Sets a new value for property {@link #getTimestamp timestamp}.
*
* This chunks timestamp
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTimestamp - New value for property timestamp
* @returns {sap.m.FeedListItem} Reference to this
in order to allow method chaining
*/
public setTimestamp(sTimestamp: string): sap.m.FeedListItem;
/**
* Redefinition of sap.m.ListItemBase.setType: type = "sap.m.ListType.Navigation" behaves like type = "sap.m.ListType.Active" for a FeedListItem
* @param {sap.m.ListType} type - new value for property type
* @returns {sap.m.FeedListItem} this allows method chaining
*/
public setType(type: sap.m.ListType): sap.m.FeedListItem;
/**
* Redefinition of sap.m.ListItemBase.setUnread: Unread is not supported for FeedListItem
* @param {boolean} value - new value for property unread is ignored
* @returns {sap.m.FeedListItem} this allows method chaining
*/
public setUnread(value: boolean): sap.m.FeedListItem;
}
/**
* Available options for the layout of container lines along the cross axis of the flexbox layout. Note: This property has no effect in Internet Explorer 10.
*/
export enum FlexAlignContent {
/**
* Line are packed toward the center of the line.
*/
Center = "Center",
/**
* Lines are packed toward the end of the line.
*/
End = "End",
/**
* Inherits the value from its parent.
*/
Inherit = "Inherit",
/**
* Lines are evenly distributed in the line, with half-size spaces on either end.
* Note: This value behaves like SpaceBetween in Internet Explorer 10.
*/
SpaceAround = "SpaceAround",
/**
* Lines are evenly distributed in the line.
*/
SpaceBetween = "SpaceBetween",
/**
* Lines are packed toward the start of the line.
*/
Start = "Start",
/**
* Lines stretch to take up the remaining space.
*/
Stretch = "Stretch",
}
/**
* Available options for the layout of all elements along the cross axis of the flexbox layout.
*/
export enum FlexAlignItems {
/**
* If the flex item's inline axes are the same as the cross axis, this value is identical to "Start". Otherwise, it participates in baseline alignment: all participating box items on the line are aligned such that their baselines align, and the item with the largest distance between its baseline and its cross-start margin edge is placed flush against the cross-start edge of the line.
*/
Baseline = "Baseline",
/**
* The flex item's margin boxes are centered in the cross axis within the line.
*/
Center = "Center",
/**
* The cross-start margin edges of the flex items are placed flush with the cross-end edge of the line.
*/
End = "End",
/**
* Inherits the value from its parent.
*/
Inherit = "Inherit",
/**
* The cross-start margin edges of the flex items are placed flush with the cross-start edge of the line.
*/
Start = "Start",
/**
* Make the cross size of the item's margin boxes as close to the same size as the line as possible.
*/
Stretch = "Stretch",
}
/**
* Available options for the layout of individual elements along the cross axis of the flexbox layout overriding the default alignment.
*/
export enum FlexAlignSelf {
/**
* Takes up the value of alignItems from the parent FlexBox
*/
Auto = "Auto",
/**
* If the flex item's inline axis is the same as the cross axis, this value is identical to "Start". Otherwise, it participates in baseline alignment: all participating box items on the line are aligned such that their baselines align, and the item with the largest distance between its baseline and its cross-start margin edge is placed flush against the cross-start edge of the line.
*/
Baseline = "Baseline",
/**
* The flex item's margin box is centered in the cross axis within the line.
*/
Center = "Center",
/**
* The cross-start margin edges of the flex item is placed flush with the cross-end edge of the line.
*/
End = "End",
/**
* Inherits the value from its parent.
*/
Inherit = "Inherit",
/**
* The cross-start margin edges of the flex item is placed flush with the cross-start edge of the line.
*/
Start = "Start",
/**
* Make the cross size of the item's margin box as close to the same size as the line as possible.
*/
Stretch = "Stretch",
}
/**
* The sap.m.FlexBox
control builds the container for a flexible box layout.renderType
setting to avoid issues due to browser inconsistencies.
*/
export class FlexBox extends sap.ui.core.Control {
/**
* Constructor for a new sap.m.FlexBox
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.ui.core.Control} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.FlexBox} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.ui.core.Control): sap.m.FlexBox;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.FlexBox} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.FlexBox;
/**
* Creates a new subclass of class sap.m.FlexBox with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getAlignContent alignContent}.
*
* Determines the layout behavior of container lines when there's extra space along the cross-axis. This property has no effect in Internet Explorer 10.
*
* Default value is Stretch
.
* @returns {sap.m.FlexAlignContent} Value of property alignContent
*/
public getAlignContent(): sap.m.FlexAlignContent;
/**
* Gets current value of property {@link #getAlignItems alignItems}.
*
* Determines the layout behavior of items along the cross-axis. "Baseline" is not supported in Internet Explorer 10.
*
* Default value is Stretch
.
* @returns {sap.m.FlexAlignItems} Value of property alignItems
*/
public getAlignItems(): sap.m.FlexAlignItems;
/**
* Gets current value of property {@link #getBackgroundDesign backgroundDesign}.
*
* Defines the background style of the sap.m.FlexBox
.
*
* Default value is Transparent
.
* @returns {sap.m.BackgroundDesign} Value of property backgroundDesign
*/
public getBackgroundDesign(): sap.m.BackgroundDesign;
/**
* Gets current value of property {@link #getDirection direction}.
*
* Determines the direction of the layout of child elements.
*
* Default value is Row
.
* @returns {sap.m.FlexDirection} Value of property direction
*/
public getDirection(): sap.m.FlexDirection;
/**
* Gets current value of property {@link #getDisplayInline displayInline}.
*
* Determines whether the sap.m.FlexBox
is in block or inline mode.
*
* Default value is false
.
* @returns {boolean} Value of property displayInline
*/
public getDisplayInline(): boolean;
/**
* Gets current value of property {@link #getFitContainer fitContainer}.
*
* Determines whether the sap.m.FlexBox
will be sized to completely fill its container. If the sap.m.FlexBox
is inserted into a Page, the property 'enableScrolling' of the Page needs to be set to 'false' for the FlexBox to fit the entire viewport.
*
* Default value is false
.
* @returns {boolean} Value of property fitContainer
*/
public getFitContainer(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* The height of the sap.m.FlexBox
. Note that when a percentage is given, for the height to work as expected, the height of the surrounding container must be defined.
*
* Default value is
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Flex items within the flexible box layout
* @returns {sap.ui.core.Control[]}
*/
public getItems(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getJustifyContent justifyContent}.
*
* Determines the layout behavior along the main axis.
*
* Default value is Start
.
* @returns {sap.m.FlexJustifyContent} Value of property justifyContent
*/
public getJustifyContent(): sap.m.FlexJustifyContent;
/**
* Returns a metadata object for class sap.m.FlexBox.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRenderType renderType}.
*
* Determines whether the layout is rendered as a series of divs or as an unordered list (ul).Bare
in most cases to avoid layout issues due to browser inconsistencies.
*
* Default value is Div
.
* @returns {sap.m.FlexRendertype} Value of property renderType
*/
public getRenderType(): sap.m.FlexRendertype;
/**
* Gets current value of property {@link #getWidth width}.
*
* The width of the sap.m.FlexBox
. Note that when a percentage is given, for the width to work as expected, the width of the surrounding container must be defined.
*
* Default value is
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getWrap wrap}.
*
* Determines the wrapping behavior of the flex container. This property has no effect in older browsers, e.g. Android Native 4.3 and below.
*
* Default value is NoWrap
.
* @returns {sap.m.FlexWrap} Value of property wrap
*/
public getWrap(): sap.m.FlexWrap;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.core.Control): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.ui.core.Control} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.FlexBox} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.ui.core.Control, iIndex: number): sap.m.FlexBox;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.ui.core.Control[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.ui.core.Control} vItem - The item to remove or its index or id
* @returns {sap.ui.core.Control} The removed item or null
*/
public removeItem(vItem: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getAlignContent alignContent}.
*
* Determines the layout behavior of container lines when there's extra space along the cross-axis. This property has no effect in Internet Explorer 10.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Stretch
.
* @param {sap.m.FlexAlignContent} sAlignContent - New value for property alignContent
* @returns {sap.m.FlexBox} Reference to this
in order to allow method chaining
*/
public setAlignContent(sAlignContent: sap.m.FlexAlignContent): sap.m.FlexBox;
/**
* Sets a new value for property {@link #getAlignItems alignItems}.
*
* Determines the layout behavior of items along the cross-axis. "Baseline" is not supported in Internet Explorer 10.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Stretch
.
* @param {sap.m.FlexAlignItems} sAlignItems - New value for property alignItems
* @returns {sap.m.FlexBox} Reference to this
in order to allow method chaining
*/
public setAlignItems(sAlignItems: sap.m.FlexAlignItems): sap.m.FlexBox;
/**
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
*
* Defines the background style of the sap.m.FlexBox
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Transparent
.
* @param {sap.m.BackgroundDesign} sBackgroundDesign - New value for property backgroundDesign
* @returns {sap.m.FlexBox} Reference to this
in order to allow method chaining
*/
public setBackgroundDesign(sBackgroundDesign: sap.m.BackgroundDesign): sap.m.FlexBox;
/**
* Sets a new value for property {@link #getDirection direction}.
*
* Determines the direction of the layout of child elements.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Row
.
* @param {sap.m.FlexDirection} sDirection - New value for property direction
* @returns {sap.m.FlexBox} Reference to this
in order to allow method chaining
*/
public setDirection(sDirection: sap.m.FlexDirection): sap.m.FlexBox;
/**
* Sets a new value for property {@link #getDisplayInline displayInline}.
*
* Determines whether the sap.m.FlexBox
is in block or inline mode.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bDisplayInline - New value for property displayInline
* @returns {sap.m.FlexBox} Reference to this
in order to allow method chaining
*/
public setDisplayInline(bDisplayInline: boolean): sap.m.FlexBox;
/**
* Sets a new value for property {@link #getFitContainer fitContainer}.
*
* Determines whether the sap.m.FlexBox
will be sized to completely fill its container. If the sap.m.FlexBox
is inserted into a Page, the property 'enableScrolling' of the Page needs to be set to 'false' for the FlexBox to fit the entire viewport.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bFitContainer - New value for property fitContainer
* @returns {sap.m.FlexBox} Reference to this
in order to allow method chaining
*/
public setFitContainer(bFitContainer: boolean): sap.m.FlexBox;
/**
* Sets a new value for property {@link #getHeight height}.
*
* The height of the sap.m.FlexBox
. Note that when a percentage is given, for the height to work as expected, the height of the surrounding container must be defined.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.m.FlexBox} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.m.FlexBox;
/**
* Sets a new value for property {@link #getJustifyContent justifyContent}.
*
* Determines the layout behavior along the main axis.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Start
.
* @param {sap.m.FlexJustifyContent} sJustifyContent - New value for property justifyContent
* @returns {sap.m.FlexBox} Reference to this
in order to allow method chaining
*/
public setJustifyContent(sJustifyContent: sap.m.FlexJustifyContent): sap.m.FlexBox;
/**
* Sets a new value for property {@link #getRenderType renderType}.
*
* Determines whether the layout is rendered as a series of divs or as an unordered list (ul).Bare
in most cases to avoid layout issues due to browser inconsistencies.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Div
.
* @param {sap.m.FlexRendertype} sRenderType - New value for property renderType
* @returns {sap.m.FlexBox} Reference to this
in order to allow method chaining
*/
public setRenderType(sRenderType: sap.m.FlexRendertype): sap.m.FlexBox;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The width of the sap.m.FlexBox
. Note that when a percentage is given, for the width to work as expected, the width of the surrounding container must be defined.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.FlexBox} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.FlexBox;
/**
* Sets a new value for property {@link #getWrap wrap}.
*
* Determines the wrapping behavior of the flex container. This property has no effect in older browsers, e.g. Android Native 4.3 and below.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is NoWrap
.
* @param {sap.m.FlexWrap} sWrap - New value for property wrap
* @returns {sap.m.FlexBox} Reference to this
in order to allow method chaining
*/
public setWrap(sWrap: sap.m.FlexWrap): sap.m.FlexBox;
}
/**
* Available directions for flex layouts.
*/
export enum FlexDirection {
/**
* Flex items are laid out along the direction of the block axis (usually top to bottom).
*/
Column = "Column",
/**
* Flex items are laid out along the reverse direction of the block axis (usually bottom to top).
*/
ColumnReverse = "ColumnReverse",
/**
* Inherits the value from its parent.
*/
Inherit = "Inherit",
/**
* Flex items are laid out along the direction of the inline axis (text direction).
*/
Row = "Row",
/**
* Flex items are laid out along the reverse direction of the inline axis (against the text direction).
*/
RowReverse = "RowReverse",
}
/**
* Holds layout data for a FlexBox|HBox|VBox
*/
export class FlexItemData extends sap.ui.core.LayoutData {
/**
* Constructor for a new sap.m.FlexItemData
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new element, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new element
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.FlexItemData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.LayoutData.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAlignSelf alignSelf}.
*
* Determines cross-axis alignment of individual element (not currently supported in Internet Explorer)
*
* Default value is Auto
.
* @returns {sap.m.FlexAlignSelf} Value of property alignSelf
*/
public getAlignSelf(): sap.m.FlexAlignSelf;
/**
* Gets current value of property {@link #getBackgroundDesign backgroundDesign}.
*
* Defines the background style of the flex item.
*
* Default value is Transparent
.
* @returns {sap.m.BackgroundDesign} Value of property backgroundDesign
*/
public getBackgroundDesign(): sap.m.BackgroundDesign;
/**
* Gets current value of property {@link #getBaseSize baseSize}.
*
* The base size is the initial main size of the item for the flex algorithm. If set to "auto", this will be the computed size of the item.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property baseSize
*/
public getBaseSize(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getGrowFactor growFactor}.
*
* Determines the flexibility of the flex item when allocatable space is remaining.
*
* Default value is 0
.
* @returns {number} Value of property growFactor
*/
public getGrowFactor(): number;
/**
* Gets current value of property {@link #getMaxHeight maxHeight}.
*
* The maximum height of the flex item.
*
* Default value is
.
* @returns {sap.ui.core.CSSSize} Value of property maxHeight
*/
public getMaxHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getMaxWidth maxWidth}.
*
* The maximum height of the flex item.
*
* Default value is
.
* @returns {sap.ui.core.CSSSize} Value of property maxWidth
*/
public getMaxWidth(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.m.FlexItemData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinHeight minHeight}.
*
* The minimum height of the flex item.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property minHeight
*/
public getMinHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getMinWidth minWidth}.
*
* The minimum height of the flex item.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property minWidth
*/
public getMinWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getOrder order}.
*
* Determines the display order of flex items independent of their source code order.
*
* Default value is 0
.
* @returns {number} Value of property order
*/
public getOrder(): number;
/**
* Gets current value of property {@link #getShrinkFactor shrinkFactor}.
*
* The shrink factor determines how much the flex item will shrink relative to the rest of the flex items in the flex container when negative free space is distributed.
*
* Default value is 1
.
* @returns {number} Value of property shrinkFactor
*/
public getShrinkFactor(): number;
/**
* Gets current value of property {@link #getStyleClass styleClass}.
*
* The style class will be applied to the flex item and can be used for CSS selectors
*
* Default value is
.
* @returns {string} Value of property styleClass
*/
public getStyleClass(): string;
/**
* Sets a new value for property {@link #getAlignSelf alignSelf}.
*
* Determines cross-axis alignment of individual element (not currently supported in Internet Explorer)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.m.FlexAlignSelf} sAlignSelf - New value for property alignSelf
* @returns {sap.m.FlexItemData} Reference to this
in order to allow method chaining
*/
public setAlignSelf(sAlignSelf: sap.m.FlexAlignSelf): sap.m.FlexItemData;
/**
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
*
* Defines the background style of the flex item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Transparent
.
* @param {sap.m.BackgroundDesign} sBackgroundDesign - New value for property backgroundDesign
* @returns {sap.m.FlexItemData} Reference to this
in order to allow method chaining
*/
public setBackgroundDesign(sBackgroundDesign: sap.m.BackgroundDesign): sap.m.FlexItemData;
/**
* Sets a new value for property {@link #getBaseSize baseSize}.
*
* The base size is the initial main size of the item for the flex algorithm. If set to "auto", this will be the computed size of the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.core.CSSSize} sBaseSize - New value for property baseSize
* @returns {sap.m.FlexItemData} Reference to this
in order to allow method chaining
*/
public setBaseSize(sBaseSize: sap.ui.core.CSSSize): sap.m.FlexItemData;
/**
* Sets a new value for property {@link #getGrowFactor growFactor}.
*
* Determines the flexibility of the flex item when allocatable space is remaining.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} fGrowFactor - New value for property growFactor
* @returns {sap.m.FlexItemData} Reference to this
in order to allow method chaining
*/
public setGrowFactor(fGrowFactor: number): sap.m.FlexItemData;
/**
* Sets a new value for property {@link #getMaxHeight maxHeight}.
*
* The maximum height of the flex item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.CSSSize} sMaxHeight - New value for property maxHeight
* @returns {sap.m.FlexItemData} Reference to this
in order to allow method chaining
*/
public setMaxHeight(sMaxHeight: sap.ui.core.CSSSize): sap.m.FlexItemData;
/**
* Sets a new value for property {@link #getMaxWidth maxWidth}.
*
* The maximum height of the flex item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.CSSSize} sMaxWidth - New value for property maxWidth
* @returns {sap.m.FlexItemData} Reference to this
in order to allow method chaining
*/
public setMaxWidth(sMaxWidth: sap.ui.core.CSSSize): sap.m.FlexItemData;
/**
* Sets a new value for property {@link #getMinHeight minHeight}.
*
* The minimum height of the flex item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.core.CSSSize} sMinHeight - New value for property minHeight
* @returns {sap.m.FlexItemData} Reference to this
in order to allow method chaining
*/
public setMinHeight(sMinHeight: sap.ui.core.CSSSize): sap.m.FlexItemData;
/**
* Sets a new value for property {@link #getMinWidth minWidth}.
*
* The minimum height of the flex item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.core.CSSSize} sMinWidth - New value for property minWidth
* @returns {sap.m.FlexItemData} Reference to this
in order to allow method chaining
*/
public setMinWidth(sMinWidth: sap.ui.core.CSSSize): sap.m.FlexItemData;
/**
* Sets a new value for property {@link #getOrder order}.
*
* Determines the display order of flex items independent of their source code order.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iOrder - New value for property order
* @returns {sap.m.FlexItemData} Reference to this
in order to allow method chaining
*/
public setOrder(iOrder: number): sap.m.FlexItemData;
/**
* Sets a new value for property {@link #getShrinkFactor shrinkFactor}.
*
* The shrink factor determines how much the flex item will shrink relative to the rest of the flex items in the flex container when negative free space is distributed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} fShrinkFactor - New value for property shrinkFactor
* @returns {sap.m.FlexItemData} Reference to this
in order to allow method chaining
*/
public setShrinkFactor(fShrinkFactor: number): sap.m.FlexItemData;
/**
* Sets a new value for property {@link #getStyleClass styleClass}.
*
* The style class will be applied to the flex item and can be used for CSS selectors
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sStyleClass - New value for property styleClass
* @returns {sap.m.FlexItemData} Reference to this
in order to allow method chaining
*/
public setStyleClass(sStyleClass: string): sap.m.FlexItemData;
}
/**
* Available options for the layout of elements along the main axis of the flexbox layout.
*/
export enum FlexJustifyContent {
/**
* Flex items are packed toward the center of the line.
*/
Center = "Center",
/**
* Flex items are packed toward the end of the line.
*/
End = "End",
/**
* Inherits the value from its parent.
*/
Inherit = "Inherit",
/**
* Flex items are evenly distributed in the line, with half-size spaces on either end.
* Note: This value behaves like SpaceBetween in Internet Explorer 10.
*/
SpaceAround = "SpaceAround",
/**
* Flex items are evenly distributed in the line.
*/
SpaceBetween = "SpaceBetween",
/**
* Flex items are packed toward the start of the line.
*/
Start = "Start",
}
/**
* Determines the type of HTML elements used for rendering controls.
*/
export enum FlexRendertype {
/**
* The UI5 controls are not wrapped in an additional HTML element, the surrounding Flex Box is a DIV element.
*/
Bare = "Bare",
/**
* The UI5 controls are wrapped in DIV elements.
*/
Div = "Div",
/**
* The UI5 controls are wrapped in LI elements, the surrounding Flex Box is an unordered list (UL).
*/
List = "List",
}
/**
* Available options for the wrapping behavior of a flex container.
*/
export enum FlexWrap {
/**
* The flex container is single-line.
*/
NoWrap = "NoWrap",
/**
* The flex container is multi-line.
*/
Wrap = "Wrap",
/**
* The flex container is multi-line with the cross-axis start and end being swapped.
*/
WrapReverse = "WrapReverse",
}
/**
* The FormattedText control allows the usage of a limited set of tags for inline display of formatted text in HTML format.
*/
export class FormattedText extends sap.ui.core.Control {
/**
* Constructor for a new FormattedText.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.FormattedText with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getConvertedLinksDefaultTarget convertedLinksDefaultTarget}.
*
* Determines the target
attribute of the generated HTML anchor tags.
*
* Note: Applicable only if ConvertLinksToAnchorTags
property is used with a value other than sap.m.LinkConversion.None
.
* Options are the standard values for the target
attribute of the HTML anchor tag:
* _self
, _top
, _blank
, _parent
, _search
.
*
* Default value is _blank
.
* @returns {string} Value of property convertedLinksDefaultTarget
*/
public getConvertedLinksDefaultTarget(): string;
/**
* Gets current value of property {@link #getConvertLinksToAnchorTags convertLinksToAnchorTags}.
*
* Determines whether strings that appear to be links will be converted to HTML anchor tags,
* and what are the criteria for recognizing them.
*
* Default value is None
.
* @returns {sap.m.LinkConversion} Value of property convertLinksToAnchorTags
*/
public getConvertLinksToAnchorTags(): sap.m.LinkConversion;
/**
* Gets current value of property {@link #getHeight height}.
*
* Optional height of the control in CSS units.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getHtmlText htmlText}.
*
* Text in HTML format.
* The following tags are supported:
* a
abbr
blockquote
br
cite
code
em
h1
h2
h3
h4
h5
h6
p
pre
strong
span
u
dl
dt
dl
ul
ol
li
class, style,
and target
attributes are allowed.
* If target
is not set, links open in a new window by default.
*
Only safe href
attributes can be used. See {@link jQuery.sap.validateUrl}.
*
* Default value is .
* @returns {string} Value of property
htmlText
*/
public getHtmlText(): string;
/**
* Returns a metadata object for class sap.m.FormattedText.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getWidth width}.
*
* Optional width of the control in CSS units.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getConvertedLinksDefaultTarget convertedLinksDefaultTarget}.
*
* Determines the target
attribute of the generated HTML anchor tags.
*
* Note: Applicable only if ConvertLinksToAnchorTags
property is used with a value other than sap.m.LinkConversion.None
.
* Options are the standard values for the target
attribute of the HTML anchor tag:
* _self
, _top
, _blank
, _parent
, _search
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is _blank
.
* @param {string} sConvertedLinksDefaultTarget - New value for property convertedLinksDefaultTarget
* @returns {sap.m.FormattedText} Reference to this
in order to allow method chaining
*/
public setConvertedLinksDefaultTarget(sConvertedLinksDefaultTarget: string): sap.m.FormattedText;
/**
* Sets a new value for property {@link #getConvertLinksToAnchorTags convertLinksToAnchorTags}.
*
* Determines whether strings that appear to be links will be converted to HTML anchor tags,
* and what are the criteria for recognizing them.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.m.LinkConversion} sConvertLinksToAnchorTags - New value for property convertLinksToAnchorTags
* @returns {sap.m.FormattedText} Reference to this
in order to allow method chaining
*/
public setConvertLinksToAnchorTags(sConvertLinksToAnchorTags: sap.m.LinkConversion): sap.m.FormattedText;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Optional height of the control in CSS units.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.m.FormattedText} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.m.FormattedText;
/**
* Defines the HTML text to be displayed.
* @param {string} sText - HTML text as a string
* @returns {sap.m.FormattedText} this for chaining
*/
public setHtmlText(sText: string): sap.m.FormattedText;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Optional width of the control in CSS units.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.FormattedText} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.FormattedText;
}
/**
* Enum for possible frame size types for sap.m.TileContent and sap.m.GenericTile control.
*/
export enum FrameType {
/**
* The Auto frame type that adjusts the size of the control to the content.
* Support for this type in sap.m.GenericTile is deprecated since 1.48.0.
*/
Auto = "Auto",
/**
* The 1x1 frame type.
*/
OneByOne = "OneByOne",
/**
* The 2x1 frame type.
*/
TwoByOne = "TwoByOne",
/**
* The 2/3 frame type.
*/
TwoThirds = "TwoThirds",
}
/**
* Displays header, subheader, and a customizable main area in a tile format. Since 1.44, also an in-line format which contains only header and subheader is supported.
*/
export class GenericTile extends sap.ui.core.Control {
/**
* Constructor for a new sap.m.GenericTile control.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some tileContent to the aggregation {@link #getTileContent tileContent}.
* @param {sap.m.TileContent} oTileContent - the tileContent to add; if empty, nothing is inserted
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public addTileContent(oTileContent: sap.m.TileContent): sap.m.GenericTile;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.GenericTile
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.GenericTile
itself.
*
* The event is fired when the user presses the tile.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.GenericTile
itself
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.GenericTile;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.GenericTile
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.GenericTile
itself.
*
* The event is fired when the user presses the tile.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.GenericTile
itself
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.GenericTile;
/**
* Binds aggregation {@link #getTileContent tileContent} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public bindTileContent(oBindingInfo: any): sap.m.GenericTile;
/**
* Destroys the icon in the aggregation {@link #getIcon icon}.
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public destroyIcon(): sap.m.GenericTile;
/**
* Destroys all the tileContent in the aggregation {@link #getTileContent tileContent}.
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public destroyTileContent(): sap.m.GenericTile;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.GenericTile
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.GenericTile;
/**
* Creates a new subclass of class sap.m.GenericTile with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.GenericTile;
/**
* Gets current value of property {@link #getBackgroundImage backgroundImage}.
*
* The URI of the background image.
* @returns {sap.ui.core.URI} Value of property backgroundImage
*/
public getBackgroundImage(): sap.ui.core.URI;
/**
* Provides an interface to the tile's layout information consistent in all modes and content densities.
* @returns {any[]} An array containing all of the tile's bounding rectangles
*/
protected getBoundingRects(): any[];
/**
* Gets current value of property {@link #getFailedText failedText}.
*
* The message that appears when the control is in the Failed state.
* @returns {string} Value of property failedText
*/
public getFailedText(): string;
/**
* Gets current value of property {@link #getFrameType frameType}.
*
* The frame type: OneByOne or TwoByOne. Set to OneByOne as default if no property is defined or set to Auto by the app.
*
* Default value is OneByOne
.
* @returns {sap.m.FrameType} Value of property frameType
*/
public getFrameType(): sap.m.FrameType;
/**
* Gets current value of property {@link #getHeader header}.
*
* The header of the tile.
* @returns {string} Value of property header
*/
public getHeader(): string;
/**
* Gets current value of property {@link #getHeaderImage headerImage}.
*
* The image to be displayed as a graphical element within the header. This can be an image or an icon from the icon font.
* @returns {sap.ui.core.URI} Value of property headerImage
*/
public getHeaderImage(): sap.ui.core.URI;
/**
* Gets content of aggregation {@link #getIcon icon}.
*
* An icon or image to be displayed in the control.
* This aggregation is deprecated since version 1.36.0, to display an icon or image use sap.m.TileContent control instead.
* @returns {sap.ui.core.Control}
*/
public getIcon(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getImageDescription imageDescription}.
*
* Description of a header image that is used in the tooltip.
* @returns {string} Value of property imageDescription
*/
public getImageDescription(): string;
/**
* Returns a metadata object for class sap.m.GenericTile.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMode mode}.
*
* The mode of the GenericTile.
*
* Default value is ContentMode
.
* @returns {sap.m.GenericTileMode} Value of property mode
*/
public getMode(): sap.m.GenericTileMode;
/**
* Gets current value of property {@link #getScope scope}.
*
* Changes the visualization in order to enable additional actions with the Generic Tile.
*
* Default value is Display
.
* @returns {sap.m.GenericTileScope} Value of property scope
*/
public getScope(): sap.m.GenericTileScope;
/**
* Gets current value of property {@link #getSize size}.
*
* The size of the tile. If not set, then the default size is applied based on the device.
*
* Default value is Auto
.
* @returns {sap.m.Size} Value of property size
*/
public getSize(): sap.m.Size;
/**
* Gets current value of property {@link #getState state}.
*
* The load status.
*
* Default value is Loaded
.
* @returns {sap.m.LoadState} Value of property state
*/
public getState(): sap.m.LoadState;
/**
* Gets current value of property {@link #getSubheader subheader}.
*
* The subheader of the tile.
* @returns {string} Value of property subheader
*/
public getSubheader(): string;
/**
* Gets content of aggregation {@link #getTileContent tileContent}.
*
* The content of the tile.
* @returns {sap.m.TileContent[]}
*/
public getTileContent(): sap.m.TileContent[];
/**
* Checks for the provided sap.m.TileContent
in the aggregation {@link #getTileContent tileContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.TileContent} oTileContent - The tileContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfTileContent(oTileContent: sap.m.TileContent): number;
/**
* Inserts a tileContent into the aggregation {@link #getTileContent tileContent}.
* @param {sap.m.TileContent} oTileContent - the tileContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the tileContent should be inserted at; for a negative value of iIndex
, the tileContent is inserted at position 0; for a value greater than the current size of the aggregation, the tileContent is inserted at the last position
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public insertTileContent(oTileContent: sap.m.TileContent, iIndex: number): sap.m.GenericTile;
/**
* Removes all the controls from the aggregation {@link #getTileContent tileContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.TileContent[]} An array of the removed elements (might be empty)
*/
public removeAllTileContent(): sap.m.TileContent[];
/**
* Removes a tileContent from the aggregation {@link #getTileContent tileContent}.
* @param {number|string|sap.m.TileContent} vTileContent - The tileContent to remove or its index or id
* @returns {sap.m.TileContent} The removed tileContent or null
*/
public removeTileContent(vTileContent: number|string|sap.m.TileContent): sap.m.TileContent;
/**
* Sets a new value for property {@link #getBackgroundImage backgroundImage}.
*
* The URI of the background image.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sBackgroundImage - New value for property backgroundImage
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public setBackgroundImage(sBackgroundImage: sap.ui.core.URI): sap.m.GenericTile;
/**
* Sets a new value for property {@link #getFailedText failedText}.
*
* The message that appears when the control is in the Failed state.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sFailedText - New value for property failedText
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public setFailedText(sFailedText: string): sap.m.GenericTile;
/**
* Sets a new value for property {@link #getFrameType frameType}.
*
* The frame type: OneByOne or TwoByOne. Set to OneByOne as default if no property is defined or set to Auto by the app.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is OneByOne
.
* @param {sap.m.FrameType} sFrameType - New value for property frameType
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public setFrameType(sFrameType: sap.m.FrameType): sap.m.GenericTile;
/**
* Sets a new value for property {@link #getHeader header}.
*
* The header of the tile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sHeader - New value for property header
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public setHeader(sHeader: string): sap.m.GenericTile;
/**
* Sets a new value for property {@link #getHeaderImage headerImage}.
*
* The image to be displayed as a graphical element within the header. This can be an image or an icon from the icon font.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sHeaderImage - New value for property headerImage
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public setHeaderImage(sHeaderImage: sap.ui.core.URI): sap.m.GenericTile;
/**
* Sets the aggregated {@link #getIcon icon}.
* @param {sap.ui.core.Control} oIcon - The icon to set
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public setIcon(oIcon: sap.ui.core.Control): sap.m.GenericTile;
/**
* Sets a new value for property {@link #getImageDescription imageDescription}.
*
* Description of a header image that is used in the tooltip.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sImageDescription - New value for property imageDescription
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public setImageDescription(sImageDescription: string): sap.m.GenericTile;
/**
* Sets a new value for property {@link #getMode mode}.
*
* The mode of the GenericTile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is ContentMode
.
* @param {sap.m.GenericTileMode} sMode - New value for property mode
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public setMode(sMode: sap.m.GenericTileMode): sap.m.GenericTile;
/**
* Provides an interface to switch on or off the tile's press event. Used in SlideTile for Actions scope.
* @param {boolean} value - If set to true, the press event of the tile is active.
*/
protected setPressEnabled(value: boolean): void;
/**
* Sets a new value for property {@link #getScope scope}.
*
* Changes the visualization in order to enable additional actions with the Generic Tile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Display
.
* @param {sap.m.GenericTileScope} sScope - New value for property scope
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public setScope(sScope: sap.m.GenericTileScope): sap.m.GenericTile;
/**
* Sets a new value for property {@link #getSize size}.
*
* The size of the tile. If not set, then the default size is applied based on the device.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.m.Size} sSize - New value for property size
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public setSize(sSize: sap.m.Size): sap.m.GenericTile;
/**
* Sets a new value for property {@link #getState state}.
*
* The load status.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Loaded
.
* @param {sap.m.LoadState} sState - New value for property state
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public setState(sState: sap.m.LoadState): sap.m.GenericTile;
/**
* Sets a new value for property {@link #getSubheader subheader}.
*
* The subheader of the tile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sSubheader - New value for property subheader
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public setSubheader(sSubheader: string): sap.m.GenericTile;
/**
* Shows the actions scope view of GenericTile without changing the scope. Used in SlideTile for Actions scope.
* @param {boolean} value - If set to true, actions view is showed.
*/
protected showActionsView(value: boolean): void;
/**
* Unbinds aggregation {@link #getTileContent tileContent} from model data.
* @returns {sap.m.GenericTile} Reference to this
in order to allow method chaining
*/
public unbindTileContent(): sap.m.GenericTile;
}
/**
* Defines the mode of GenericTile.
*/
export enum GenericTileMode {
/**
* Default mode (Two lines for the header and one line for the subtitle).
*/
ContentMode = "ContentMode",
/**
* Header mode (Four lines for the header and one line for the subtitle).
*/
HeaderMode = "HeaderMode",
/**
* Line mode (Implemented for both, cozy and compact densities. Generic Tile is displayed as in-line element, header and subheader are displayed in one line.
* In case the texts need more than one line, the representation depends on the used density.
* Cozy: The text will be truncated and the full text is shown in a tooltip as soon as the tile is hovered (desktop only).
* Compact: Header and subheader are rendered continuously spanning multiple lines, no tooltip is provided).
*/
LineMode = "LineMode",
}
/**
* Defines the scopes of GenericTile enabling the developer to implement different "flavors" of tiles.
*/
export enum GenericTileScope {
/**
* Action scope (Possible footer and Error State information is overlaid, "Remove" and "More" icons are added to the tile).
*/
Actions = "Actions",
/**
* Default scope (The default scope of the tile, no action icons are rendered).
*/
Display = "Display",
}
/**
* sap.m.GroupHeaderListItem
is used to display the title of a group and act as separator between groups in sap.m.List
and sap.m.Table
.
* Note: The inherited properties unread
, selected
, counter
and press
event from sap.m.ListItemBase
are not supported.
*/
export class GroupHeaderListItem extends sap.m.ListItemBase {
/**
* Constructor for a new GroupHeaderListItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.GroupHeaderListItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ListItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getCount count}.
*
* Defines the count of items in the group, but it could also be an amount which represents the sum of all amounts in the group.
* Note: Will not be displayed if not set.
* @returns {string} Value of property count
*/
public getCount(): string;
/**
* Returns a metadata object for class sap.m.GroupHeaderListItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTitle title}.
*
* Defines the title of the group header.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getTitleTextDirection titleTextDirection}.
*
* Defines the title text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property titleTextDirection
*/
public getTitleTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getUpperCase upperCase}.
*
* Allows to uppercase the group title.
*
* Default value is false
.
* @returns {boolean} Value of property upperCase
*/
public getUpperCase(): boolean;
/**
* Sets a new value for property {@link #getCount count}.
*
* Defines the count of items in the group, but it could also be an amount which represents the sum of all amounts in the group.
* Note: Will not be displayed if not set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sCount - New value for property count
* @returns {sap.m.GroupHeaderListItem} Reference to this
in order to allow method chaining
*/
public setCount(sCount: string): sap.m.GroupHeaderListItem;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Defines the title of the group header.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.GroupHeaderListItem} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.GroupHeaderListItem;
/**
* Sets a new value for property {@link #getTitleTextDirection titleTextDirection}.
*
* Defines the title text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTitleTextDirection - New value for property titleTextDirection
* @returns {sap.m.GroupHeaderListItem} Reference to this
in order to allow method chaining
*/
public setTitleTextDirection(sTitleTextDirection: sap.ui.core.TextDirection): sap.m.GroupHeaderListItem;
/**
* Sets a new value for property {@link #getUpperCase upperCase}.
*
* Allows to uppercase the group title.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bUpperCase - New value for property upperCase
* @returns {sap.m.GroupHeaderListItem} Reference to this
in order to allow method chaining
*/
public setUpperCase(bUpperCase: boolean): sap.m.GroupHeaderListItem;
}
/**
*/
export class GrowingEnablement extends sap.ui.base.Object {
/**
* Creates a GrowingEnablement delegate that can be attached to ListBase Controls requiring capabilities for growing
* @param {sap.m.ListBase} oControl - the ListBase control of which this Growing is the delegate
*/
public constructor(oControl: sap.m.ListBase);
/**
* Creates a new subclass of class sap.m.GrowingEnablement with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.GrowingEnablement.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* sap.m.GrowingList control is the container for all list items and inherits from sap.m.List control. Everything like the selection, deletion, unread states and inset style are also maintained here. In addition the control provides a loading mechanism to request data from the model and append the list items to the list. The request is started manually by tapping on the trigger at the end of the list.
*/
export class GrowingList extends sap.m.List {
/**
* Constructor for a new GrowingList.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.GrowingList with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.List.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.GrowingList.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getScrollToLoad scrollToLoad}.
*
* If you set this property to true then user needs to scroll end to trigger loading a new page. Default value is false which means user needs to scroll end and then click button to load new page.
* NOTE: This property can be set true, if growing property is set "true" and if you only have one instance of this control inside the scroll container(e.g Page).
*
* Default value is false
.
* @returns {boolean} Value of property scrollToLoad
*/
public getScrollToLoad(): boolean;
/**
* Gets current value of property {@link #getThreshold threshold}.
*
* Number of items requested from the server. To activate this you should set growing property to "true"
*
* Default value is 20
.
* @returns {number} Value of property threshold
*/
public getThreshold(): number;
/**
* Gets current value of property {@link #getTriggerText triggerText}.
*
* Text which is displayed on the trigger at the end of the list. The default is a translated text ("Load More Data") coming from the messagebundle properties.
* This property can be used only if growing property is set "true" and scrollToLoad property is set "false".
* @returns {string} Value of property triggerText
*/
public getTriggerText(): string;
/**
* Sets a new value for property {@link #getScrollToLoad scrollToLoad}.
*
* If you set this property to true then user needs to scroll end to trigger loading a new page. Default value is false which means user needs to scroll end and then click button to load new page.
* NOTE: This property can be set true, if growing property is set "true" and if you only have one instance of this control inside the scroll container(e.g Page).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bScrollToLoad - New value for property scrollToLoad
* @returns {sap.m.GrowingList} Reference to this
in order to allow method chaining
*/
public setScrollToLoad(bScrollToLoad: boolean): sap.m.GrowingList;
/**
* Sets a new value for property {@link #getThreshold threshold}.
*
* Number of items requested from the server. To activate this you should set growing property to "true"
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 20
.
* @param {number} iThreshold - New value for property threshold
* @returns {sap.m.GrowingList} Reference to this
in order to allow method chaining
*/
public setThreshold(iThreshold: number): sap.m.GrowingList;
/**
* Sets a new value for property {@link #getTriggerText triggerText}.
*
* Text which is displayed on the trigger at the end of the list. The default is a translated text ("Load More Data") coming from the messagebundle properties.
* This property can be used only if growing property is set "true" and scrollToLoad property is set "false".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTriggerText - New value for property triggerText
* @returns {sap.m.GrowingList} Reference to this
in order to allow method chaining
*/
public setTriggerText(sTriggerText: string): sap.m.GrowingList;
}
/**
* The HBox control builds the container for a horizontal flexible box layout. HBox is a convenience control, as it is just a specialized FlexBox control.
*
* Note: Be sure to check the renderType
setting to avoid issues due to browser inconsistencies.
*/
export class HBox extends sap.m.FlexBox {
/**
* Constructor for a new HBox.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.HBox with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.FlexBox.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.HBox.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* The container that provides a horizontal layout. It provides a horizontal scrolling on the mobile devices.
* On the desktop, it provides scroll left and scroll right buttons. This control supports keyboard navigation.
* You can use left and right arrow keys to navigate through the inner content. The Home key puts focus on the first control and the End key puts focus on the last control.
* Use Enter or Space key to choose the control.
*/
export class HeaderContainer extends sap.ui.core.Control {
/**
* Constructor for the new HeaderContainer control.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.HeaderContainer} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.HeaderContainer;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.HeaderContainer} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.HeaderContainer;
/**
* Creates a new subclass of class sap.m.HeaderContainer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getBackgroundDesign backgroundDesign}.
*
* Specifies the background color of the content. The visualization of the different options depends on the used theme.
*
* Default value is library.BackgroundDesign.Transparent
.
* @returns {sap.m.BackgroundDesign} Value of property backgroundDesign
*/
public getBackgroundDesign(): sap.m.BackgroundDesign;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Content to add to HeaderContainer.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getHeight height}.
*
* The height of the whole HeaderContainer. If not specified, it is rendered as 'auto' in horizontal orientation and as '100%' in vertical orientation.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.m.HeaderContainer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getOrientation orientation}.
*
* The orientation of the HeaderContainer. There are two orientation modes: horizontal and vertical. In horizontal mode
* the content controls are displayed next to each other, in vertical mode the content controls are displayed
* on top of each other.
*
* Default value is Horizontal
.
* @returns {sap.ui.core.Orientation} Value of property orientation
*/
public getOrientation(): sap.ui.core.Orientation;
/**
* Gets current value of property {@link #getScrollStep scrollStep}.
*
* Number of pixels to scroll when the user chooses Next or Previous buttons. Relevant only for desktop.
*
* Default value is 300
.
* @returns {number} Value of property scrollStep
*/
public getScrollStep(): number;
/**
* Gets current value of property {@link #getScrollTime scrollTime}.
*
* Scroll animation time in milliseconds.
*
* Default value is 500
.
* @returns {number} Value of property scrollTime
*/
public getScrollTime(): number;
/**
* Gets current value of property {@link #getShowDividers showDividers}.
*
* If set to true, it shows dividers between the different content controls.
*
* Default value is true
.
* @returns {boolean} Value of property showDividers
*/
public getShowDividers(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* The width of the whole HeaderContainer. If not specified, it is rendered as '100%' in horizontal orientation and as 'auto' in vertical orientation.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.HeaderContainer} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.HeaderContainer;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
*
* Specifies the background color of the content. The visualization of the different options depends on the used theme.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is library.BackgroundDesign.Transparent
.
* @param {sap.m.BackgroundDesign} sBackgroundDesign - New value for property backgroundDesign
* @returns {sap.m.HeaderContainer} Reference to this
in order to allow method chaining
*/
public setBackgroundDesign(sBackgroundDesign: sap.m.BackgroundDesign): sap.m.HeaderContainer;
/**
* Sets a new value for property {@link #getHeight height}.
*
* The height of the whole HeaderContainer. If not specified, it is rendered as 'auto' in horizontal orientation and as '100%' in vertical orientation.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.m.HeaderContainer} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.m.HeaderContainer;
/**
* Sets a new value for property {@link #getOrientation orientation}.
*
* The orientation of the HeaderContainer. There are two orientation modes: horizontal and vertical. In horizontal mode
* the content controls are displayed next to each other, in vertical mode the content controls are displayed
* on top of each other.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Horizontal
.
* @param {sap.ui.core.Orientation} sOrientation - New value for property orientation
* @returns {sap.m.HeaderContainer} Reference to this
in order to allow method chaining
*/
public setOrientation(sOrientation: sap.ui.core.Orientation): sap.m.HeaderContainer;
/**
* Sets a new value for property {@link #getScrollStep scrollStep}.
*
* Number of pixels to scroll when the user chooses Next or Previous buttons. Relevant only for desktop.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 300
.
* @param {number} iScrollStep - New value for property scrollStep
* @returns {sap.m.HeaderContainer} Reference to this
in order to allow method chaining
*/
public setScrollStep(iScrollStep: number): sap.m.HeaderContainer;
/**
* Sets a new value for property {@link #getScrollTime scrollTime}.
*
* Scroll animation time in milliseconds.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 500
.
* @param {number} iScrollTime - New value for property scrollTime
* @returns {sap.m.HeaderContainer} Reference to this
in order to allow method chaining
*/
public setScrollTime(iScrollTime: number): sap.m.HeaderContainer;
/**
* Sets a new value for property {@link #getShowDividers showDividers}.
*
* If set to true, it shows dividers between the different content controls.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowDividers - New value for property showDividers
* @returns {sap.m.HeaderContainer} Reference to this
in order to allow method chaining
*/
public setShowDividers(bShowDividers: boolean): sap.m.HeaderContainer;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The width of the whole HeaderContainer. If not specified, it is rendered as '100%' in horizontal orientation and as 'auto' in vertical orientation.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.HeaderContainer} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.HeaderContainer;
}
/**
* Different levels for headers
*/
export enum HeaderLevel {
/**
* Header level 1
*/
H1 = "H1",
/**
* Header level 2
*/
H2 = "H2",
/**
* Header level 3
*/
H3 = "H3",
/**
* Header level 4
*/
H4 = "H4",
/**
* Header level 5
*/
H5 = "H5",
/**
* Header level 6
*/
H6 = "H6",
}
/**
* Interface for controls which are suitable as a Header, Subheader or Footer of a Page.
* If the control does not want to get a context base style class, it has to implement the isContextSensitive method and return false
*/
export interface IBar {
}
/**
* Allowed tags for the implementation of the IBar interface.
*/
export enum IBarHTMLTag {
/**
* Renders as a div element.
*/
Div = "Div",
/**
* Renders as a footer element.
*/
Footer = "Footer",
/**
* Renders as a header element.
*/
Header = "Header",
}
/**
* Helper Class for implementing the IBar interface. Should be created once per IBar instance.
*/
export class IBarInPageEnabler {
/**
*/
protected constructor();
/**
* Adds the sapMBarChildClass to a control.
* @param {sap.ui.core.Control} oControl
*/
protected static addChildClassTo(oControl: sap.ui.core.Control): void;
/**
* Renders the tooltip for the given control
* @param {sap.ui.core.RenderManager} oRM - the RenderManager that can be used for writing to the render output buffer.
* @param {sap.ui.core.Control} oControl - an object representation of the control that should be rendered.
*/
protected static renderTooltip(oRM: sap.ui.core.RenderManager, oControl: sap.ui.core.Control): void;
}
/**
* Represents an interface for controls, which are suitable as items for the sap.m.IconTabBar.
* The classes which implement this interface are:
* - sap.m.IconTabFilter
* - sap.m.IconTabSeparator
*/
export interface IconTab {
}
/**
* The IconTabBar control represents a collection of tabs with associated content.
*
* IconTabBar covers the following use cases:
* - Filter – There is only one main content for all tabs. The main content can be filtered, based on the selected tab.
* - Normal tab bar - The contents of each tab are independent from each other.
* - Combination of the above - There can be both filtered and independent contents.
*/
export class IconTabBar extends sap.ui.core.Control {
/**
* Constructor for a new IconTabBar.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.IconTabBar;
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.m.IconTab} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.m.IconTab): sap.m.IconTabBar;
/**
* Attaches event handler fnFunction
to the {@link #event:expand expand} event of this sap.m.IconTabBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.IconTabBar
itself.
*
* Indicates that the tab will expand or collapse.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.IconTabBar
itself
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public attachExpand(fnFunction: Function, oListener?: any): sap.m.IconTabBar;
/**
* Attaches event handler fnFunction
to the {@link #event:expand expand} event of this sap.m.IconTabBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.IconTabBar
itself.
*
* Indicates that the tab will expand or collapse.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.IconTabBar
itself
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public attachExpand(oData: any, fnFunction: Function, oListener?: any): sap.m.IconTabBar;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.IconTabBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.IconTabBar
itself.
*
* Fires when an item is selected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.IconTabBar
itself
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.m.IconTabBar;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.IconTabBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.IconTabBar
itself.
*
* Fires when an item is selected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.IconTabBar
itself
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.m.IconTabBar;
/**
* Forwards aggregations with the name of items to the internal list.
* @param {string} sAggregationName - The name for the binding
* @param {any} oBindingInfo - The configuration parameters for the binding
* @returns {sap.m.IconTabBar} this pointer for chaining
*/
public bindAggregation(sAggregationName: string, oBindingInfo: any): sap.m.IconTabBar;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.IconTabBar;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.IconTabBar;
/**
* Detaches event handler fnFunction
from the {@link #event:expand expand} event of this sap.m.IconTabBar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public detachExpand(fnFunction: Function, oListener: any): sap.m.IconTabBar;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.m.IconTabBar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.m.IconTabBar;
/**
* Creates a new subclass of class sap.m.IconTabBar with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:expand expand} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
protected fireExpand(mParameters?: any): sap.m.IconTabBar;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.m.IconTabBar;
/**
* Gets current value of property {@link #getApplyContentPadding applyContentPadding}.
*
* Determines whether the IconTabBar content fits to the full area.
* The paddings are removed if it's set to false.
*
* Default value is true
.
* @returns {boolean} Value of property applyContentPadding
*/
public getApplyContentPadding(): boolean;
/**
* Gets current value of property {@link #getBackgroundDesign backgroundDesign}.
*
* Specifies the background color of the IconTabBar.
*
* Depending on the theme, you can change the state of
* the background color to "Solid", "Translucent", or "Transparent".
* Default is "Solid".
*
* Default value is Solid
.
* @returns {sap.m.BackgroundDesign} Value of property backgroundDesign
*/
public getBackgroundDesign(): sap.m.BackgroundDesign;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Represents the contents displayed below the IconTabBar.
* If there are multiple contents, they are rendered after each other.
* The developer has to manage to display the right one or use the content aggregation
* inside the IconTabFilter (which will be displayed instead if it is set).
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getEnableTabReordering enableTabReordering}.
*
* Specifies whether tab reordering is enabled. Relevant only for desktop devices.
*
* Default value is false
.
* @returns {boolean} Value of property enableTabReordering
*/
public getEnableTabReordering(): boolean;
/**
* Gets current value of property {@link #getExpandable expandable}.
*
* Defines if the tabs are collapsible and expandable.
*
* Default value is true
.
* @returns {boolean} Value of property expandable
*/
public getExpandable(): boolean;
/**
* Gets current value of property {@link #getExpanded expanded}.
*
* Indicates if the actual tab content is expanded or not.
*
* Default value is true
.
* @returns {boolean} Value of property expanded
*/
public getExpanded(): boolean;
/**
* Gets current value of property {@link #getHeaderBackgroundDesign headerBackgroundDesign}.
*
* Specifies the background color of the header.
*
* Depending on the theme, you can change the state of
* the background color to "Solid", "Translucent", or "Transparent".
* Default is "Solid".
*
* Default value is Solid
.
* @returns {sap.m.BackgroundDesign} Value of property headerBackgroundDesign
*/
public getHeaderBackgroundDesign(): sap.m.BackgroundDesign;
/**
* Gets current value of property {@link #getHeaderMode headerMode}.
*
* Specifies the header mode.
* Note: The Inline mode works only if no icons are set.
*
* Default value is Standard
.
* @returns {sap.m.IconTabHeaderMode} Value of property headerMode
*/
public getHeaderMode(): sap.m.IconTabHeaderMode;
/**
* Gets content of aggregation {@link #getItems items}.
*
* The items displayed in the IconTabBar.
* @returns {sap.m.IconTab[]}
*/
public getItems(): sap.m.IconTab[];
/**
* Returns a metadata object for class sap.m.IconTabBar.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Reflector for the internal header's selectedKey property.
* @returns {string} The current property value
*/
public getSelectedKey(): string;
/**
* Gets current value of property {@link #getShowOverflowSelectList showOverflowSelectList}.
*
* Specifies if the overflow select list is displayed.
*
* The overflow select list represents a list, where all tab filters are displayed,
* so the user can select specific tab filter easier.
*
* Default value is false
.
* @returns {boolean} Value of property showOverflowSelectList
*/
public getShowOverflowSelectList(): boolean;
/**
* Gets current value of property {@link #getShowSelection showSelection}.
*
* Defines whether the current selection should be visualized.
*
* Default value is true
.
* @returns {boolean} Value of property showSelection
*/
public getShowSelection(): boolean;
/**
* Gets current value of property {@link #getStretchContentHeight stretchContentHeight}.
*
* Determines whether the IconTabBar height is stretched to the maximum possible height
* of its parent container. As a prerequisite, the height of the parent container must be
* defined as a fixed value.
*
* Default value is false
.
* @returns {boolean} Value of property stretchContentHeight
*/
public getStretchContentHeight(): boolean;
/**
* Gets current value of property {@link #getUpperCase upperCase}.
*
* Determines whether the text of the icon tab filter (not the count) is displayed in uppercase.
*
* Default value is false
.
* @returns {boolean} Value of property upperCase
*/
public getUpperCase(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.m.IconTab
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.IconTab} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.m.IconTab): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.IconTabBar;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.m.IconTab} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.m.IconTab, iIndex: number): sap.m.IconTabBar;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.IconTab[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.m.IconTab[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.m.IconTab} vItem - The item to remove or its index or id
* @returns {sap.m.IconTab} The removed item or null
*/
public removeItem(vItem: number|string|sap.m.IconTab): sap.m.IconTab;
/**
* Sets a new value for property {@link #getApplyContentPadding applyContentPadding}.
*
* Determines whether the IconTabBar content fits to the full area.
* The paddings are removed if it's set to false.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bApplyContentPadding - New value for property applyContentPadding
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public setApplyContentPadding(bApplyContentPadding: boolean): sap.m.IconTabBar;
/**
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
*
* Specifies the background color of the IconTabBar.
*
* Depending on the theme, you can change the state of
* the background color to "Solid", "Translucent", or "Transparent".
* Default is "Solid".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Solid
.
* @param {sap.m.BackgroundDesign} sBackgroundDesign - New value for property backgroundDesign
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public setBackgroundDesign(sBackgroundDesign: sap.m.BackgroundDesign): sap.m.IconTabBar;
/**
* Sets the enableTabReordering property.
* @param {boolean} value - New value for enableTabReordering
* @returns {sap.m.IconTabBar} this pointer for chaining
*/
public setEnableTabReordering(value: boolean): sap.m.IconTabBar;
/**
* Sets the tabs as collapsible and expandable without re-rendering the control.
* @param {boolean} bExpandable - new parameter value
* @returns {sap.m.IconTabBar} this pointer for chaining
*/
public setExpandable(bExpandable: boolean): sap.m.IconTabBar;
/**
* Sets the tab content as expanded.
* @param {boolean} bExpanded - new parameter value
* @returns {sap.m.IconTabBar} this pointer for chaining
*/
public setExpanded(bExpanded: boolean): sap.m.IconTabBar;
/**
* Sets the header background design.
* @param {sap.m.BackgroundDesign} headerBackgroundDesign - New parameter value
* @returns {sap.m.IconTabBar} this pointer for chaining
*/
public setHeaderBackgroundDesign(headerBackgroundDesign: sap.m.BackgroundDesign): sap.m.IconTabBar;
/**
* Sets the header mode.
* @param {sap.m.IconTabHeaderMode} mode - new parameter value
* @returns {sap.m.IconTabBar} this pointer for chaining
*/
public setHeaderMode(mode: sap.m.IconTabHeaderMode): sap.m.IconTabBar;
/**
* Reflector for the internal header's selectedKey property.
* @param {string} sValue - the new value
* @returns {sap.m.IconTabBar} this pointer for chaining
*/
public setSelectedKey(sValue: string): sap.m.IconTabBar;
/**
* Sets the showOverflowSelectList property.
* @param {boolean} value - New value for showOverflowSelectList
* @returns {sap.m.IconTabBar} this pointer for chaining
*/
public setShowOverflowSelectList(value: boolean): sap.m.IconTabBar;
/**
* Sets a new value for property {@link #getShowSelection showSelection}.
*
* Defines whether the current selection should be visualized.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowSelection - New value for property showSelection
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public setShowSelection(bShowSelection: boolean): sap.m.IconTabBar;
/**
* Sets a new value for property {@link #getStretchContentHeight stretchContentHeight}.
*
* Determines whether the IconTabBar height is stretched to the maximum possible height
* of its parent container. As a prerequisite, the height of the parent container must be
* defined as a fixed value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bStretchContentHeight - New value for property stretchContentHeight
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public setStretchContentHeight(bStretchContentHeight: boolean): sap.m.IconTabBar;
/**
* Sets a new value for property {@link #getUpperCase upperCase}.
*
* Determines whether the text of the icon tab filter (not the count) is displayed in uppercase.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bUpperCase - New value for property upperCase
* @returns {sap.m.IconTabBar} Reference to this
in order to allow method chaining
*/
public setUpperCase(bUpperCase: boolean): sap.m.IconTabBar;
}
/**
* Represents a selectable item inside an IconTabBar.
*/
export class IconTabFilter extends sap.ui.core.Item {
/**
* Constructor for a new IconTabFilter.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given.
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.IconTabFilter} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.IconTabFilter;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.IconTabFilter} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.IconTabFilter;
/**
* Creates a new subclass of class sap.m.IconTabFilter with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content displayed for this item (optional).
*
* If this content is set, it is displayed instead of the general content inside the IconTabBar.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getCount count}.
*
* Represents the "count" text, which is displayed in the tab filter.
*
* Default value is .
* @returns {string} Value of property
count
*/
public getCount(): string;
/**
* Gets current value of property {@link #getDesign design}.
*
* Specifies whether the icon and the texts are placed vertically or horizontally.
*
* Default value is Vertical
.
* @returns {sap.m.IconTabFilterDesign} Value of property design
*/
public getDesign(): sap.m.IconTabFilterDesign;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Specifies the icon to be displayed for the tab filter.
*
* Default value is .
* @returns {sap.ui.core.URI} Value of property
icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconColor iconColor}.
*
* Specifies the icon color.
*
* If an icon font is used, the color can be chosen from the icon colors (sap.ui.core.IconColor).
* Possible semantic colors are: Neutral, Positive, Critical, Negative.
* Instead of the semantic icon color the brand color can be used, this is named Default.
* Semantic colors and brand colors should not be mixed up inside one IconTabBar.
*
* Default value is Default
.
* @returns {sap.ui.core.IconColor} Value of property iconColor
*/
public getIconColor(): sap.ui.core.IconColor;
/**
* Gets current value of property {@link #getIconDensityAware iconDensityAware}.
*
* If set to true, it sends one or more requests,
* trying to get the density perfect version of the image if this version of
* the image doesn't exist on the server. Default value is set to true.
*
* If bandwidth is key for the application, set this value to false.
*
* Default value is true
.
* @returns {boolean} Value of property iconDensityAware
*/
public getIconDensityAware(): boolean;
/**
* Returns a metadata object for class sap.m.IconTabFilter.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowAll showAll}.
*
* Enables special visualization for disabled filter (show all items).
*
* Default value is false
.
* @returns {boolean} Value of property showAll
*/
public getShowAll(): boolean;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Specifies whether the tab filter is rendered.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.IconTabFilter} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.IconTabFilter;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Renders this item in the IconTabHeader.
* @param {sap.ui.core.RenderManager} rm - the RenderManager that can be used for writing to the render output buffer
*/
protected render(rm: sap.ui.core.RenderManager): void;
/**
* Renders this item in the IconTabSelectList.
* @param {sap.ui.core.RenderManager} rm - the RenderManager that can be used for writing to the render output buffer
* @param {sap.m.SelectList} selectList - the select list in which this filter is rendered
*/
protected renderInSelectList(rm: sap.ui.core.RenderManager, selectList: sap.m.SelectList): void;
/**
* Sets a new value for property {@link #getCount count}.
*
* Represents the "count" text, which is displayed in the tab filter.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is .
* @param {string} sCount - New value for property
count
* @returns {sap.m.IconTabFilter} Reference to this
in order to allow method chaining
*/
public setCount(sCount: string): sap.m.IconTabFilter;
/**
* Sets a new value for property {@link #getDesign design}.
*
* Specifies whether the icon and the texts are placed vertically or horizontally.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Vertical
.
* @param {sap.m.IconTabFilterDesign} sDesign - New value for property design
* @returns {sap.m.IconTabFilter} Reference to this
in order to allow method chaining
*/
public setDesign(sDesign: sap.m.IconTabFilterDesign): sap.m.IconTabFilter;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Specifies the icon to be displayed for the tab filter.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is .
* @param {sap.ui.core.URI} sIcon - New value for property
icon
* @returns {sap.m.IconTabFilter} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.IconTabFilter;
/**
* Sets a new value for property {@link #getIconColor iconColor}.
*
* Specifies the icon color.
*
* If an icon font is used, the color can be chosen from the icon colors (sap.ui.core.IconColor).
* Possible semantic colors are: Neutral, Positive, Critical, Negative.
* Instead of the semantic icon color the brand color can be used, this is named Default.
* Semantic colors and brand colors should not be mixed up inside one IconTabBar.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Default
.
* @param {sap.ui.core.IconColor} sIconColor - New value for property iconColor
* @returns {sap.m.IconTabFilter} Reference to this
in order to allow method chaining
*/
public setIconColor(sIconColor: sap.ui.core.IconColor): sap.m.IconTabFilter;
/**
* Sets a new value for property {@link #getIconDensityAware iconDensityAware}.
*
* If set to true, it sends one or more requests,
* trying to get the density perfect version of the image if this version of
* the image doesn't exist on the server. Default value is set to true.
*
* If bandwidth is key for the application, set this value to false.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconDensityAware - New value for property iconDensityAware
* @returns {sap.m.IconTabFilter} Reference to this
in order to allow method chaining
*/
public setIconDensityAware(bIconDensityAware: boolean): sap.m.IconTabFilter;
/**
* Sets a new value for property {@link #getShowAll showAll}.
*
* Enables special visualization for disabled filter (show all items).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowAll - New value for property showAll
* @returns {sap.m.IconTabFilter} Reference to this
in order to allow method chaining
*/
public setShowAll(bShowAll: boolean): sap.m.IconTabFilter;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Specifies whether the tab filter is rendered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.IconTabFilter} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.IconTabFilter;
}
/**
* Available Filter Item Design.
*/
export enum IconTabFilterDesign {
/**
* A horizontally layouted design providing more space for texts.
*/
Horizontal = "Horizontal",
/**
* A vertically layouted design using minimum horizontal space.
*/
Vertical = "Vertical",
}
/**
* This control displays a number of IconTabFilters and IconTabSeparators. If the available horizontal
* space is exceeded, a horizontal scrolling appears.
*/
export class IconTabHeader extends sap.ui.core.Control {
/**
* Constructor for a new IconTabHeader.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.m.IconTab} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.IconTabHeader} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.m.IconTab): sap.m.IconTabHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.IconTabHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.IconTabHeader
itself.
*
* Fires when an item is selected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.IconTabHeader
itself
* @returns {sap.m.IconTabHeader} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.m.IconTabHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.IconTabHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.IconTabHeader
itself.
*
* Fires when an item is selected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.IconTabHeader
itself
* @returns {sap.m.IconTabHeader} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.m.IconTabHeader;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.IconTabHeader} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.IconTabHeader;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.m.IconTabHeader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.IconTabHeader} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.m.IconTabHeader;
/**
* Creates a new subclass of class sap.m.IconTabHeader with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.IconTabHeader} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.m.IconTabHeader;
/**
* Gets current value of property {@link #getBackgroundDesign backgroundDesign}.
*
* Specifies the background color of the header.
*
* Depending on the theme, you can change the state of
* the background color to "Solid", "Translucent", or "Transparent".
* Default is "Solid".
*
* Default value is Solid
.
* @returns {sap.m.BackgroundDesign} Value of property backgroundDesign
*/
public getBackgroundDesign(): sap.m.BackgroundDesign;
/**
* Gets current value of property {@link #getEnableTabReordering enableTabReordering}.
*
* Specifies whether tab reordering is enabled. Relevant only for desktop devices.
*
* Default value is false
.
* @returns {boolean} Value of property enableTabReordering
*/
public getEnableTabReordering(): boolean;
/**
* Gets content of aggregation {@link #getItems items}.
*
* The items displayed in the IconTabHeader.
* @returns {sap.m.IconTab[]}
*/
public getItems(): sap.m.IconTab[];
/**
* Returns a metadata object for class sap.m.IconTabHeader.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMode mode}.
*
* Specifies the header mode.
* Note: The Inline mode works only if no icons are set.
*
* Default value is Standard
.
* @returns {sap.m.IconTabHeaderMode} Value of property mode
*/
public getMode(): sap.m.IconTabHeaderMode;
/**
* Gets current value of property {@link #getSelectedKey selectedKey}.
*
* Key of the selected item.
*
* If the key has no corresponding aggregated item, no changes will apply.
* If duplicate keys exists the first item matching, the key is used.
* @returns {string} Value of property selectedKey
*/
public getSelectedKey(): string;
/**
* Gets current value of property {@link #getShowOverflowSelectList showOverflowSelectList}.
*
* Specifies if the overflow select list is displayed.
*
* The overflow select list represents a list, where all tab filters are displayed,
* so the user can select specific tab filter easier.
*
* Default value is false
.
* @returns {boolean} Value of property showOverflowSelectList
*/
public getShowOverflowSelectList(): boolean;
/**
* Gets current value of property {@link #getShowSelection showSelection}.
*
* Defines whether the current selection is visualized.
*
* Default value is true
.
* @returns {boolean} Value of property showSelection
*/
public getShowSelection(): boolean;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Specifies whether the control is rendered.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Checks for the provided sap.m.IconTab
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.IconTab} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.m.IconTab): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.m.IconTab} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.IconTabHeader} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.m.IconTab, iIndex: number): sap.m.IconTabHeader;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.IconTab[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.m.IconTab[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.m.IconTab} vItem - The item to remove or its index or id
* @returns {sap.m.IconTab} The removed item or null
*/
public removeItem(vItem: number|string|sap.m.IconTab): sap.m.IconTab;
/**
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
*
* Specifies the background color of the header.
*
* Depending on the theme, you can change the state of
* the background color to "Solid", "Translucent", or "Transparent".
* Default is "Solid".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Solid
.
* @param {sap.m.BackgroundDesign} sBackgroundDesign - New value for property backgroundDesign
* @returns {sap.m.IconTabHeader} Reference to this
in order to allow method chaining
*/
public setBackgroundDesign(sBackgroundDesign: sap.m.BackgroundDesign): sap.m.IconTabHeader;
/**
* Sets a new value for property {@link #getEnableTabReordering enableTabReordering}.
*
* Specifies whether tab reordering is enabled. Relevant only for desktop devices.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableTabReordering - New value for property enableTabReordering
* @returns {sap.m.IconTabHeader} Reference to this
in order to allow method chaining
*/
public setEnableTabReordering(bEnableTabReordering: boolean): sap.m.IconTabHeader;
/**
* Sets a new value for property {@link #getMode mode}.
*
* Specifies the header mode.
* Note: The Inline mode works only if no icons are set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.m.IconTabHeaderMode} sMode - New value for property mode
* @returns {sap.m.IconTabHeader} Reference to this
in order to allow method chaining
*/
public setMode(sMode: sap.m.IconTabHeaderMode): sap.m.IconTabHeader;
/**
* Sets the selected item based on key.
* @param {string} sKey - The key of the item to be selected
* @returns {sap.m.IconTabHeader} this pointer for chaining
*/
public setSelectedKey(sKey: string): sap.m.IconTabHeader;
/**
* Sets a new value for property {@link #getShowOverflowSelectList showOverflowSelectList}.
*
* Specifies if the overflow select list is displayed.
*
* The overflow select list represents a list, where all tab filters are displayed,
* so the user can select specific tab filter easier.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowOverflowSelectList - New value for property showOverflowSelectList
* @returns {sap.m.IconTabHeader} Reference to this
in order to allow method chaining
*/
public setShowOverflowSelectList(bShowOverflowSelectList: boolean): sap.m.IconTabHeader;
/**
* Sets a new value for property {@link #getShowSelection showSelection}.
*
* Defines whether the current selection is visualized.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowSelection - New value for property showSelection
* @returns {sap.m.IconTabHeader} Reference to this
in order to allow method chaining
*/
public setShowSelection(bShowSelection: boolean): sap.m.IconTabHeader;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Specifies whether the control is rendered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.IconTabHeader} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.IconTabHeader;
}
/**
* Specifies IconTabBar
header mode.
*/
export enum IconTabHeaderMode {
}
/**
* Represents an Icon used to separate 2 tab filters.
*/
export class IconTabSeparator extends sap.ui.core.Element {
/**
* Constructor for a new IconTabSeparator.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.IconTabSeparator with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getIcon icon}.
*
* The icon to display for this separator. If no icon is given, a separator line is used instead.
*
* Default value is .
* @returns {sap.ui.core.URI} Value of property
icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconDensityAware iconDensityAware}.
*
* If set to true, it sends one or more requests,
* trying to get the density perfect version of the image if this version of
* the image doesn't exist on the server. Default value is set to true.
*
* If bandwidth is key for the application, set this value to false.
*
* Default value is true
.
* @returns {boolean} Value of property iconDensityAware
*/
public getIconDensityAware(): boolean;
/**
* Returns a metadata object for class sap.m.IconTabSeparator.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Specifies whether the separator is rendered.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Renders the item in the IconTabHeader.
* @param {sap.ui.core.RenderManager} rm - the RenderManager that can be used for writing to the render output buffer
*/
protected render(rm: sap.ui.core.RenderManager): void;
/**
* Renders this item in the IconTabSelectList.
* @param {sap.ui.core.RenderManager} rm - the RenderManager that can be used for writing to the render output buffer
* @param {sap.m.SelectList} selectList - the select list in which this filter is rendered
*/
protected renderInSelectList(rm: sap.ui.core.RenderManager, selectList: sap.m.SelectList): void;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* The icon to display for this separator. If no icon is given, a separator line is used instead.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is .
* @param {sap.ui.core.URI} sIcon - New value for property
icon
* @returns {sap.m.IconTabSeparator} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.IconTabSeparator;
/**
* Sets a new value for property {@link #getIconDensityAware iconDensityAware}.
*
* If set to true, it sends one or more requests,
* trying to get the density perfect version of the image if this version of
* the image doesn't exist on the server. Default value is set to true.
*
* If bandwidth is key for the application, set this value to false.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconDensityAware - New value for property iconDensityAware
* @returns {sap.m.IconTabSeparator} Reference to this
in order to allow method chaining
*/
public setIconDensityAware(bIconDensityAware: boolean): sap.m.IconTabSeparator;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Specifies whether the separator is rendered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.IconTabSeparator} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.IconTabSeparator;
}
/**
* A wrapper around the IMG tag. The image can be loaded from a remote or local server.
*
* Density related image will be loaded if image with density awareness name in format [imageName]@[densityValue].[extension] is provided. The valid desity values are 1, 1.5, 2. If the original devicePixelRatio isn't one of the three valid numbers, it's rounded up to the nearest one.
*
* There are various size setting options available, and the images can be combined with actions.
*
* From version 1.30, new image mode sap.m.ImageMode.Background is added. When this mode is set, the src property is set using the css style 'background-image'. The properties 'backgroundSize', 'backgroundPosition', 'backgroundRepeat' have effect only when image is in sap.m.ImageMode.Background mode. In order to make the high density image correctly displayed, the 'backgroundSize' should be set to the dimension of the normal density version.
*/
export class Image extends sap.ui.core.Control {
/**
* Constructor for a new Image.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:error error} event of this sap.m.Image
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Image
itself.
*
* Event is fired when the image resource can't be loaded. If densityAware is set to true, the event is fired when none of the fallback resources can be loaded.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Image
itself
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public attachError(fnFunction: Function, oListener?: any): sap.m.Image;
/**
* Attaches event handler fnFunction
to the {@link #event:error error} event of this sap.m.Image
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Image
itself.
*
* Event is fired when the image resource can't be loaded. If densityAware is set to true, the event is fired when none of the fallback resources can be loaded.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Image
itself
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public attachError(oData: any, fnFunction: Function, oListener?: any): sap.m.Image;
/**
* Attaches event handler fnFunction
to the {@link #event:load load} event of this sap.m.Image
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Image
itself.
*
* Event is fired when the image resource is loaded.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Image
itself
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public attachLoad(fnFunction: Function, oListener?: any): sap.m.Image;
/**
* Attaches event handler fnFunction
to the {@link #event:load load} event of this sap.m.Image
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Image
itself.
*
* Event is fired when the image resource is loaded.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Image
itself
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public attachLoad(oData: any, fnFunction: Function, oListener?: any): sap.m.Image;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.Image
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Image
itself.
*
* Event is fired when the user clicks on the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Image
itself
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.Image;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.Image
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Image
itself.
*
* Event is fired when the user clicks on the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Image
itself
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.Image;
/**
* Attaches event handler fnFunction
to the {@link #event:tap tap} event of this sap.m.Image
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Image
itself.
*
* Event is fired when the user clicks on the control. (This event is deprecated, use the press event instead)
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Image
itself
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public attachTap(fnFunction: Function, oListener?: any): sap.m.Image;
/**
* Attaches event handler fnFunction
to the {@link #event:tap tap} event of this sap.m.Image
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Image
itself.
*
* Event is fired when the user clicks on the control. (This event is deprecated, use the press event instead)
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Image
itself
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public attachTap(oData: any, fnFunction: Function, oListener?: any): sap.m.Image;
/**
* Binds aggregation {@link #getDetailBox detailBox} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public bindDetailBox(oBindingInfo: any): sap.m.Image;
/**
* Destroys the detailBox in the aggregation {@link #getDetailBox detailBox}.
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public destroyDetailBox(): sap.m.Image;
/**
* Detaches event handler fnFunction
from the {@link #event:error error} event of this sap.m.Image
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public detachError(fnFunction: Function, oListener: any): sap.m.Image;
/**
* Detaches event handler fnFunction
from the {@link #event:load load} event of this sap.m.Image
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public detachLoad(fnFunction: Function, oListener: any): sap.m.Image;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.Image
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.Image;
/**
* Detaches event handler fnFunction
from the {@link #event:tap tap} event of this sap.m.Image
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public detachTap(fnFunction: Function, oListener: any): sap.m.Image;
/**
* Creates a new subclass of class sap.m.Image with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:error error} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
protected fireError(mParameters?: any): sap.m.Image;
/**
* Fires event {@link #event:load load} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
protected fireLoad(mParameters?: any): sap.m.Image;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.Image;
/**
* Fires event {@link #event:tap tap} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
protected fireTap(mParameters?: any): sap.m.Image;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getActiveSrc activeSrc}.
*
* The source property which is used when the image is pressed.
*
* Default value is .
* @returns {sap.ui.core.URI} Value of property
activeSrc
*/
public getActiveSrc(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getAlt alt}.
*
* The alternative text that is displayed in case the Image is not available, or cannot be displayed.
* If the image is set to decorative this property is ignored.
* @returns {string} Value of property alt
*/
public getAlt(): string;
/**
* Gets current value of property {@link #getBackgroundPosition backgroundPosition}.
*
* Defines the position of the image in sap.m.ImageMode.Background mode. This property is set on the output DOM element using CSS style 'background-position'. This property takes effect only when the 'mode' property is set to sap.m.ImageMode.Background.
*
* Default value is initial
.
* @returns {string} Value of property backgroundPosition
*/
public getBackgroundPosition(): string;
/**
* Gets current value of property {@link #getBackgroundRepeat backgroundRepeat}.
*
* Defines whether the source image is repeated when the output DOM element is bigger than the source. This property is set on the output DOM element using CSS style 'background-repeat'. This property takes effect only when the 'mode' property is set to sap.m.ImageMode.Background.
*
* Default value is no-repeat
.
* @returns {string} Value of property backgroundRepeat
*/
public getBackgroundRepeat(): string;
/**
* Gets current value of property {@link #getBackgroundSize backgroundSize}.
*
* Defines the size of the image in sap.m.ImageMode.Background mode. This property is set on the output DOM element using CSS style 'background-size'. This property takes effect only when the 'mode' property is set to sap.m.ImageMode.Background.
*
* Default value is cover
.
* @returns {string} Value of property backgroundSize
*/
public getBackgroundSize(): string;
/**
* Gets current value of property {@link #getDecorative decorative}.
*
* A decorative image is included for design reasons. Accessibility tools will ignore decorative images.
*
* Note: If the Image has an image map (useMap is set), this property will be overridden (the image will not be rendered as decorative).
* A decorative image has no ALT attribute, so the Alt property is ignored if the image is decorative.
*
* Default value is true
.
* @returns {boolean} Value of property decorative
*/
public getDecorative(): boolean;
/**
* Gets current value of property {@link #getDensityAware densityAware}.
*
* If this is set to false, the src image will be loaded directly without attempting to fetch the density perfect image for high density device.
*
* By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
*
* If bandwidth is the key for the application, set this value to false.
*
* Default value is true
.
* @returns {boolean} Value of property densityAware
*/
public getDensityAware(): boolean;
/**
* Gets content of aggregation {@link #getDetailBox detailBox}.
*
* A sap.m.LightBox
instance, that will be opened automatically when the user interacts with the image.
*
* The tap
event will still be fired.
* @returns {sap.m.LightBox}
*/
public getDetailBox(): sap.m.LightBox;
/**
* Gets current value of property {@link #getHeight height}.
*
* When the empty value is kept, the original size is not changed. It is also possible to make settings for width or height only, the original ratio between width/height is maintained. When 'mode' property is set to sap.m.ImageMode.Background, this property always needs to be set. Otherwise the output DOM element has a 0 size.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.m.Image.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMode mode}.
*
* Defines how the src and the activeSrc is output to the Dom Element. When set to sap.m.ImageMode.Image which is the default value, the src (activeSrc) is set to the 'src' attribute of the 'img' tag. When set to sap.m.ImageMode.Background, the src (activeSrc) is set to the CSS style 'background-image' and the root DOM element is rendered as a 'span' tag instead of an 'img' tag.
*
* Default value is Image
.
* @returns {sap.m.ImageMode} Value of property mode
*/
public getMode(): sap.m.ImageMode;
/**
* Gets current value of property {@link #getSrc src}.
*
* Relative or absolute path to URL where the image file is stored. The path will be adapted to the density aware format according to the density of the device following the convention that [imageName]@[densityValue].[extension]
* @returns {sap.ui.core.URI} Value of property src
*/
public getSrc(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getUseMap useMap}.
*
* The name of the image map that defines the clickable areas
* @returns {string} Value of property useMap
*/
public getUseMap(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* When the empty value is kept, the original size is not changed. It is also possible to make settings for width or height only, the original ratio between width/height is maintained. When 'mode' property is set to sap.m.ImageMode.Background, this property always needs to be set. Otherwise the output DOM element has a 0 size.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* This overrides the default setter of the activeSrc property in order to avoid the rerendering.
* @param {sap.ui.core.URI} sActiveSrc
* @returns {sap.m.Image} this
pointer for chaining
*/
public setActiveSrc(sActiveSrc: sap.ui.core.URI): sap.m.Image;
/**
* Sets a new value for property {@link #getAlt alt}.
*
* The alternative text that is displayed in case the Image is not available, or cannot be displayed.
* If the image is set to decorative this property is ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAlt - New value for property alt
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public setAlt(sAlt: string): sap.m.Image;
/**
* Sets a new value for property {@link #getBackgroundPosition backgroundPosition}.
*
* Defines the position of the image in sap.m.ImageMode.Background mode. This property is set on the output DOM element using CSS style 'background-position'. This property takes effect only when the 'mode' property is set to sap.m.ImageMode.Background.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is initial
.
* @param {string} sBackgroundPosition - New value for property backgroundPosition
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public setBackgroundPosition(sBackgroundPosition: string): sap.m.Image;
/**
* Sets a new value for property {@link #getBackgroundRepeat backgroundRepeat}.
*
* Defines whether the source image is repeated when the output DOM element is bigger than the source. This property is set on the output DOM element using CSS style 'background-repeat'. This property takes effect only when the 'mode' property is set to sap.m.ImageMode.Background.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is no-repeat
.
* @param {string} sBackgroundRepeat - New value for property backgroundRepeat
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public setBackgroundRepeat(sBackgroundRepeat: string): sap.m.Image;
/**
* Sets a new value for property {@link #getBackgroundSize backgroundSize}.
*
* Defines the size of the image in sap.m.ImageMode.Background mode. This property is set on the output DOM element using CSS style 'background-size'. This property takes effect only when the 'mode' property is set to sap.m.ImageMode.Background.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is cover
.
* @param {string} sBackgroundSize - New value for property backgroundSize
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public setBackgroundSize(sBackgroundSize: string): sap.m.Image;
/**
* Sets a new value for property {@link #getDecorative decorative}.
*
* A decorative image is included for design reasons. Accessibility tools will ignore decorative images.
*
* Note: If the Image has an image map (useMap is set), this property will be overridden (the image will not be rendered as decorative).
* A decorative image has no ALT attribute, so the Alt property is ignored if the image is decorative.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bDecorative - New value for property decorative
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public setDecorative(bDecorative: boolean): sap.m.Image;
/**
* Sets a new value for property {@link #getDensityAware densityAware}.
*
* If this is set to false, the src image will be loaded directly without attempting to fetch the density perfect image for high density device.
*
* By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
*
* If bandwidth is the key for the application, set this value to false.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bDensityAware - New value for property densityAware
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public setDensityAware(bDensityAware: boolean): sap.m.Image;
/**
* Sets the aggregated {@link #getDetailBox detailBox}.
* @param {sap.m.LightBox} oDetailBox - The detailBox to set
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public setDetailBox(oDetailBox: sap.m.LightBox): sap.m.Image;
/**
* Sets a new value for property {@link #getHeight height}.
*
* When the empty value is kept, the original size is not changed. It is also possible to make settings for width or height only, the original ratio between width/height is maintained. When 'mode' property is set to sap.m.ImageMode.Background, this property always needs to be set. Otherwise the output DOM element has a 0 size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.m.Image;
/**
* Sets a new value for property {@link #getMode mode}.
*
* Defines how the src and the activeSrc is output to the Dom Element. When set to sap.m.ImageMode.Image which is the default value, the src (activeSrc) is set to the 'src' attribute of the 'img' tag. When set to sap.m.ImageMode.Background, the src (activeSrc) is set to the CSS style 'background-image' and the root DOM element is rendered as a 'span' tag instead of an 'img' tag.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Image
.
* @param {sap.m.ImageMode} sMode - New value for property mode
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public setMode(sMode: sap.m.ImageMode): sap.m.Image;
/**
* This overrides the default setter of the src property and update the dom node.
* @param {sap.ui.core.URI} sSrc
*/
public setSrc(sSrc: sap.ui.core.URI): void;
/**
* Sets a new value for property {@link #getUseMap useMap}.
*
* The name of the image map that defines the clickable areas
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sUseMap - New value for property useMap
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public setUseMap(sUseMap: string): sap.m.Image;
/**
* Sets a new value for property {@link #getWidth width}.
*
* When the empty value is kept, the original size is not changed. It is also possible to make settings for width or height only, the original ratio between width/height is maintained. When 'mode' property is set to sap.m.ImageMode.Background, this property always needs to be set. Otherwise the output DOM element has a 0 size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.Image;
/**
* Unbinds aggregation {@link #getDetailBox detailBox} from model data.
* @returns {sap.m.Image} Reference to this
in order to allow method chaining
*/
public unbindDetailBox(): sap.m.Image;
}
/**
* This control can be displayed as image content in a tile.
*/
export class ImageContent extends sap.ui.core.Control {
/**
* Constructor for a new sap.m.ImageContent control.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.ImageContent
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ImageContent
itself.
*
* The event is triggered when the image content is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ImageContent
itself
* @returns {sap.m.ImageContent} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.ImageContent;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.ImageContent
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ImageContent
itself.
*
* The event is triggered when the image content is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ImageContent
itself
* @returns {sap.m.ImageContent} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.ImageContent;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.ImageContent
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ImageContent} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.ImageContent;
/**
* Creates a new subclass of class sap.m.ImageContent with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ImageContent} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.ImageContent;
/**
* Gets current value of property {@link #getDescription description}.
*
* Description of image. This text is used to provide ScreenReader information.
* @returns {string} Value of property description
*/
public getDescription(): string;
/**
* Returns a metadata object for class sap.m.ImageContent.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSrc src}.
*
* The image to be displayed as a graphical element within the imageContent. This can be an image or an icon from the icon font.
* @returns {sap.ui.core.URI} Value of property src
*/
public getSrc(): sap.ui.core.URI;
/**
* Sets a new value for property {@link #getDescription description}.
*
* Description of image. This text is used to provide ScreenReader information.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sDescription - New value for property description
* @returns {sap.m.ImageContent} Reference to this
in order to allow method chaining
*/
public setDescription(sDescription: string): sap.m.ImageContent;
/**
* Sets a new value for property {@link #getSrc src}.
*
* The image to be displayed as a graphical element within the imageContent. This can be an image or an icon from the icon font.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sSrc - New value for property src
* @returns {sap.m.ImageContent} Reference to this
in order to allow method chaining
*/
public setSrc(sSrc: sap.ui.core.URI): sap.m.ImageContent;
}
/**
* Helper for Images.
*/
namespace ImageHelper {
/**
* Creates or updates an image control.
* @param {string} sImgId - id of the image to be dealt with.
* @param {sap.m.Image} oImageControl - the image to update. If undefined, a new image will be created.
* @param {sap.ui.core.Control} oParent - oImageControl's parentControl.
* @param {{ [key: string]: any }} mProperties - map object that contains key value pairs if image propeties. The 'src' property MUST be contained. Also the map's keys must be names of image properties
* @param {any[]} aCssClassesToAdd - array of css classes which will be added if the image needs to be created.
* @param {any[]} aCssClassesToRemove - all css clases that oImageControl has and which are contained in this array are removed bevore adding the css classes listed in aCssClassesToAdd.
* @returns {any} the new or updated image control
*/
function getImageControl(sImgId: string, oImageControl: sap.m.Image, oParent: sap.ui.core.Control, mProperties: { [key: string]: any }, aCssClassesToAdd: any[], aCssClassesToRemove: any[]): any;
}
/**
* Determines how the source image is used on the output DOM element.
*/
export enum ImageMode {
/**
* The image is rendered with 'span' tag and the 'src' property is set to the 'background-image' CSS style on the output DOM element
*/
Background = "Background",
/**
* The image is rendered with 'img' tag and the 'src' property is set to the src attribute on the output DOM element.
*/
Image = "Image",
}
/**
* Overview
*
* A text input field allows you to enter and edit text or numeric values in one line.
* To easily enter a valid value, you can enable the autocomplete suggestion feature and the value help option.
*
* Guidelines:
*
placeholder
property as a label.description
property only for small fields with no placeholders (i.e. for currencies).showValueHelp
) or autocomplete (showSuggestion
).
* Value help will open a new dialog where you can refine your input.
* Autocomplete has three types of suggestions:
* sap.ui.core.Item
or sap.ui.core.ListItem
sap.ui.core.Item
or sap.ui.core.ListItem
sap.m.ColumnListItem
suggestionItems
(for single and double values) and suggestionRows
(for tabular values).
*
* mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some suggestionColumn to the aggregation {@link #getSuggestionColumns suggestionColumns}.
* @param {sap.m.Column} oSuggestionColumn - the suggestionColumn to add; if empty, nothing is inserted
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public addSuggestionColumn(oSuggestionColumn: sap.m.Column): sap.m.Input;
/**
* Adds some suggestionItem to the aggregation {@link #getSuggestionItems suggestionItems}.
* @param {sap.ui.core.Item} oSuggestionItem - the suggestionItem to add; if empty, nothing is inserted
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public addSuggestionItem(oSuggestionItem: sap.ui.core.Item): sap.m.Input;
/**
* Adds some suggestionRow to the aggregation {@link #getSuggestionRows suggestionRows}.
* @param {sap.m.ColumnListItem} oSuggestionRow - the suggestionRow to add; if empty, nothing is inserted
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public addSuggestionRow(oSuggestionRow: sap.m.ColumnListItem): sap.m.Input;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.m.Input
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Input
itself.
*
* This event is fired when the value of the input is changed - e.g. at each keypress
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Input
itself
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public attachLiveChange(fnFunction: Function, oListener?: any): sap.m.Input;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.m.Input
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Input
itself.
*
* This event is fired when the value of the input is changed - e.g. at each keypress
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Input
itself
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public attachLiveChange(oData: any, fnFunction: Function, oListener?: any): sap.m.Input;
/**
* Attaches event handler fnFunction
to the {@link #event:submit submit} event of this sap.m.Input
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Input
itself.
*
* This event is fired when user presses the Enter
key on the input.
*
* Note:
* The event is fired independent of whether there was a change before or not. If a change was performed the event is fired after the change event.
* The event is also fired when an item of the select list is selected via Enter
.
* The event is only fired on an input which allows text input (editable
, enabled
and not valueHelpOnly
).
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Input
itself
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public attachSubmit(fnFunction: Function, oListener?: any): sap.m.Input;
/**
* Attaches event handler fnFunction
to the {@link #event:submit submit} event of this sap.m.Input
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Input
itself.
*
* This event is fired when user presses the Enter
key on the input.
*
* Note:
* The event is fired independent of whether there was a change before or not. If a change was performed the event is fired after the change event.
* The event is also fired when an item of the select list is selected via Enter
.
* The event is only fired on an input which allows text input (editable
, enabled
and not valueHelpOnly
).
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Input
itself
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public attachSubmit(oData: any, fnFunction: Function, oListener?: any): sap.m.Input;
/**
* Attaches event handler fnFunction
to the {@link #event:suggest suggest} event of this sap.m.Input
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Input
itself.
*
* This event is fired when user types in the input and showSuggestion is set to true. Changing the suggestItems aggregation will show the suggestions within a popup.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Input
itself
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public attachSuggest(fnFunction: Function, oListener?: any): sap.m.Input;
/**
* Attaches event handler fnFunction
to the {@link #event:suggest suggest} event of this sap.m.Input
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Input
itself.
*
* This event is fired when user types in the input and showSuggestion is set to true. Changing the suggestItems aggregation will show the suggestions within a popup.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Input
itself
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public attachSuggest(oData: any, fnFunction: Function, oListener?: any): sap.m.Input;
/**
* Attaches event handler fnFunction
to the {@link #event:suggestionItemSelected suggestionItemSelected} event of this sap.m.Input
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Input
itself.
*
* This event is fired when suggestionItem shown in suggestion popup are selected. This event is only fired when showSuggestion is set to true and there are suggestionItems shown in the suggestion popup.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Input
itself
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public attachSuggestionItemSelected(fnFunction: Function, oListener?: any): sap.m.Input;
/**
* Attaches event handler fnFunction
to the {@link #event:suggestionItemSelected suggestionItemSelected} event of this sap.m.Input
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Input
itself.
*
* This event is fired when suggestionItem shown in suggestion popup are selected. This event is only fired when showSuggestion is set to true and there are suggestionItems shown in the suggestion popup.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Input
itself
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public attachSuggestionItemSelected(oData: any, fnFunction: Function, oListener?: any): sap.m.Input;
/**
* Attaches event handler fnFunction
to the {@link #event:valueHelpRequest valueHelpRequest} event of this sap.m.Input
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Input
itself.
*
* When the value help indicator is clicked, this event will be fired.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Input
itself
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public attachValueHelpRequest(fnFunction: Function, oListener?: any): sap.m.Input;
/**
* Attaches event handler fnFunction
to the {@link #event:valueHelpRequest valueHelpRequest} event of this sap.m.Input
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Input
itself.
*
* When the value help indicator is clicked, this event will be fired.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Input
itself
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public attachValueHelpRequest(oData: any, fnFunction: Function, oListener?: any): sap.m.Input;
/**
* Forwards aggregations with the name of items or columns to the internal table.
* @param {string} sAggregationName - the name for the binding
* @param {any} oBindingInfo - the configuration parameters for the binding
* @returns {sap.m.Input} this pointer for chaining
*/
public bindAggregation(sAggregationName: string, oBindingInfo: any): sap.m.Input;
/**
* Binds aggregation {@link #getSuggestionColumns suggestionColumns} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public bindSuggestionColumns(oBindingInfo: any): sap.m.Input;
/**
* Binds aggregation {@link #getSuggestionRows suggestionRows} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public bindSuggestionRows(oBindingInfo: any): sap.m.Input;
/**
* Closes the suggestion list.
*/
public closeSuggestions(): void;
/**
* Destroys all the suggestionColumns in the aggregation {@link #getSuggestionColumns suggestionColumns}.
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public destroySuggestionColumns(): sap.m.Input;
/**
* Destroys all the suggestionItems in the aggregation {@link #getSuggestionItems suggestionItems}.
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public destroySuggestionItems(): sap.m.Input;
/**
* Destroys all the suggestionRows in the aggregation {@link #getSuggestionRows suggestionRows}.
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public destroySuggestionRows(): sap.m.Input;
/**
* Detaches event handler fnFunction
from the {@link #event:liveChange liveChange} event of this sap.m.Input
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public detachLiveChange(fnFunction: Function, oListener: any): sap.m.Input;
/**
* Detaches event handler fnFunction
from the {@link #event:submit submit} event of this sap.m.Input
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public detachSubmit(fnFunction: Function, oListener: any): sap.m.Input;
/**
* Detaches event handler fnFunction
from the {@link #event:suggest suggest} event of this sap.m.Input
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public detachSuggest(fnFunction: Function, oListener: any): sap.m.Input;
/**
* Detaches event handler fnFunction
from the {@link #event:suggestionItemSelected suggestionItemSelected} event of this sap.m.Input
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public detachSuggestionItemSelected(fnFunction: Function, oListener: any): sap.m.Input;
/**
* Detaches event handler fnFunction
from the {@link #event:valueHelpRequest valueHelpRequest} event of this sap.m.Input
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public detachValueHelpRequest(fnFunction: Function, oListener: any): sap.m.Input;
/**
* Creates a new subclass of class sap.m.Input with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.InputBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:liveChange liveChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
protected fireLiveChange(mParameters?: any): sap.m.Input;
/**
* Fires event {@link #event:submit submit} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
protected fireSubmit(mParameters?: any): sap.m.Input;
/**
* Fires event {@link #event:suggest suggest} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
protected fireSuggest(mParameters?: any): sap.m.Input;
/**
* Fires event {@link #event:suggestionItemSelected suggestionItemSelected} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
protected fireSuggestionItemSelected(mParameters?: any): sap.m.Input;
/**
* Fires event {@link #event:valueHelpRequest valueHelpRequest} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
protected fireValueHelpRequest(mParameters?: any): sap.m.Input;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getDateFormat dateFormat}.
*
* Only used if type=date and no datepicker is available.
* The data is displayed and the user input is parsed according to this format.
* NOTE: The value property is always of the form RFC 3339 (YYYY-MM-dd).
*
* Default value is YYYY-MM-dd
.
* @returns {string} Value of property dateFormat
*/
public getDateFormat(): string;
/**
* Gets current value of property {@link #getDescription description}.
*
* The description is a text after the input field, e.g. units of measurement, currencies.
* @returns {string} Value of property description
*/
public getDescription(): string;
/**
* Gets current value of property {@link #getEnableSuggestionsHighlighting enableSuggestionsHighlighting}.
*
* Specifies whether the suggestions highlighting is enabled.
*
* Default value is true
.
* @returns {boolean} Value of property enableSuggestionsHighlighting
*/
public getEnableSuggestionsHighlighting(): boolean;
/**
* Gets current value of property {@link #getFieldWidth fieldWidth}.
*
* This property only takes effect if the description property is set. It controls the distribution of space between the input field and the description text. The default value is 50% leaving the other 50% for the description.
*
* Default value is 50%
.
* @returns {sap.ui.core.CSSSize} Value of property fieldWidth
*/
public getFieldWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getFilterSuggests filterSuggests}.
*
* Defines whether to filter the provided suggestions before showing them to the user.
*
* Default value is true
.
* @returns {boolean} Value of property filterSuggests
*/
public getFilterSuggests(): boolean;
/**
* Gets current value of property {@link #getMaxLength maxLength}.
*
* Maximum number of characters. Value '0' means the feature is switched off.
* This parameter is not compatible with the input type sap.m.InputType.Number
.
* If the input type is set to Number
, the maxLength
value is ignored.
*
* Default value is 0
.
* @returns {number} Value of property maxLength
*/
public getMaxLength(): number;
/**
* Gets current value of property {@link #getMaxSuggestionWidth maxSuggestionWidth}.
*
* If set, the value of this parameter will control the horizontal size of the suggestion list to display more data. This allows suggestion lists to be wider than the input field if there is enough space available. By default, the suggestion list is always as wide as the input field.
* Note: The value will be ignored if the actual width of the input field is larger than the specified parameter value.
* @returns {sap.ui.core.CSSSize} Value of property maxSuggestionWidth
*/
public getMaxSuggestionWidth(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.m.Input.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* ID of the element which is the current target of the association {@link #getSelectedItem selectedItem}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedItem(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getSelectedKey selectedKey}.
*
* Defines the key of the selected item.
*
* Note: If duplicate keys exist, the first item matching the key is used.
*
* Default value is
.
* @returns {string} Value of property selectedKey
*/
public getSelectedKey(): string;
/**
* ID of the element which is the current target of the association {@link #getSelectedRow selectedRow}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedRow(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getShowSuggestion showSuggestion}.
*
* If this is set to true, suggest event is fired when user types in the input. Changing the suggestItems aggregation in suggest event listener will show suggestions within a popup. When runs on phone, input will first open a dialog where the input and suggestions are shown. When runs on a tablet, the suggestions are shown in a popup next to the input.
*
* Default value is false
.
* @returns {boolean} Value of property showSuggestion
*/
public getShowSuggestion(): boolean;
/**
* Gets current value of property {@link #getShowTableSuggestionValueHelp showTableSuggestionValueHelp}.
*
* For tabular suggestions, this flag will show/hide the button at the end of the suggestion table that triggers the event "valueHelpRequest" when pressed. The default value is true.
*
* NOTE: If suggestions are not tabular or no suggestions are used, the button will not be displayed and this flag is without effect.
*
* Default value is true
.
* @returns {boolean} Value of property showTableSuggestionValueHelp
*/
public getShowTableSuggestionValueHelp(): boolean;
/**
* Gets current value of property {@link #getShowValueHelp showValueHelp}.
*
* If set to true, a value help indicator will be displayed inside the control. When clicked the event "valueHelpRequest" will be fired.
*
* Default value is false
.
* @returns {boolean} Value of property showValueHelp
*/
public getShowValueHelp(): boolean;
/**
* Getter for property showValueStateMessage
.
* Whether the value state message should be shown. This property is already available for sap.m.Input since 1.16.0.
*
* Default value is true
* @returns {boolean} the value of property showValueStateMessage
*/
public getShowValueStateMessage(): boolean;
/**
* Gets current value of property {@link #getStartSuggestion startSuggestion}.
*
* Minimum length of the entered text in input before suggest event is fired. The default value is 1 which means the suggest event is fired after user types in input. When it's set to 0, suggest event is fired when input with no text gets focus.
*
* Default value is 1
.
* @returns {number} Value of property startSuggestion
*/
public getStartSuggestion(): number;
/**
* Gets content of aggregation {@link #getSuggestionColumns suggestionColumns}.
*
* The suggestionColumns and suggestionRows are for tabular input suggestions. This aggregation allows for binding the table columns; for more details see the aggregation "suggestionRows".
* @returns {sap.m.Column[]}
*/
public getSuggestionColumns(): sap.m.Column[];
/**
* Gets the item with the given key from the aggregation suggestionItems
.
*
* Note: If duplicate keys exist, the first item matching the key is returned.
* @param {string} sKey - An item key that specifies the item to retrieve.
* @returns {sap.ui.core.Item|any}
*/
public getSuggestionItemByKey(sKey: string): sap.ui.core.Item|any;
/**
* Gets content of aggregation {@link #getSuggestionItems suggestionItems}.
*
* SuggestItems are the items which will be shown in the suggestion popup. Changing this aggregation (by calling addSuggestionItem, insertSuggestionItem, removeSuggestionItem, removeAllSuggestionItems, destroySuggestionItems) after input is rendered will open/close the suggestion popup. o display suggestions with two text values, it is also possible to add sap.ui.core/ListItems as SuggestionItems (since 1.21.1). For the selected ListItem, only the first value is returned to the input field.
* @returns {sap.ui.core.Item[]}
*/
public getSuggestionItems(): sap.ui.core.Item[];
/**
* Gets content of aggregation {@link #getSuggestionRows suggestionRows}.
*
* The suggestionColumns and suggestionRows are for tabular input suggestions. This aggregation allows for binding the table cells.
* The items of this aggregation are to be bound directly or to set in the suggest event method.
* Note: If this aggregation is filled, the aggregation suggestionItems will be ignored.
* @returns {sap.m.ColumnListItem[]}
*/
public getSuggestionRows(): sap.m.ColumnListItem[];
/**
* Gets current value of property {@link #getSuggestionRowValidator suggestionRowValidator}.
*
* Defines the validation callback function called when a suggestion row gets selected.
*
* Default value is
.
* @returns {any} Value of property suggestionRowValidator
*/
public getSuggestionRowValidator(): any;
/**
* Gets current value of property {@link #getTextFormatMode textFormatMode}.
*
* Defines the display text format mode.
*
* Default value is Value
.
* @returns {sap.m.InputTextFormatMode} Value of property textFormatMode
*/
public getTextFormatMode(): sap.m.InputTextFormatMode;
/**
* Gets current value of property {@link #getTextFormatter textFormatter}.
*
* Defines the display text formatter function.
*
* Default value is
.
* @returns {any} Value of property textFormatter
*/
public getTextFormatter(): any;
/**
* Gets current value of property {@link #getType type}.
*
* HTML type of the internal input
tag (e.g. Text, Number, Email, Phone).
* The particular effect of this property differs depending on the browser and the current language settings,
* especially for the type Number.sap.m.InputType.Text
may be used in combination with data model formats.
* sap.ui.model
defines extended formats that are mostly incompatible with normal HTML
* representations for numbers and dates.
*
* Default value is Text
.
* @returns {sap.m.InputType} Value of property type
*/
public getType(): sap.m.InputType;
/**
* Gets current value of property {@link #getValueHelpOnly valueHelpOnly}.
*
* If set to true, direct text input is disabled and the control will trigger the event "valueHelpRequest" for all user interactions. The properties "showValueHelp", "editable", and "enabled" must be set to true, otherwise the property will have no effect
*
* Default value is false
.
* @returns {boolean} Value of property valueHelpOnly
*/
public getValueHelpOnly(): boolean;
/**
* Gets current value of property {@link #getValueLiveUpdate valueLiveUpdate}.
*
* Indicates when the value gets updated with the user changes: At each keystroke (true) or first when the user presses enter or tabs out (false).
*
* Default value is false
.
* @returns {boolean} Value of property valueLiveUpdate
*/
public getValueLiveUpdate(): boolean;
/**
* Getter for property valueStateText
.
* The text which is shown in the value state message popup. If not specfied a default text is shown. This property is already available for sap.m.Input since 1.16.0.
*
* Default value is empty/undefined
* @returns {string} the value of property valueStateText
*/
public getValueStateText(): string;
/**
* Returns the width of the input.
* @returns {sap.ui.core.CSSSize} The current width or 100% as default
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.m.Column
in the aggregation {@link #getSuggestionColumns suggestionColumns}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Column} oSuggestionColumn - The suggestionColumn whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSuggestionColumn(oSuggestionColumn: sap.m.Column): number;
/**
* Checks for the provided sap.ui.core.Item
in the aggregation {@link #getSuggestionItems suggestionItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Item} oSuggestionItem - The suggestionItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSuggestionItem(oSuggestionItem: sap.ui.core.Item): number;
/**
* Checks for the provided sap.m.ColumnListItem
in the aggregation {@link #getSuggestionRows suggestionRows}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ColumnListItem} oSuggestionRow - The suggestionRow whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSuggestionRow(oSuggestionRow: sap.m.ColumnListItem): number;
/**
* Inserts a suggestionColumn into the aggregation {@link #getSuggestionColumns suggestionColumns}.
* @param {sap.m.Column} oSuggestionColumn - the suggestionColumn to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the suggestionColumn should be inserted at; for a negative value of iIndex
, the suggestionColumn is inserted at position 0; for a value greater than the current size of the aggregation, the suggestionColumn is inserted at the last position
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public insertSuggestionColumn(oSuggestionColumn: sap.m.Column, iIndex: number): sap.m.Input;
/**
* Inserts a suggestionItem into the aggregation {@link #getSuggestionItems suggestionItems}.
* @param {sap.ui.core.Item} oSuggestionItem - the suggestionItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the suggestionItem should be inserted at; for a negative value of iIndex
, the suggestionItem is inserted at position 0; for a value greater than the current size of the aggregation, the suggestionItem is inserted at the last position
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public insertSuggestionItem(oSuggestionItem: sap.ui.core.Item, iIndex: number): sap.m.Input;
/**
* Inserts a suggestionRow into the aggregation {@link #getSuggestionRows suggestionRows}.
* @param {sap.m.ColumnListItem} oSuggestionRow - the suggestionRow to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the suggestionRow should be inserted at; for a negative value of iIndex
, the suggestionRow is inserted at position 0; for a value greater than the current size of the aggregation, the suggestionRow is inserted at the last position
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public insertSuggestionRow(oSuggestionRow: sap.m.ColumnListItem, iIndex: number): sap.m.Input;
/**
* Fire valueHelpRequest event on tap
* @param {JQueryEventObject} oEvent
*/
public ontap(oEvent: JQueryEventObject): void;
/**
* Removes all the controls from the aggregation {@link #getSuggestionColumns suggestionColumns}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Column[]} An array of the removed elements (might be empty)
*/
public removeAllSuggestionColumns(): sap.m.Column[];
/**
* Removes all the controls from the aggregation {@link #getSuggestionItems suggestionItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Item[]} An array of the removed elements (might be empty)
*/
public removeAllSuggestionItems(): sap.ui.core.Item[];
/**
* Removes all the controls from the aggregation {@link #getSuggestionRows suggestionRows}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ColumnListItem[]} An array of the removed elements (might be empty)
*/
public removeAllSuggestionRows(): sap.m.ColumnListItem[];
/**
* Removes a suggestionColumn from the aggregation {@link #getSuggestionColumns suggestionColumns}.
* @param {number|string|sap.m.Column} vSuggestionColumn - The suggestionColumn to remove or its index or id
* @returns {sap.m.Column} The removed suggestionColumn or null
*/
public removeSuggestionColumn(vSuggestionColumn: number|string|sap.m.Column): sap.m.Column;
/**
* Removes a suggestionItem from the aggregation {@link #getSuggestionItems suggestionItems}.
* @param {number|string|sap.ui.core.Item} vSuggestionItem - The suggestionItem to remove or its index or id
* @returns {sap.ui.core.Item} The removed suggestionItem or null
*/
public removeSuggestionItem(vSuggestionItem: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Removes a suggestionRow from the aggregation {@link #getSuggestionRows suggestionRows}.
* @param {number|string|sap.m.ColumnListItem} vSuggestionRow - The suggestionRow to remove or its index or id
* @returns {sap.m.ColumnListItem} The removed suggestionRow or null
*/
public removeSuggestionRow(vSuggestionRow: number|string|sap.m.ColumnListItem): sap.m.ColumnListItem;
/**
* Sets a new value for property {@link #getDateFormat dateFormat}.
*
* Only used if type=date and no datepicker is available.
* The data is displayed and the user input is parsed according to this format.
* NOTE: The value property is always of the form RFC 3339 (YYYY-MM-dd).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is YYYY-MM-dd
.
* @param {string} sDateFormat - New value for property dateFormat
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setDateFormat(sDateFormat: string): sap.m.Input;
/**
* Sets a new value for property {@link #getDescription description}.
*
* The description is a text after the input field, e.g. units of measurement, currencies.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sDescription - New value for property description
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setDescription(sDescription: string): sap.m.Input;
/**
* Sets a new value for property {@link #getEnableSuggestionsHighlighting enableSuggestionsHighlighting}.
*
* Specifies whether the suggestions highlighting is enabled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableSuggestionsHighlighting - New value for property enableSuggestionsHighlighting
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setEnableSuggestionsHighlighting(bEnableSuggestionsHighlighting: boolean): sap.m.Input;
/**
* Sets a new value for property {@link #getFieldWidth fieldWidth}.
*
* This property only takes effect if the description property is set. It controls the distribution of space between the input field and the description text. The default value is 50% leaving the other 50% for the description.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 50%
.
* @param {sap.ui.core.CSSSize} sFieldWidth - New value for property fieldWidth
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setFieldWidth(sFieldWidth: sap.ui.core.CSSSize): sap.m.Input;
/**
* Sets a custom filter function for suggestions. The default is to check whether the first item text begins with the typed value. For one and two-value suggestions this callback function will operate on sap.ui.core.Item types, for tabular suggestions the function will operate on sap.m.ColumnListItem types.
* @param {Function} fnFilter - The filter function is called when displaying suggestion items and has two input parameters: the first one is the string that is currently typed in the input field and the second one is the item that is being filtered. Returning true will add this item to the popup, returning false will not display it.
* @returns {sap.m.Input} this pointer for chaining
*/
public setFilterFunction(fnFilter: Function): sap.m.Input;
/**
* Sets a new value for property {@link #getFilterSuggests filterSuggests}.
*
* Defines whether to filter the provided suggestions before showing them to the user.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bFilterSuggests - New value for property filterSuggests
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setFilterSuggests(bFilterSuggests: boolean): sap.m.Input;
/**
* Sets a new value for property {@link #getMaxLength maxLength}.
*
* Maximum number of characters. Value '0' means the feature is switched off.
* This parameter is not compatible with the input type sap.m.InputType.Number
.
* If the input type is set to Number
, the maxLength
value is ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iMaxLength - New value for property maxLength
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setMaxLength(iMaxLength: number): sap.m.Input;
/**
* Sets a new value for property {@link #getMaxSuggestionWidth maxSuggestionWidth}.
*
* If set, the value of this parameter will control the horizontal size of the suggestion list to display more data. This allows suggestion lists to be wider than the input field if there is enough space available. By default, the suggestion list is always as wide as the input field.
* Note: The value will be ignored if the actual width of the input field is larger than the specified parameter value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sMaxSuggestionWidth - New value for property maxSuggestionWidth
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setMaxSuggestionWidth(sMaxSuggestionWidth: sap.ui.core.CSSSize): sap.m.Input;
/**
* Sets a custom result filter function for tabular suggestions to select the text that is passed to the input field. Default is to check whether the first cell with a "text" property begins with the typed value. For one value and two-value suggestions this callback function is not called.
* @param {Function} fnFilter - The result function is called with one parameter: the sap.m.ColumnListItem that is selected. The function must return a result string that will be displayed as the input field's value.
* @returns {sap.m.Input} this pointer for chaining
*/
public setRowResultFunction(fnFilter: Function): sap.m.Input;
/**
* Sets the selectedItem
association.
*
* Default value is null
.
* @param {string|sap.ui.core.Item|null} oItem - New value for the selectedItem
association. If an ID of a sap.ui.core.Item
is given, the item with this ID becomes the selectedItem
association. Alternatively, a sap.ui.core.Item
instance may be given or null
to clear the selection.
* @returns {sap.m.Input} this
to allow method chaining.
*/
public setSelectedItem(oItem: string|sap.ui.core.Item|null): sap.m.Input;
/**
* Sets the selectedKey
property.
*
* Default value is an empty string ""
or undefined
.
* @param {string} sKey - New value for property selectedKey
. If the provided sKey
is an empty string ""
or undefined
, the selection is cleared. If duplicate keys exist, the first item matching the key is selected.
* @returns {sap.m.Input} this
to allow method chaining.
*/
public setSelectedKey(sKey: string): sap.m.Input;
/**
* Sets the selectedRow
association.
*
* Default value is null
.
* @param {string|sap.m.ColumnListItem|null} oListItem - New value for the selectedRow
association. If an ID of a sap.m.ColumnListItem
is given, the item with this ID becomes the selectedRow
association. Alternatively, a sap.m.ColumnListItem
instance may be given or null
to clear the selection.
* @returns {sap.m.Input} this
to allow method chaining.
*/
public setSelectedRow(oListItem: string|sap.m.ColumnListItem|null): sap.m.Input;
/**
* Sets a new value for property {@link #getShowSuggestion showSuggestion}.
*
* If this is set to true, suggest event is fired when user types in the input. Changing the suggestItems aggregation in suggest event listener will show suggestions within a popup. When runs on phone, input will first open a dialog where the input and suggestions are shown. When runs on a tablet, the suggestions are shown in a popup next to the input.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowSuggestion - New value for property showSuggestion
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setShowSuggestion(bShowSuggestion: boolean): sap.m.Input;
/**
* Sets a new value for property {@link #getShowTableSuggestionValueHelp showTableSuggestionValueHelp}.
*
* For tabular suggestions, this flag will show/hide the button at the end of the suggestion table that triggers the event "valueHelpRequest" when pressed. The default value is true.
*
* NOTE: If suggestions are not tabular or no suggestions are used, the button will not be displayed and this flag is without effect.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowTableSuggestionValueHelp - New value for property showTableSuggestionValueHelp
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setShowTableSuggestionValueHelp(bShowTableSuggestionValueHelp: boolean): sap.m.Input;
/**
* Sets a new value for property {@link #getShowValueHelp showValueHelp}.
*
* If set to true, a value help indicator will be displayed inside the control. When clicked the event "valueHelpRequest" will be fired.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowValueHelp - New value for property showValueHelp
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setShowValueHelp(bShowValueHelp: boolean): sap.m.Input;
/**
* Setter for property showValueStateMessage
.
*
* Default value is true
* @param {boolean} bShowValueStateMessage - new value for property showValueStateMessage
* @returns {sap.m.InputBase} this
to allow method chaining
*/
public setShowValueStateMessage(bShowValueStateMessage: boolean): sap.m.InputBase;
/**
* Sets a new value for property {@link #getStartSuggestion startSuggestion}.
*
* Minimum length of the entered text in input before suggest event is fired. The default value is 1 which means the suggest event is fired after user types in input. When it's set to 0, suggest event is fired when input with no text gets focus.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} iStartSuggestion - New value for property startSuggestion
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setStartSuggestion(iStartSuggestion: number): sap.m.Input;
/**
* Sets a new value for property {@link #getSuggestionRowValidator suggestionRowValidator}.
*
* Defines the validation callback function called when a suggestion row gets selected.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {any} oSuggestionRowValidator - New value for property suggestionRowValidator
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setSuggestionRowValidator(oSuggestionRowValidator: any): sap.m.Input;
/**
* Sets a new value for property {@link #getTextFormatMode textFormatMode}.
*
* Defines the display text format mode.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Value
.
* @param {sap.m.InputTextFormatMode} sTextFormatMode - New value for property textFormatMode
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setTextFormatMode(sTextFormatMode: sap.m.InputTextFormatMode): sap.m.Input;
/**
* Sets a new value for property {@link #getTextFormatter textFormatter}.
*
* Defines the display text formatter function.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {any} oTextFormatter - New value for property textFormatter
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setTextFormatter(oTextFormatter: any): sap.m.Input;
/**
* Sets a new value for property {@link #getType type}.
*
* HTML type of the internal input
tag (e.g. Text, Number, Email, Phone).
* The particular effect of this property differs depending on the browser and the current language settings,
* especially for the type Number.sap.m.InputType.Text
may be used in combination with data model formats.
* sap.ui.model
defines extended formats that are mostly incompatible with normal HTML
* representations for numbers and dates.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Text
.
* @param {sap.m.InputType} sType - New value for property type
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.m.InputType): sap.m.Input;
/**
* Setter for property value
.
*
* Default value is empty/undefined
.
* @param {string} sValue - New value for property value
.
* @returns {sap.m.Input} this
to allow method chaining.
*/
public setValue(sValue: string): sap.m.Input;
/**
* Sets a new value for property {@link #getValueHelpOnly valueHelpOnly}.
*
* If set to true, direct text input is disabled and the control will trigger the event "valueHelpRequest" for all user interactions. The properties "showValueHelp", "editable", and "enabled" must be set to true, otherwise the property will have no effect
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bValueHelpOnly - New value for property valueHelpOnly
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setValueHelpOnly(bValueHelpOnly: boolean): sap.m.Input;
/**
* Sets a new value for property {@link #getValueLiveUpdate valueLiveUpdate}.
*
* Indicates when the value gets updated with the user changes: At each keystroke (true) or first when the user presses enter or tabs out (false).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bValueLiveUpdate - New value for property valueLiveUpdate
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public setValueLiveUpdate(bValueLiveUpdate: boolean): sap.m.Input;
/**
* Setter for property valueStateText
.
*
* Default value is empty/undefined
* @param {string} sValueStateText - new value for property valueStateText
* @returns {sap.m.InputBase} this
to allow method chaining
*/
public setValueStateText(sValueStateText: string): sap.m.InputBase;
/**
* Defines the width of the input. Default value is 100%
* @param {string} sWidth
* @returns {sap.m.Input}
*/
public setWidth(sWidth: string): sap.m.Input;
/**
* Unbinds aggregation {@link #getSuggestionColumns suggestionColumns} from model data.
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public unbindSuggestionColumns(): sap.m.Input;
/**
* Unbinds aggregation {@link #getSuggestionRows suggestionRows} from model data.
* @returns {sap.m.Input} Reference to this
in order to allow method chaining
*/
public unbindSuggestionRows(): sap.m.Input;
}
/**
* The sap.m.InputBase
control provides a basic functionality for input controls.
*/
export class InputBase extends sap.ui.core.Control {
/**
* Use labels as placeholder configuration.
* It can be necessary for the subclasses to overwrite this when
* native placeholder usage causes undesired input events or when
* placeholder attribute is not supported for the specified type.
* https://html.spec.whatwg.org/multipage/forms.html#input-type-attr-summary
*/
protected bShowLabelAsPlaceholder: any;
/**
* Constructor for a new sap.m.InputBase
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.InputBase;
/**
* Applies the focus info.
* To be overwritten by subclasses.
* @param {any} oFocusInfo
*/
protected applyFocusInfo(oFocusInfo: any): void;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.InputBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.InputBase
itself.
*
* Is fired when the text in the input field has changed and the focus leaves the input field or the enter key is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.InputBase
itself
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.m.InputBase;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.InputBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.InputBase
itself.
*
* Is fired when the text in the input field has changed and the focus leaves the input field or the enter key is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.InputBase
itself
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.m.InputBase;
/**
* Registers an event listener to the browser input event.
* @param {Function} fnCallback - Function to be called when the value of the input element is changed.
* @returns {sap.m.InputBase} this
to allow method chaining.
*/
protected bindToInputEvent(fnCallback: Function): sap.m.InputBase;
/**
* Binds property {@link #getValue value} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a
* detailed description of the possible properties of oBindingInfo
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
public bindValue(oBindingInfo: any): sap.m.InputBase;
/**
* Close value state message popup.
*/
protected closeValueStateMessage(): void;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.m.InputBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.m.InputBase;
/**
* Creates a new subclass of class sap.m.InputBase with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.m.InputBase;
/**
* Fires the change event for the listeners
* @param {string} sValue - value of the input.
* @param {Object} oParams - extra event parameters.
*/
protected fireChangeEvent(sValue: string, oParams?: Object): void;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets the DOM element reference where the message popup is attached.
* @returns {any} The DOM element reference where the message popup is attached
*/
protected getDomRefForValueStateMessage(): any;
/**
* Gets current value of property {@link #getEditable editable}.
*
* Defines whether the control can be modified by the user or not.
* Note: A user can tab to non-editable control, highlight it, and copy the text from it.
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Indicates whether the user can interact with the control or not.
* Note: Disabled controls cannot be focused and they are out of the tab-chain.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Returns an object representing the serialized focus information.
* To be overwritten by subclasses.
* @returns {any} An object representing the serialized focus information.
*/
protected getFocusInfo(): any;
/**
* Gets the labels referencing this control.
* @returns {sap.m.Label[]} Array of objects which are the current targets of the ariaLabelledBy
association and the labels referencing this control.
*/
protected getLabels(): sap.m.Label[];
/**
* Returns a metadata object for class sap.m.InputBase.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* Defines the name of the control for the purposes of form submission.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets current value of property {@link #getPlaceholder placeholder}.
*
* Defines a short hint intended to aid the user with data entry when the control has no value.
* @returns {string} Value of property placeholder
*/
public getPlaceholder(): string;
/**
* Gets current value of property {@link #getRequired required}.
*
* Indicates that user input is required. This property is only needed for accessibility purposes when a single relationship between
* the field and a label (see aggregation labelFor
of sap.m.Label
) cannot be established
* (e.g. one label should label multiple fields).
*
* Default value is false
.
* @returns {boolean} Value of property required
*/
public getRequired(): boolean;
/**
* Retrieves the selected text.
* Only supported for input control's type of Text, Url, Tel and Password.
* @returns {string} The selected text.
*/
protected getSelectedText(): string;
/**
* Gets current value of property {@link #getShowValueStateMessage showValueStateMessage}.
*
* Indicates whether the value state message should be shown or not.
*
* Default value is true
.
* @returns {boolean} Value of property showValueStateMessage
*/
public getShowValueStateMessage(): boolean;
/**
* Gets current value of property {@link #getTextAlign textAlign}.
*
* Defines the horizontal alignment of the text that is shown inside the input field.
*
* Default value is Initial
.
* @returns {sap.ui.core.TextAlign} Value of property textAlign
*/
public getTextAlign(): sap.ui.core.TextAlign;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Defines the text directionality of the input field, e.g. RTL
, LTR
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getValue value}.
*
* Defines the value of the control.
* @returns {string} Value of property value
*/
public getValue(): string;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Visualizes the validation state of the control, e.g. Error
, Warning
, Success
.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getValueStateText valueStateText}.
*
* Defines the text that appears in the value state message pop-up. If this is not specified, a default text is shown from the resource bundle.
* @returns {string} Value of property valueStateText
*/
public getValueStateText(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the control.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Handles the change event.
* @param {any} oEvent
* @param {any} mParameters - Additional event parameters to be passed in to the change event handler if the value has changed
* @returns {true|any} true when change event is fired
*/
protected onChange(oEvent: any, mParameters?: any): true|any;
/**
* Hook method that gets called when the input value is reverted with hitting escape.
* It may require to re-implement this method from sub classes for control specific behaviour.
* @param {string} sValue - Reverted value of the input.
*/
protected onValueRevertedByEscape(sValue: string): void;
/**
* Open value state message popup.
*/
protected openValueStateMessage(): void;
/**
* Hook method to prevent the change event from being fired when the text input field loses focus.
* @param {JQueryEventObject} oEvent - The event object.
* @returns {boolean} Whether or not the change event should be prevented.
*/
protected preventChangeOnFocusLeave(oEvent?: JQueryEventObject): boolean;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Selects the text within the input field between the specified start and end positions.
* Only supported for input control's type of Text, Url, Tel and Password.
* @param {number} iSelectionStart - The index into the text at which the first selected character is located.
* @param {number} iSelectionEnd - The index into the text at which the last selected character is located.
* @returns {sap.m.InputBase} this
to allow method chaining.
*/
protected selectText(iSelectionStart: number, iSelectionEnd: number): sap.m.InputBase;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Defines whether the control can be modified by the user or not.
* Note: A user can tab to non-editable control, highlight it, and copy the text from it.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.m.InputBase;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Indicates whether the user can interact with the control or not.
* Note: Disabled controls cannot be focused and they are out of the tab-chain.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.InputBase;
/**
* Sets a new value for property {@link #getName name}.
*
* Defines the name of the control for the purposes of form submission.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.m.InputBase;
/**
* Sets a new value for property {@link #getPlaceholder placeholder}.
*
* Defines a short hint intended to aid the user with data entry when the control has no value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sPlaceholder - New value for property placeholder
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
public setPlaceholder(sPlaceholder: string): sap.m.InputBase;
/**
* Sets a new value for property {@link #getRequired required}.
*
* Indicates that user input is required. This property is only needed for accessibility purposes when a single relationship between
* the field and a label (see aggregation labelFor
of sap.m.Label
) cannot be established
* (e.g. one label should label multiple fields).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bRequired - New value for property required
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
public setRequired(bRequired: boolean): sap.m.InputBase;
/**
* Sets a new value for property {@link #getShowValueStateMessage showValueStateMessage}.
*
* Indicates whether the value state message should be shown or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowValueStateMessage - New value for property showValueStateMessage
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
public setShowValueStateMessage(bShowValueStateMessage: boolean): sap.m.InputBase;
/**
* Sets a new value for property {@link #getTextAlign textAlign}.
*
* Defines the horizontal alignment of the text that is shown inside the input field.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Initial
.
* @param {sap.ui.core.TextAlign} sTextAlign - New value for property textAlign
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
public setTextAlign(sTextAlign: sap.ui.core.TextAlign): sap.m.InputBase;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Defines the text directionality of the input field, e.g. RTL
, LTR
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.InputBase;
/**
* Setter for property value
.
*
* Default value is empty/undefined
.
* @param {string} sValue - New value for property value
.
* @returns {sap.m.InputBase} this
to allow method chaining.
*/
public setValue(sValue: string): sap.m.InputBase;
/**
* Setter for property valueState
.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sValueState - New value for property valueState
.
* @returns {sap.m.InputBase} this
to allow method chaining.
*/
public setValueState(sValueState: sap.ui.core.ValueState): sap.m.InputBase;
/**
* Setter for property valueStateText
.
*
* Default value is empty/undefined
.
* @param {string} sText - New value for property valueStateText
.
* @returns {sap.m.InputBase} this
to allow method chaining
*/
public setValueStateText(sText: string): sap.m.InputBase;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.InputBase;
/**
* Unbinds property {@link #getValue value} from model data.
* @returns {sap.m.InputBase} Reference to this
in order to allow method chaining
*/
public unbindValue(): sap.m.InputBase;
/**
* Sets the DOM value of the input field and handles placeholder visibility.
* @param {string} sValue - value of the input field.
* @returns {sap.m.InputBase} this
to allow method chaining.
*/
protected updateDomValue(sValue: string): sap.m.InputBase;
}
/**
* List item should be used for a label and an input field.
*/
export class InputListItem extends sap.m.ListItemBase {
/**
* Constructor for a new InputListItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.InputListItem} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.InputListItem;
/**
* Binds aggregation {@link #getContent content} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.InputListItem} Reference to this
in order to allow method chaining
*/
public bindContent(oBindingInfo: any): sap.m.InputListItem;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.InputListItem} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.InputListItem;
/**
* Creates a new subclass of class sap.m.InputListItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ListItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Content controls can be added
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getLabel label}.
*
* Label of the list item
* @returns {string} Value of property label
*/
public getLabel(): string;
/**
* Gets current value of property {@link #getLabelTextDirection labelTextDirection}.
*
* This property specifies the label text directionality with enumerated options. By default, the label inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property labelTextDirection
*/
public getLabelTextDirection(): sap.ui.core.TextDirection;
/**
* Returns a metadata object for class sap.m.InputListItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.InputListItem} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.InputListItem;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getLabel label}.
*
* Label of the list item
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sLabel - New value for property label
* @returns {sap.m.InputListItem} Reference to this
in order to allow method chaining
*/
public setLabel(sLabel: string): sap.m.InputListItem;
/**
* Sets a new value for property {@link #getLabelTextDirection labelTextDirection}.
*
* This property specifies the label text directionality with enumerated options. By default, the label inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sLabelTextDirection - New value for property labelTextDirection
* @returns {sap.m.InputListItem} Reference to this
in order to allow method chaining
*/
public setLabelTextDirection(sLabelTextDirection: sap.ui.core.TextDirection): sap.m.InputListItem;
/**
* Unbinds aggregation {@link #getContent content} from model data.
* @returns {sap.m.InputListItem} Reference to this
in order to allow method chaining
*/
public unbindContent(): sap.m.InputListItem;
}
/**
* Suggestion helper for sap.m.Input fields: Creates a multi column suggest list for an sap.m.Input field based on a ValueList
* annotation. The ValueList annotation will be resolved via the binding information of the Input field.
*
* If the annotation describes multiple input parameter the suggest provider will resolve all of these relative to the
* context of the Input filed and use them for the suggestion query. The suggest provider will write all values that are
* described as output parameters back to the model (relative to the context of the Input field). This can only be done if
* the model runs in "TwoWay" binding mode. Both features can be switched of via the bResolveInput/bResolveOutput parameter
* of the suggest function:
*/
namespace InputODataSuggestProvider {
}
/**
* Defines how the input display text should be formatted.
*/
export enum InputTextFormatMode {
/**
* Key
*/
Key = "Key",
/**
* A key-value pair formatted like "(key) text"
*/
KeyValue = "KeyValue",
/**
* Text
*/
Value = "Value",
/**
* A value-key pair formatted like "text (key)"
*/
ValueKey = "ValueKey",
}
/**
* A subset of input types that fits to a simple API returning one string.
* Not available on purpose: button, checkbox, hidden, image, password, radio, range, reset, search, submit.
*/
export enum InputType {
/**
* An input control for specifying a date value. The user can select a month, day of the month, and year.
*/
Date = "Date",
/**
* An input control for specifying a date and time value. The user can select a month, day of the month, year, and time of day.
*/
Datetime = "Datetime",
/**
* An input control for specifying a date and time value where the format depends on the locale.
*/
DatetimeLocale = "DatetimeLocale",
/**
* A text field for specifying an email address. Brings up a keyboard optimized for email address entry.
*/
Email = "Email",
/**
* An input control for selecting a month.
*/
Month = "Month",
/**
* A text field for specifying a number. Brings up a number pad keyboard. Specifying an input type of \d* or [0-9]* is equivalent to using this type.
*/
Number = "Number",
/**
* Password input where the user entry cannot be seen.
*/
Password = "Password",
/**
* A text field for specifying a phone number. Brings up a phone pad keyboard.
*/
Tel = "Tel",
/**
* default (text)
*/
Text = "Text",
/**
* An input control for specifying a time value. The user can select the hour, minute, and optionally AM or PM.
*/
Time = "Time",
/**
* A text field for specifying a URL. Brings up a keyboard optimized for URL entry.
*/
Url = "Url",
/**
* An input control for selecting a week.
*/
Week = "Week",
}
/**
* Interface for controls which are suitable as a Scale for the Slider/RangeSlider.
*/
export interface IScale {
}
/**
* The Label control is used in a UI5 mobile application to provide label text for other controls. Design such as bold, and text alignment can be specified.
*/
export class Label extends sap.ui.core.Control {
/**
* Constructor for a new Label.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.Label with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getDesign design}.
*
* Sets the design of a Label to either Standard or Bold.
*
* Default value is Standard
.
* @returns {sap.m.LabelDesign} Value of property design
*/
public getDesign(): sap.m.LabelDesign;
/**
* ID of the element which is the current target of the association {@link #getLabelFor labelFor}, or null
.
* @returns {sap.ui.core.ID}
*/
public getLabelFor(): sap.ui.core.ID;
/**
* Returns a metadata object for class sap.m.Label.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRequired required}.
*
* Indicates that user input is required in the input this label labels.
*
* Default value is false
.
* @returns {boolean} Value of property required
*/
public getRequired(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* Determines the Label text to be displayed.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextAlign textAlign}.
*
* Available alignment settings are "Begin", "Center", "End", "Left", and "Right".
*
* Default value is Begin
.
* @returns {sap.ui.core.TextAlign} Value of property textAlign
*/
public getTextAlign(): sap.ui.core.TextAlign;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Options for the text direction are RTL and LTR. Alternatively, the control can inherit the text direction from its parent container.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getWidth width}.
*
* Determines the width of the label.
*
* Default value is
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getDesign design}.
*
* Sets the design of a Label to either Standard or Bold.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.m.LabelDesign} sDesign - New value for property design
* @returns {sap.m.Label} Reference to this
in order to allow method chaining
*/
public setDesign(sDesign: sap.m.LabelDesign): sap.m.Label;
/**
* Sets the associated {@link #getLabelFor labelFor}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oLabelFor - ID of an element which becomes the new target of this labelFor association; alternatively, an element instance may be given
* @returns {sap.m.Label} Reference to this
in order to allow method chaining
*/
public setLabelFor(oLabelFor: sap.ui.core.ID|sap.ui.core.Control): sap.m.Label;
/**
* Sets a new value for property {@link #getRequired required}.
*
* Indicates that user input is required in the input this label labels.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bRequired - New value for property required
* @returns {sap.m.Label} Reference to this
in order to allow method chaining
*/
public setRequired(bRequired: boolean): sap.m.Label;
/**
* Sets a new value for property {@link #getText text}.
*
* Determines the Label text to be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.m.Label} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.Label;
/**
* Sets a new value for property {@link #getTextAlign textAlign}.
*
* Available alignment settings are "Begin", "Center", "End", "Left", and "Right".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Begin
.
* @param {sap.ui.core.TextAlign} sTextAlign - New value for property textAlign
* @returns {sap.m.Label} Reference to this
in order to allow method chaining
*/
public setTextAlign(sTextAlign: sap.ui.core.TextAlign): sap.m.Label;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Options for the text direction are RTL and LTR. Alternatively, the control can inherit the text direction from its parent container.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.Label} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.Label;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Determines the width of the label.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.Label} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.Label;
}
/**
* Available label display modes.
*/
export enum LabelDesign {
/**
* Displays the label in bold.
*/
Bold = "Bold",
/**
* Displays the label in normal mode.
*/
Standard = "Standard",
}
/**
* Overview
* imageContent
aggregation of the control as well as the source of the image and the title of the image is mandatory.
* If the image source is not set, the control will not open.mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some imageContent to the aggregation {@link #getImageContent imageContent}.
* @param {sap.m.LightBoxItem} oImageContent - the imageContent to add; if empty, nothing is inserted
* @returns {sap.m.LightBox} Reference to this
in order to allow method chaining
*/
public addImageContent(oImageContent: sap.m.LightBoxItem): sap.m.LightBox;
/**
* Binds aggregation {@link #getImageContent imageContent} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.LightBox} Reference to this
in order to allow method chaining
*/
public bindImageContent(oBindingInfo: any): sap.m.LightBox;
/**
* Closes the LightBox.
* @returns {sap.m.LightBox} Pointer to the control instance for chaining.
*/
public close(): sap.m.LightBox;
/**
* Destroys all the imageContent in the aggregation {@link #getImageContent imageContent}.
* @returns {sap.m.LightBox} Reference to this
in order to allow method chaining
*/
public destroyImageContent(): sap.m.LightBox;
/**
* Creates a new subclass of class sap.m.LightBox with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getImageContent imageContent}.
*
* Aggregation which holds data about the image and its description. Although multiple LightBoxItems
* may be added to this aggregation only the first one in the list will be taken into account.
* @returns {sap.m.LightBoxItem[]}
*/
public getImageContent(): sap.m.LightBoxItem[];
/**
* Returns a metadata object for class sap.m.LightBox.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.m.LightBoxItem
in the aggregation {@link #getImageContent imageContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.LightBoxItem} oImageContent - The imageContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfImageContent(oImageContent: sap.m.LightBoxItem): number;
/**
* Inserts a imageContent into the aggregation {@link #getImageContent imageContent}.
* @param {sap.m.LightBoxItem} oImageContent - the imageContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the imageContent should be inserted at; for a negative value of iIndex
, the imageContent is inserted at position 0; for a value greater than the current size of the aggregation, the imageContent is inserted at the last position
* @returns {sap.m.LightBox} Reference to this
in order to allow method chaining
*/
public insertImageContent(oImageContent: sap.m.LightBoxItem, iIndex: number): sap.m.LightBox;
/**
* Opens the LightBox.
* @returns {sap.m.LightBox} Pointer to the control instance for chaining.
*/
public open(): sap.m.LightBox;
/**
* Removes all the controls from the aggregation {@link #getImageContent imageContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.LightBoxItem[]} An array of the removed elements (might be empty)
*/
public removeAllImageContent(): sap.m.LightBoxItem[];
/**
* Removes a imageContent from the aggregation {@link #getImageContent imageContent}.
* @param {number|string|sap.m.LightBoxItem} vImageContent - The imageContent to remove or its index or id
* @returns {sap.m.LightBoxItem} The removed imageContent or null
*/
public removeImageContent(vImageContent: number|string|sap.m.LightBoxItem): sap.m.LightBoxItem;
/**
* Unbinds aggregation {@link #getImageContent imageContent} from model data.
* @returns {sap.m.LightBox} Reference to this
in order to allow method chaining
*/
public unbindImageContent(): sap.m.LightBox;
}
/**
* Represents an item which is displayed within an sap.m.LightBox. This item holds all properties of the image as
* well as the title and subtitle.
*/
export class LightBoxItem extends sap.ui.core.Element {
/**
* Constructor for a new LightBoxItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.LightBoxItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAlt alt}.
*
* Alt value for the image
*
* Default value is
.
* @returns {string} Value of property alt
*/
public getAlt(): string;
/**
* Gets current value of property {@link #getImageSrc imageSrc}.
*
* Source for the image. This property is mandatory. If not set the popup will not open
*
* Default value is
.
* @returns {sap.ui.core.URI} Value of property imageSrc
*/
public getImageSrc(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.m.LightBoxItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSubtitle subtitle}.
*
* Subtitle text for the image
*
* Default value is
.
* @returns {string} Value of property subtitle
*/
public getSubtitle(): string;
/**
* Gets current value of property {@link #getTitle title}.
*
* Title text for the image. This property is mandatory.
*
* Default value is
.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Sets the alt text of the image.
* @param {string} sAlt - The alt text
* @returns {sap.m.LightBoxItem} Pointer to the control instance for chaining.
*/
public setAlt(sAlt: string): sap.m.LightBoxItem;
/**
* Sets the source of the image.
* @param {sap.ui.core.URI} sImageSrc - The image URI
* @returns {sap.m.LightBoxItem} Pointer to the control instance for chaining.
*/
public setImageSrc(sImageSrc: sap.ui.core.URI): sap.m.LightBoxItem;
/**
* Sets the subtitle of the image.
* @param {string} sSubtitle - The image subtitle
* @returns {sap.m.LightBoxItem} Pointer to the control instance for chaining.
*/
public setSubtitle(sSubtitle: string): sap.m.LightBoxItem;
/**
* Sets the title of the image.
* @param {string} sTitle - The image title
* @returns {sap.m.LightBoxItem} Pointer to the control instance for chaining.
*/
public setTitle(sTitle: string): sap.m.LightBoxItem;
}
/**
* Types of LightBox loading stages
*/
export enum LightBoxLoadingStates {
/**
* The LightBox image could not load.
*/
Error = "Error",
/**
* The LightBox image has loaded.
*/
Loaded = "Loaded",
/**
* The LightBox image is still loading.
*/
Loading = "Loading",
/**
* The LightBox image has timed out, could not load.
*/
TimeOutError = "TimeOutError",
}
/**
* A hyperlink control which can be used to trigger actions or to navigate to other applications or web pages.
*/
export class Link extends sap.ui.core.Control {
/**
* Constructor for a new Link.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.Link} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Link;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.Link} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Link;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.Link
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Link
itself.
*
* Event is fired when the user triggers the link control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Link
itself
* @returns {sap.m.Link} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.Link;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.Link
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Link
itself.
*
* Event is fired when the user triggers the link control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Link
itself
* @returns {sap.m.Link} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.Link;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.Link
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Link} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.Link;
/**
* Creates a new subclass of class sap.m.Link with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected firePress(mParameters?: any): boolean;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEmphasized emphasized}.
*
* Emphasized links look visually more important than regular links.
*
* Default value is false
.
* @returns {boolean} Value of property emphasized
*/
public getEmphasized(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Determines whether the link can be triggered by the user.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getHref href}.
*
* The link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered, this should not be set, but instead an event handler for the "press" event should be registered.
* @returns {sap.ui.core.URI} Value of property href
*/
public getHref(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.m.Link.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSubtle subtle}.
*
* Subtle links look more like standard text than like links. They should only be used to help with visual hierarchy between large data lists of important and less important links. Subtle links should not be used in any other use case.
*
* Default value is false
.
* @returns {boolean} Value of property subtle
*/
public getSubtle(): boolean;
/**
* Gets current value of property {@link #getTarget target}.
*
* Options are the standard values for window.open() supported by browsers: _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered. This property is only used when the href property is set.
* @returns {string} Value of property target
*/
public getTarget(): string;
/**
* Gets current value of property {@link #getText text}.
*
* Link text to be displayed.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextAlign textAlign}.
*
* Sets the horizontal alignment of the text.
*
* Default value is Initial
.
* @returns {sap.ui.core.TextAlign} Value of property textAlign
*/
public getTextAlign(): sap.ui.core.TextAlign;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* This property specifies the element's text directionality with enumerated options. By default, the control inherits text direction from the parent DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the link (CSS-size such as % or px). When it is set, this is the exact size. When left blank, the text defines the size.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getWrapping wrapping}.
*
* Determines whether the link text is allowed to wrap when there is not sufficient space.
*
* Default value is false
.
* @returns {boolean} Value of property wrapping
*/
public getWrapping(): boolean;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getEmphasized emphasized}.
*
* Emphasized links look visually more important than regular links.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEmphasized - New value for property emphasized
* @returns {sap.m.Link} Reference to this
in order to allow method chaining
*/
public setEmphasized(bEmphasized: boolean): sap.m.Link;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Determines whether the link can be triggered by the user.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.Link} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.Link;
/**
* Sets a new value for property {@link #getHref href}.
*
* The link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered, this should not be set, but instead an event handler for the "press" event should be registered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sHref - New value for property href
* @returns {sap.m.Link} Reference to this
in order to allow method chaining
*/
public setHref(sHref: sap.ui.core.URI): sap.m.Link;
/**
* Sets a new value for property {@link #getSubtle subtle}.
*
* Subtle links look more like standard text than like links. They should only be used to help with visual hierarchy between large data lists of important and less important links. Subtle links should not be used in any other use case.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSubtle - New value for property subtle
* @returns {sap.m.Link} Reference to this
in order to allow method chaining
*/
public setSubtle(bSubtle: boolean): sap.m.Link;
/**
* Sets a new value for property {@link #getTarget target}.
*
* Options are the standard values for window.open() supported by browsers: _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered. This property is only used when the href property is set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTarget - New value for property target
* @returns {sap.m.Link} Reference to this
in order to allow method chaining
*/
public setTarget(sTarget: string): sap.m.Link;
/**
* Sets a new value for property {@link #getText text}.
*
* Link text to be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sText - New value for property text
* @returns {sap.m.Link} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.Link;
/**
* Sets a new value for property {@link #getTextAlign textAlign}.
*
* Sets the horizontal alignment of the text.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Initial
.
* @param {sap.ui.core.TextAlign} sTextAlign - New value for property textAlign
* @returns {sap.m.Link} Reference to this
in order to allow method chaining
*/
public setTextAlign(sTextAlign: sap.ui.core.TextAlign): sap.m.Link;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* This property specifies the element's text directionality with enumerated options. By default, the control inherits text direction from the parent DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.Link} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.Link;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of the link (CSS-size such as % or px). When it is set, this is the exact size. When left blank, the text defines the size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.Link} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.Link;
/**
* Sets a new value for property {@link #getWrapping wrapping}.
*
* Determines whether the link text is allowed to wrap when there is not sufficient space.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bWrapping - New value for property wrapping
* @returns {sap.m.Link} Reference to this
in order to allow method chaining
*/
public setWrapping(bWrapping: boolean): sap.m.Link;
}
/**
* Enumeration for possible link-to-anchor conversion strategy.
*/
export enum LinkConversion {
/**
* Valid links with protocols, such as http, https, ftp and those starting with the string "www".
*/
All = "All",
/**
* Default mode (no conversion).
*/
None = "None",
/**
* Valid links with protocols, such as http, https, ftp.
*/
ProtocolOnly = "ProtocolOnly",
}
/**
* The List control provides a container for all types of list items.
* For mobile devices, the recommended limit of list items is 100 to assure proper performance. To improve initial rendering of large lists, use the "growing" feature. Please refer to the SAPUI5 Developer Guide for more information..
*/
export class List extends sap.m.ListBase {
/**
* Constructor for a new List.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some column to the aggregation {@link #getColumns columns}.
* @param {sap.m.Column} oColumn - the column to add; if empty, nothing is inserted
* @returns {sap.m.List} Reference to this
in order to allow method chaining
*/
public addColumn(oColumn: sap.m.Column): sap.m.List;
/**
* Destroys all the columns in the aggregation {@link #getColumns columns}.
* @returns {sap.m.List} Reference to this
in order to allow method chaining
*/
public destroyColumns(): sap.m.List;
/**
* Creates a new subclass of class sap.m.List with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ListBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getBackgroundDesign backgroundDesign}.
*
* Sets the background style of the list. Depending on the theme, you can change the state of the background from Solid
to Translucent
or to Transparent
.
*
* Default value is Solid
.
* @returns {sap.m.BackgroundDesign} Value of property backgroundDesign
*/
public getBackgroundDesign(): sap.m.BackgroundDesign;
/**
* Gets content of aggregation {@link #getColumns columns}.
*
* Defines columns of the list.
* @returns {sap.m.Column[]}
*/
public getColumns(): sap.m.Column[];
/**
* Returns a metadata object for class sap.m.List.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.m.Column
in the aggregation {@link #getColumns columns}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Column} oColumn - The column whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfColumn(oColumn: sap.m.Column): number;
/**
* Inserts a column into the aggregation {@link #getColumns columns}.
* @param {sap.m.Column} oColumn - the column to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the column should be inserted at; for a negative value of iIndex
, the column is inserted at position 0; for a value greater than the current size of the aggregation, the column is inserted at the last position
* @returns {sap.m.List} Reference to this
in order to allow method chaining
*/
public insertColumn(oColumn: sap.m.Column, iIndex: number): sap.m.List;
/**
* Removes all the controls from the aggregation {@link #getColumns columns}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Column[]} An array of the removed elements (might be empty)
*/
public removeAllColumns(): sap.m.Column[];
/**
* Removes a column from the aggregation {@link #getColumns columns}.
* @param {number|string|sap.m.Column} vColumn - The column to remove or its index or id
* @returns {sap.m.Column} The removed column or null
*/
public removeColumn(vColumn: number|string|sap.m.Column): sap.m.Column;
/**
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
*
* Sets the background style of the list. Depending on the theme, you can change the state of the background from Solid
to Translucent
or to Transparent
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Solid
.
* @param {sap.m.BackgroundDesign} sBackgroundDesign - New value for property backgroundDesign
* @returns {sap.m.List} Reference to this
in order to allow method chaining
*/
public setBackgroundDesign(sBackgroundDesign: sap.m.BackgroundDesign): sap.m.List;
}
/**
* The sap.m.ListBase
control provides a base functionality of the sap.m.List
and sap.m.Table
controls. Selection, deletion, unread states and inset style are also maintained in sap.m.ListBase
.
*
* Note: The ListBase including all contained items may be completely re-rendered when the data of a bound model is changed. Due to the limited hardware resources of mobile devices this can lead to longer delays for lists that contain many items. As such the usage of a list is not recommended for these use cases.
*/
export class ListBase extends sap.ui.core.Control {
/**
* Constructor for a new ListBase.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.ListBase;
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.m.ListItemBase} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.m.ListItemBase): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:delete delete} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires when delete icon is pressed by user.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachDelete(fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:delete delete} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires when delete icon is pressed by user.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachDelete(oData: any, fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:growingFinished growingFinished} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires after the new growing chunk has been fetched from the model and processed by the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachGrowingFinished(fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:growingFinished growingFinished} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires after the new growing chunk has been fetched from the model and processed by the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachGrowingFinished(oData: any, fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:growingStarted growingStarted} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires before the new growing chunk is requested from the model.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachGrowingStarted(fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:growingStarted growingStarted} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires before the new growing chunk is requested from the model.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachGrowingStarted(oData: any, fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:itemPress itemPress} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires when an item is pressed unless the item's type
property is Inactive
.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachItemPress(fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:itemPress itemPress} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires when an item is pressed unless the item's type
property is Inactive
.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachItemPress(oData: any, fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires when selection is changed via user interaction. In MultiSelect
mode, this event is also fired on deselection.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires when selection is changed via user interaction. In MultiSelect
mode, this event is also fired on deselection.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChange selectionChange} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires when selection is changed via user interaction inside the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachSelectionChange(fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChange selectionChange} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires when selection is changed via user interaction inside the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachSelectionChange(oData: any, fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:swipe swipe} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires after user's swipe action and before the swipeContent
is shown. On the swipe
event handler, swipeContent
can be changed according to the swiped item.
* Calling the preventDefault
method of the event cancels the swipe action.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachSwipe(fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:swipe swipe} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires after user's swipe action and before the swipeContent
is shown. On the swipe
event handler, swipeContent
can be changed according to the swiped item.
* Calling the preventDefault
method of the event cancels the swipe action.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachSwipe(oData: any, fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:updateFinished updateFinished} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires after items
binding is updated and processed by the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachUpdateFinished(fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:updateFinished updateFinished} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires after items
binding is updated and processed by the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachUpdateFinished(oData: any, fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:updateStarted updateStarted} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires before items
binding is updated (e.g. sorting, filtering)
*
* Note: Event handler should not invalidate the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachUpdateStarted(fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:updateStarted updateStarted} event of this sap.m.ListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListBase
itself.
*
* Fires before items
binding is updated (e.g. sorting, filtering)
*
* Note: Event handler should not invalidate the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListBase
itself
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public attachUpdateStarted(oData: any, fnFunction: Function, oListener?: any): sap.m.ListBase;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.m.ListBase;
/**
* Destroys the headerToolbar in the aggregation {@link #getHeaderToolbar headerToolbar}.
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public destroyHeaderToolbar(): sap.m.ListBase;
/**
* Destroys the infoToolbar in the aggregation {@link #getInfoToolbar infoToolbar}.
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public destroyInfoToolbar(): sap.m.ListBase;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.ListBase;
/**
* Destroys the swipeContent in the aggregation {@link #getSwipeContent swipeContent}.
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public destroySwipeContent(): sap.m.ListBase;
/**
* Detaches event handler fnFunction
from the {@link #event:delete delete} event of this sap.m.ListBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public detachDelete(fnFunction: Function, oListener: any): sap.m.ListBase;
/**
* Detaches event handler fnFunction
from the {@link #event:growingFinished growingFinished} event of this sap.m.ListBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public detachGrowingFinished(fnFunction: Function, oListener: any): sap.m.ListBase;
/**
* Detaches event handler fnFunction
from the {@link #event:growingStarted growingStarted} event of this sap.m.ListBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public detachGrowingStarted(fnFunction: Function, oListener: any): sap.m.ListBase;
/**
* Detaches event handler fnFunction
from the {@link #event:itemPress itemPress} event of this sap.m.ListBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public detachItemPress(fnFunction: Function, oListener: any): sap.m.ListBase;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.m.ListBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.m.ListBase;
/**
* Detaches event handler fnFunction
from the {@link #event:selectionChange selectionChange} event of this sap.m.ListBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public detachSelectionChange(fnFunction: Function, oListener: any): sap.m.ListBase;
/**
* Detaches event handler fnFunction
from the {@link #event:swipe swipe} event of this sap.m.ListBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public detachSwipe(fnFunction: Function, oListener: any): sap.m.ListBase;
/**
* Detaches event handler fnFunction
from the {@link #event:updateFinished updateFinished} event of this sap.m.ListBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public detachUpdateFinished(fnFunction: Function, oListener: any): sap.m.ListBase;
/**
* Detaches event handler fnFunction
from the {@link #event:updateStarted updateStarted} event of this sap.m.ListBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public detachUpdateStarted(fnFunction: Function, oListener: any): sap.m.ListBase;
/**
* Creates a new subclass of class sap.m.ListBase with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:delete delete} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
protected fireDelete(mParameters?: any): sap.m.ListBase;
/**
* Fires event {@link #event:growingFinished growingFinished} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
protected fireGrowingFinished(mParameters?: any): sap.m.ListBase;
/**
* Fires event {@link #event:growingStarted growingStarted} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
protected fireGrowingStarted(mParameters?: any): sap.m.ListBase;
/**
* Fires event {@link #event:itemPress itemPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
protected fireItemPress(mParameters?: any): sap.m.ListBase;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.m.ListBase;
/**
* Fires event {@link #event:selectionChange selectionChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
protected fireSelectionChange(mParameters?: any): sap.m.ListBase;
/**
* Fires event {@link #event:swipe swipe} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireSwipe(mParameters?: any): boolean;
/**
* Fires event {@link #event:updateFinished updateFinished} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
protected fireUpdateFinished(mParameters?: any): sap.m.ListBase;
/**
* Fires event {@link #event:updateStarted updateStarted} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
protected fireUpdateStarted(mParameters?: any): sap.m.ListBase;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEnableBusyIndicator enableBusyIndicator}.
*
* When this property is set to true
, the control will automatically display a busy indicator when it detects that data is being loaded. This busy indicator blocks the interaction with the items until data loading is finished.
* By default, the busy indicator will be shown after one second. This behavior can be customized by setting the busyIndicatorDelay
property.
*
* Default value is true
.
* @returns {boolean} Value of property enableBusyIndicator
*/
public getEnableBusyIndicator(): boolean;
/**
* Gets current value of property {@link #getFooterText footerText}.
*
* Defines the footer text that appears in the control.
* @returns {string} Value of property footerText
*/
public getFooterText(): string;
/**
* Gets current value of property {@link #getGrowing growing}.
*
* If set to true
, enables the growing feature of the control to load more items by requesting from the model.
* Note:: This feature only works when an items
aggregation is bound. Growing must not be used together with two-way binding.
*
* Default value is false
.
* @returns {boolean} Value of property growing
*/
public getGrowing(): boolean;
/**
* Gets current value of property {@link #getGrowingDirection growingDirection}.
*
* Defines the direction of the growing feature.
* If set to Downwards
the user has to scroll down to load more items or the growing button is displayed at the bottom.
* If set to Upwards
the user has to scroll up to load more items or the growing button is displayed at the top.
*
* Default value is Downwards
.
* @returns {sap.m.ListGrowingDirection} Value of property growingDirection
*/
public getGrowingDirection(): sap.m.ListGrowingDirection;
/**
* Returns growing information as object with "actual" and "total" keys.
* Note: This function returns "null" if "growing" feature is disabled.
* @returns {any}
*/
public getGrowingInfo(): any;
/**
* Gets current value of property {@link #getGrowingScrollToLoad growingScrollToLoad}.
*
* If set to true, the user can scroll down/up to load more items. Otherwise a growing button is displayed at the bottom/top of the control.
* Note: This property can only be used if the growing
property is set to true
and only if there is one instance of sap.m.List
or sap.m.Table
inside the scrollable scroll container (e.g sap.m.Page
).
*
* Default value is false
.
* @returns {boolean} Value of property growingScrollToLoad
*/
public getGrowingScrollToLoad(): boolean;
/**
* Gets current value of property {@link #getGrowingThreshold growingThreshold}.
*
* Defines the number of items to be requested from the model for each grow.
* This property can only be used if the growing
property is set to true
.
*
* Default value is 20
.
* @returns {number} Value of property growingThreshold
*/
public getGrowingThreshold(): number;
/**
* Gets current value of property {@link #getGrowingTriggerText growingTriggerText}.
*
* Defines the text displayed on the growing button. The default is a translated text ("More") coming from the message bundle.
* This property can only be used if the growing
property is set to true
.
* @returns {string} Value of property growingTriggerText
*/
public getGrowingTriggerText(): string;
/**
* Gets current value of property {@link #getHeaderDesign headerDesign}.
*
* Defines the header style of the control. Possible values are Standard
and Plain
.
*
* Default value is Standard
.
* @returns {sap.m.ListHeaderDesign} Value of property headerDesign
*/
public getHeaderDesign(): sap.m.ListHeaderDesign;
/**
* Gets current value of property {@link #getHeaderText headerText}.
*
* Defines the header text that appears in the control.
* Note: If headerToolbar
aggregation is set, then this property is ignored.
* @returns {string} Value of property headerText
*/
public getHeaderText(): string;
/**
* Gets content of aggregation {@link #getHeaderToolbar headerToolbar}.
*
* The header area can be used as a toolbar to add extra controls for user interactions.
* Note: When set, this overwrites the headerText
property.
* @returns {sap.m.Toolbar}
*/
public getHeaderToolbar(): sap.m.Toolbar;
/**
* Gets current value of property {@link #getIncludeItemInSelection includeItemInSelection}.
*
* Defines whether the items are selectable by clicking on the item itself (true
) rather than having to set the selection control first.
* Note: The SingleSelectMaster
mode also provides this functionality by default.
*
* Default value is false
.
* @returns {boolean} Value of property includeItemInSelection
*/
public getIncludeItemInSelection(): boolean;
/**
* Gets content of aggregation {@link #getInfoToolbar infoToolbar}.
*
* A toolbar that is placed below the header to show extra information to the user.
* @returns {sap.m.Toolbar}
*/
public getInfoToolbar(): sap.m.Toolbar;
/**
* Gets current value of property {@link #getInset inset}.
*
* Defines the indentation of the container. Setting it to true
indents the list.
*
* Default value is false
.
* @returns {boolean} Value of property inset
*/
public getInset(): boolean;
/**
* Returns ItemNavigation for controls uses List
* @returns {sap.ui.core.delegate.ItemNavigation|any}
*/
protected getItemNavigation(): sap.ui.core.delegate.ItemNavigation|any;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Defines the items contained within this control.
* @returns {sap.m.ListItemBase[]}
*/
public getItems(): sap.m.ListItemBase[];
/**
* Gets current value of property {@link #getKeyboardMode keyboardMode}.
*
* Defines keyboard handling behavior of the control.
*
* Default value is Navigation
.
* @returns {sap.m.ListKeyboardMode} Value of property keyboardMode
*/
public getKeyboardMode(): sap.m.ListKeyboardMode;
/**
* Returns the last list mode, the mode that is rendered
* This can be used to detect mode changes during rendering
* @returns {any}
*/
protected getLastMode(): any;
/**
* Returns a metadata object for class sap.m.ListBase.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMode mode}.
*
* Defines the mode of the control (e.g. None
, SingleSelect
, MultiSelect
, Delete
).
*
* Default value is None
.
* @returns {sap.m.ListMode} Value of property mode
*/
public getMode(): sap.m.ListMode;
/**
* Gets current value of property {@link #getModeAnimationOn modeAnimationOn}.
*
* Defines if animations will be shown while switching between modes.
*
* Default value is true
.
* @returns {boolean} Value of property modeAnimationOn
*/
public getModeAnimationOn(): boolean;
/**
* Gets current value of property {@link #getNoDataText noDataText}.
*
* This text is displayed when the control contains no items.
* @returns {string} Value of property noDataText
*/
public getNoDataText(): string;
/**
* Gets current value of property {@link #getRememberSelections rememberSelections}.
*
* If set to true, this control remembers and retains the selection of the items after a binding update has been performed (e.g. sorting, filtering).
* Note: This feature works only if two-way data binding for the selected
property of the item is not used. It also needs to be turned off if the binding context of the item does not always point to the same entry in the model, for example, if the order of the data in the JSONModel
is changed.
*
* Default value is true
.
* @returns {boolean} Value of property rememberSelections
*/
public getRememberSelections(): boolean;
/**
* Returns the binding contexts of the selected items.
* Note: This method returns an empty array if no databinding is used.
* @param {boolean} bAll - Set true to include even invisible selected items(e.g. the selections from the previous filters). Note: In single selection modes, only the last selected item's binding context is returned in array.
* @returns {any[]}
*/
public getSelectedContexts(bAll: boolean): any[];
/**
* Returns selected list item. When no item is selected, "null" is returned. When "multi-selection" is enabled and multiple items are selected, only the up-most selected item is returned.
* @returns {sap.m.ListItemBase}
*/
public getSelectedItem(): sap.m.ListItemBase;
/**
* Returns an array containing the selected list items. If no items are selected, an empty array is returned.
* @returns {sap.m.ListItemBase[]}
*/
public getSelectedItems(): sap.m.ListItemBase[];
/**
* Gets current value of property {@link #getShowNoData showNoData}.
*
* Defines whether or not the text specified in the noDataText
property is displayed.
*
* Default value is true
.
* @returns {boolean} Value of property showNoData
*/
public getShowNoData(): boolean;
/**
* Gets current value of property {@link #getShowSeparators showSeparators}.
*
* Defines which item separator style will be used.
*
* Default value is All
.
* @returns {sap.m.ListSeparators} Value of property showSeparators
*/
public getShowSeparators(): sap.m.ListSeparators;
/**
* Gets current value of property {@link #getShowUnread showUnread}.
*
* Activates the unread indicator for all items, if set to true
.
*
* Default value is false
.
* @returns {boolean} Value of property showUnread
*/
public getShowUnread(): boolean;
/**
* Gets content of aggregation {@link #getSwipeContent swipeContent}.
*
* User can swipe to bring in this control on the right hand side of an item.
* Note: For non-touch devices, this functionality is ignored.
* @returns {sap.ui.core.Control}
*/
public getSwipeContent(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getSwipeDirection swipeDirection}.
*
* Defines the direction of the swipe movement (e.g LeftToRight, RightToLeft, Both) to display the control defined in the swipeContent
aggregation.
*
* Default value is Both
.
* @returns {sap.m.SwipeDirection} Value of property swipeDirection
*/
public getSwipeDirection(): sap.m.SwipeDirection;
/**
* Returns swiped list item. When no item is swiped, "null" is returned.
* @returns {sap.m.ListItemBase}
*/
public getSwipedItem(): sap.m.ListItemBase;
/**
* Gets current value of property {@link #getWidth width}.
*
* Sets the width of the control.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.m.ListItemBase
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ListItemBase} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.m.ListItemBase): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.m.ListItemBase} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.m.ListItemBase, iIndex: number): sap.m.ListBase;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ListItemBase[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.m.ListItemBase[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.m.ListItemBase} vItem - The item to remove or its index or id
* @returns {sap.m.ListItemBase} The removed item or null
*/
public removeItem(vItem: number|string|sap.m.ListItemBase): sap.m.ListItemBase;
/**
* Removes visible selections of the current selection mode.
* @param {boolean} bAll - Since version 1.16.3. This control keeps old selections after filter or sorting. Set this parameter "true" to remove all selections.
* @returns {sap.m.ListBase}
*/
public removeSelections(bAll: boolean): sap.m.ListBase;
/**
* Select all items in "MultiSelection" mode.
* @returns {sap.m.ListBase}
*/
public selectAll(): sap.m.ListBase;
/**
* Sets a new value for property {@link #getEnableBusyIndicator enableBusyIndicator}.
*
* When this property is set to true
, the control will automatically display a busy indicator when it detects that data is being loaded. This busy indicator blocks the interaction with the items until data loading is finished.
* By default, the busy indicator will be shown after one second. This behavior can be customized by setting the busyIndicatorDelay
property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableBusyIndicator - New value for property enableBusyIndicator
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setEnableBusyIndicator(bEnableBusyIndicator: boolean): sap.m.ListBase;
/**
* Sets a new value for property {@link #getFooterText footerText}.
*
* Defines the footer text that appears in the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sFooterText - New value for property footerText
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setFooterText(sFooterText: string): sap.m.ListBase;
/**
* Sets a new value for property {@link #getGrowing growing}.
*
* If set to true
, enables the growing feature of the control to load more items by requesting from the model.
* Note:: This feature only works when an items
aggregation is bound. Growing must not be used together with two-way binding.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bGrowing - New value for property growing
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setGrowing(bGrowing: boolean): sap.m.ListBase;
/**
* Sets a new value for property {@link #getGrowingDirection growingDirection}.
*
* Defines the direction of the growing feature.
* If set to Downwards
the user has to scroll down to load more items or the growing button is displayed at the bottom.
* If set to Upwards
the user has to scroll up to load more items or the growing button is displayed at the top.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Downwards
.
* @param {sap.m.ListGrowingDirection} sGrowingDirection - New value for property growingDirection
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setGrowingDirection(sGrowingDirection: sap.m.ListGrowingDirection): sap.m.ListBase;
/**
* Sets a new value for property {@link #getGrowingScrollToLoad growingScrollToLoad}.
*
* If set to true, the user can scroll down/up to load more items. Otherwise a growing button is displayed at the bottom/top of the control.
* Note: This property can only be used if the growing
property is set to true
and only if there is one instance of sap.m.List
or sap.m.Table
inside the scrollable scroll container (e.g sap.m.Page
).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bGrowingScrollToLoad - New value for property growingScrollToLoad
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setGrowingScrollToLoad(bGrowingScrollToLoad: boolean): sap.m.ListBase;
/**
* Sets a new value for property {@link #getGrowingThreshold growingThreshold}.
*
* Defines the number of items to be requested from the model for each grow.
* This property can only be used if the growing
property is set to true
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 20
.
* @param {number} iGrowingThreshold - New value for property growingThreshold
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setGrowingThreshold(iGrowingThreshold: number): sap.m.ListBase;
/**
* Sets a new value for property {@link #getGrowingTriggerText growingTriggerText}.
*
* Defines the text displayed on the growing button. The default is a translated text ("More") coming from the message bundle.
* This property can only be used if the growing
property is set to true
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sGrowingTriggerText - New value for property growingTriggerText
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setGrowingTriggerText(sGrowingTriggerText: string): sap.m.ListBase;
/**
* Sets a new value for property {@link #getHeaderDesign headerDesign}.
*
* Defines the header style of the control. Possible values are Standard
and Plain
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.m.ListHeaderDesign} sHeaderDesign - New value for property headerDesign
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setHeaderDesign(sHeaderDesign: sap.m.ListHeaderDesign): sap.m.ListBase;
/**
* Sets a new value for property {@link #getHeaderText headerText}.
*
* Defines the header text that appears in the control.
* Note: If headerToolbar
aggregation is set, then this property is ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sHeaderText - New value for property headerText
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setHeaderText(sHeaderText: string): sap.m.ListBase;
/**
* Sets the aggregated {@link #getHeaderToolbar headerToolbar}.
* @param {sap.m.Toolbar} oHeaderToolbar - The headerToolbar to set
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setHeaderToolbar(oHeaderToolbar: sap.m.Toolbar): sap.m.ListBase;
/**
* Sets a new value for property {@link #getIncludeItemInSelection includeItemInSelection}.
*
* Defines whether the items are selectable by clicking on the item itself (true
) rather than having to set the selection control first.
* Note: The SingleSelectMaster
mode also provides this functionality by default.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bIncludeItemInSelection - New value for property includeItemInSelection
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setIncludeItemInSelection(bIncludeItemInSelection: boolean): sap.m.ListBase;
/**
* Sets the aggregated {@link #getInfoToolbar infoToolbar}.
* @param {sap.m.Toolbar} oInfoToolbar - The infoToolbar to set
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setInfoToolbar(oInfoToolbar: sap.m.Toolbar): sap.m.ListBase;
/**
* Sets a new value for property {@link #getInset inset}.
*
* Defines the indentation of the container. Setting it to true
indents the list.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bInset - New value for property inset
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setInset(bInset: boolean): sap.m.ListBase;
/**
* Sets a new value for property {@link #getKeyboardMode keyboardMode}.
*
* Defines keyboard handling behavior of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Navigation
.
* @param {sap.m.ListKeyboardMode} sKeyboardMode - New value for property keyboardMode
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setKeyboardMode(sKeyboardMode: sap.m.ListKeyboardMode): sap.m.ListBase;
/**
* Sets a new value for property {@link #getMode mode}.
*
* Defines the mode of the control (e.g. None
, SingleSelect
, MultiSelect
, Delete
).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.m.ListMode} sMode - New value for property mode
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setMode(sMode: sap.m.ListMode): sap.m.ListBase;
/**
* Sets a new value for property {@link #getModeAnimationOn modeAnimationOn}.
*
* Defines if animations will be shown while switching between modes.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bModeAnimationOn - New value for property modeAnimationOn
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setModeAnimationOn(bModeAnimationOn: boolean): sap.m.ListBase;
/**
* Sets a new value for property {@link #getNoDataText noDataText}.
*
* This text is displayed when the control contains no items.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sNoDataText - New value for property noDataText
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setNoDataText(sNoDataText: string): sap.m.ListBase;
/**
* Sets a new value for property {@link #getRememberSelections rememberSelections}.
*
* If set to true, this control remembers and retains the selection of the items after a binding update has been performed (e.g. sorting, filtering).
* Note: This feature works only if two-way data binding for the selected
property of the item is not used. It also needs to be turned off if the binding context of the item does not always point to the same entry in the model, for example, if the order of the data in the JSONModel
is changed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bRememberSelections - New value for property rememberSelections
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setRememberSelections(bRememberSelections: boolean): sap.m.ListBase;
/**
* Selects or deselects the given list item.
* @param {sap.m.ListItemBase} oListItem - The list item whose selection to be changed. This parameter is mandatory.
* @param {boolean} bSelect - Sets selected status of the list item. Default value is true.
* @returns {sap.m.ListBase}
*/
public setSelectedItem(oListItem: sap.m.ListItemBase, bSelect: boolean): sap.m.ListBase;
/**
* Sets a list item to be selected by id. In single mode the method removes the previous selection.
* @param {string} sId - The id of the list item whose selection to be changed.
* @param {boolean} bSelect - Sets selected status of the list item. Default value is true.
* @returns {sap.m.ListBase}
*/
public setSelectedItemById(sId: string, bSelect: boolean): sap.m.ListBase;
/**
* Sets a new value for property {@link #getShowNoData showNoData}.
*
* Defines whether or not the text specified in the noDataText
property is displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowNoData - New value for property showNoData
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setShowNoData(bShowNoData: boolean): sap.m.ListBase;
/**
* Sets a new value for property {@link #getShowSeparators showSeparators}.
*
* Defines which item separator style will be used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is All
.
* @param {sap.m.ListSeparators} sShowSeparators - New value for property showSeparators
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setShowSeparators(sShowSeparators: sap.m.ListSeparators): sap.m.ListBase;
/**
* Sets a new value for property {@link #getShowUnread showUnread}.
*
* Activates the unread indicator for all items, if set to true
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowUnread - New value for property showUnread
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setShowUnread(bShowUnread: boolean): sap.m.ListBase;
/**
* Sets the aggregated {@link #getSwipeContent swipeContent}.
* @param {sap.ui.core.Control} oSwipeContent - The swipeContent to set
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setSwipeContent(oSwipeContent: sap.ui.core.Control): sap.m.ListBase;
/**
* Sets a new value for property {@link #getSwipeDirection swipeDirection}.
*
* Defines the direction of the swipe movement (e.g LeftToRight, RightToLeft, Both) to display the control defined in the swipeContent
aggregation.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Both
.
* @param {sap.m.SwipeDirection} sSwipeDirection - New value for property swipeDirection
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setSwipeDirection(sSwipeDirection: sap.m.SwipeDirection): sap.m.ListBase;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Sets the width of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.ListBase;
/**
* After swipeContent is shown, user can interact with this control(e.g Tap). After interaction is done, you can/should use this method to hide swipeContent from screen.
* Note: If users try to tap inside of the list but outside of the swipeContent then control hides automatically.
* @param {any} oCallback - This callback function is called with two parameters(swipedListItem and swipedContent) after swipe-out animation is finished.
* @returns {sap.m.ListBase}
*/
public swipeOut(oCallback: any): sap.m.ListBase;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.m.ListBase} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.m.ListBase;
}
/**
* Defines the growing direction of the sap.m.List
or sap.m.Table
.
*/
export enum ListGrowingDirection {
/**
* User has to scroll down to load more items or the growing button is displayed at the bottom.
*/
Downwards = "Downwards",
/**
* User has to scroll up to load more items or the growing button is displayed at the top.
* Note: If this option is active, there should not be any other control than sap.m.List
inside its ScollContainer
.
*/
Upwards = "Upwards",
}
/**
* Defines the different header styles.
*/
export enum ListHeaderDesign {
/**
* Plain header style
*/
Plain = "Plain",
/**
* Standard header style
*/
Standard = "Standard",
}
/**
* ListItemBase contains the base features of all specific list items.
*/
export class ListItemBase extends sap.ui.core.Control {
/**
* Returns the state of the item selection as a boolean
*/
public isSelected: any;
/**
* Constructor for a new ListItemBase.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.ListItemBase;
/**
* Attaches event handler fnFunction
to the {@link #event:detailPress detailPress} event of this sap.m.ListItemBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListItemBase
itself.
*
* Fires when the user clicks on the detail button of the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListItemBase
itself
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public attachDetailPress(fnFunction: Function, oListener?: any): sap.m.ListItemBase;
/**
* Attaches event handler fnFunction
to the {@link #event:detailPress detailPress} event of this sap.m.ListItemBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListItemBase
itself.
*
* Fires when the user clicks on the detail button of the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListItemBase
itself
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public attachDetailPress(oData: any, fnFunction: Function, oListener?: any): sap.m.ListItemBase;
/**
* Attaches event handler fnFunction
to the {@link #event:detailTap detailTap} event of this sap.m.ListItemBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListItemBase
itself.
*
* Fires when the user taps on the detail button of the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListItemBase
itself
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public attachDetailTap(fnFunction: Function, oListener?: any): sap.m.ListItemBase;
/**
* Attaches event handler fnFunction
to the {@link #event:detailTap detailTap} event of this sap.m.ListItemBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListItemBase
itself.
*
* Fires when the user taps on the detail button of the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListItemBase
itself
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public attachDetailTap(oData: any, fnFunction: Function, oListener?: any): sap.m.ListItemBase;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.ListItemBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListItemBase
itself.
*
* Fires when the user clicks on the control.
* Note: This event is not fired when the parent mode
is SingleSelectMaster
or when the includeItemInSelection
property is set to true
.
* If there is an interactive element that handles its own press
event then the list item's press
event is not fired.
* Also see {@link sap.m.ListBase#attachItemPress}.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListItemBase
itself
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.ListItemBase;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.ListItemBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListItemBase
itself.
*
* Fires when the user clicks on the control.
* Note: This event is not fired when the parent mode
is SingleSelectMaster
or when the includeItemInSelection
property is set to true
.
* If there is an interactive element that handles its own press
event then the list item's press
event is not fired.
* Also see {@link sap.m.ListBase#attachItemPress}.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListItemBase
itself
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.ListItemBase;
/**
* Attaches event handler fnFunction
to the {@link #event:tap tap} event of this sap.m.ListItemBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListItemBase
itself.
*
* Fires when the user taps on the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListItemBase
itself
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public attachTap(fnFunction: Function, oListener?: any): sap.m.ListItemBase;
/**
* Attaches event handler fnFunction
to the {@link #event:tap tap} event of this sap.m.ListItemBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ListItemBase
itself.
*
* Fires when the user taps on the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ListItemBase
itself
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public attachTap(oData: any, fnFunction: Function, oListener?: any): sap.m.ListItemBase;
/**
* Detaches event handler fnFunction
from the {@link #event:detailPress detailPress} event of this sap.m.ListItemBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public detachDetailPress(fnFunction: Function, oListener: any): sap.m.ListItemBase;
/**
* Detaches event handler fnFunction
from the {@link #event:detailTap detailTap} event of this sap.m.ListItemBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public detachDetailTap(fnFunction: Function, oListener: any): sap.m.ListItemBase;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.ListItemBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.ListItemBase;
/**
* Detaches event handler fnFunction
from the {@link #event:tap tap} event of this sap.m.ListItemBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public detachTap(fnFunction: Function, oListener: any): sap.m.ListItemBase;
/**
* Creates a new subclass of class sap.m.ListItemBase with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:detailPress detailPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
protected fireDetailPress(mParameters?: any): sap.m.ListItemBase;
/**
* Fires event {@link #event:detailTap detailTap} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
protected fireDetailTap(mParameters?: any): sap.m.ListItemBase;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.ListItemBase;
/**
* Fires event {@link #event:tap tap} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
protected fireTap(mParameters?: any): sap.m.ListItemBase;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getCounter counter}.
*
* Defines the counter value of the list items.
* @returns {number} Value of property counter
*/
public getCounter(): number;
/**
* Gets current value of property {@link #getHighlight highlight}.
*
* Defines the highlight state of the list items.
*
* Default value is None
.
* @returns {sap.ui.core.MessageType} Value of property highlight
*/
public getHighlight(): sap.ui.core.MessageType;
/**
* Returns a metadata object for class sap.m.ListItemBase.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the accessibility announcement for the content
* Hook for the subclasses.
* @returns {string}
*/
protected getMode(): string;
/**
* Gets current value of property {@link #getSelected selected}.
*
* Defines the selected state of the list items.
* Note: Binding the selected
property in single selection modes may cause unwanted results if you have more than one selected items in your binding.
*
* Default value is false
.
* @returns {boolean} Value of property selected
*/
public getSelected(): boolean;
/**
* Returns the tabbable DOM elements as a jQuery collection
* @returns {JQuery} jQuery object
*/
protected getTabbables(): JQuery;
/**
* Gets current value of property {@link #getType type}.
*
* Defines the visual indication and behavior of the list items, e.g. Active
, Navigation
, Detail
.
*
* Default value is Inactive
.
* @returns {sap.m.ListType} Value of property type
*/
public getType(): sap.m.ListType;
/**
* Gets current value of property {@link #getUnread unread}.
*
* Activates the unread indicator for the list item, if set to true
.
* Note: This flag is ignored when the showUnread
property of the parent is set to false
.
*
* Default value is false
.
* @returns {boolean} Value of property unread
*/
public getUnread(): boolean;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Whether the control should be visible on the screen. If set to false, a placeholder is rendered instead of the real control.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getCounter counter}.
*
* Defines the counter value of the list items.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iCounter - New value for property counter
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public setCounter(iCounter: number): sap.m.ListItemBase;
/**
* Sets a new value for property {@link #getHighlight highlight}.
*
* Defines the highlight state of the list items.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.MessageType} sHighlight - New value for property highlight
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public setHighlight(sHighlight: sap.ui.core.MessageType): sap.m.ListItemBase;
/**
* Sets a new value for property {@link #getSelected selected}.
*
* Defines the selected state of the list items.
* Note: Binding the selected
property in single selection modes may cause unwanted results if you have more than one selected items in your binding.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSelected - New value for property selected
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public setSelected(bSelected: boolean): sap.m.ListItemBase;
/**
* Sets a new value for property {@link #getType type}.
*
* Defines the visual indication and behavior of the list items, e.g. Active
, Navigation
, Detail
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inactive
.
* @param {sap.m.ListType} sType - New value for property type
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.m.ListType): sap.m.ListItemBase;
/**
* Sets a new value for property {@link #getUnread unread}.
*
* Activates the unread indicator for the list item, if set to true
.
* Note: This flag is ignored when the showUnread
property of the parent is set to false
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bUnread - New value for property unread
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public setUnread(bUnread: boolean): sap.m.ListItemBase;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Whether the control should be visible on the screen. If set to false, a placeholder is rendered instead of the real control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.ListItemBase} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.ListItemBase;
}
/**
* Defines the keyboard handling behavior of the sap.m.List
or sap.m.Table
.
*/
export enum ListKeyboardMode {
/**
* This mode is suitable if the number of items is limited and if there are editable fields within the item.
* While the last/first interactive element within an item has the focus, pressing tab/shift+tab moves the focus to the next/previous element in the tab chain after/before the item .
*/
Edit = "Edit",
/**
* This default mode is suitable if the number of items is unlimited or if there is no editable field within the item.
* While the last/first interactive element within an item has the focus, pressing tab/shift+tab moves the focus to the next/previous element in the tab chain after/before the sap.m.List
or sap.m.Table
.
*/
Navigation = "Navigation",
}
/**
* Defines the mode of the list.
*/
export enum ListMode {
/**
* Delete mode (only one list item can be deleted via provided delete button)
*/
Delete = "Delete",
/**
* Multi selection mode (more than one list item can be selected).
*/
MultiSelect = "MultiSelect",
/**
* Default mode (no selection).
*/
None = "None",
/**
* Right-positioned single selection mode (only one list item can be selected).
*/
SingleSelect = "SingleSelect",
/**
* Left-positioned single selection mode (only one list item can be selected).
*/
SingleSelectLeft = "SingleSelectLeft",
/**
* Selected item is highlighted but no selection control is visible (only one list item can be selected).
*/
SingleSelectMaster = "SingleSelectMaster",
}
/**
* Defines which separator style will be applied for the items.
*/
export enum ListSeparators {
/**
* Separators between the items including the last and the first one.
*/
All = "All",
/**
* Separators between the items.
* Note: This enumeration depends on the theme.
*/
Inner = "Inner",
/**
* No item separators.
*/
None = "None",
}
/**
* Defines the visual indication and behaviour of the list items.
*/
export enum ListType {
/**
* Indicates that the item is clickable via active feedback when item is pressed.
*/
Active = "Active",
/**
* Enables detail button of the list item that fires detailPress
event.
* Also see {@link sap.m.ListItemBase#attachDetailPress}.
*/
Detail = "Detail",
/**
* Enables {@link sap.m.ListType.Detail} and {@link sap.m.ListType.Active} enumerations together.
*/
DetailAndActive = "DetailAndActive",
/**
* Indicates the list item does not have any active feedback when item is pressed.
* Note: Inactive
type cannot be used to disable list items.
*/
Inactive = "Inactive",
/**
* Indicates the list item is navigable to show extra information about the item.
*/
Navigation = "Navigation",
}
/**
* Enumeration of possible load statuses.
*/
export enum LoadState {
/**
* The control is disabled.
*/
Disabled = "Disabled",
/**
* The control failed to load.
*/
Failed = "Failed",
/**
* The control has loaded.
*/
Loaded = "Loaded",
/**
* The control is loading.
*/
Loading = "Loading",
}
/**
* The sap.m.MaskInput
control allows users to easily enter data in a certain format and in a fixed-width input
* (for example: date, time, phone number, credit card number, currency, IP address, MAC address, and others).
*/
export class MaskInput extends sap.m.InputBase {
/**
* Constructor for a new MaskInput.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Gets a replacement string for the character being placed in the input.
* Subclasses may override this method in order to get some additional behavior. For instance, switching current input
* character with other for time input purposes. As an example, if the user enters "2" (in 12-hour format), the consumer may use
* this method to replace the input from "2" to "02".
* @param {string} sChar - The current character from the input
* @param {number} iPlacePosition - The position the character should occupy
* @param {string} sCurrentInputValue - The value currently inside the input field (may differ from the property value)
* @returns {string} A string that replaces the character
*/
protected _feedReplaceChar(sChar: string, iPlacePosition: number, sCurrentInputValue: string): string;
/**
* Verifies whether a character at a given position is allowed according to its mask rule.
* @param {string} sChar - The character
* @param {number} iIndex - The position of the character
*/
protected _isCharAllowed(sChar: string, iIndex: number): void;
/**
* Adds some rule to the aggregation {@link #getRules rules}.
* @param {sap.m.MaskInputRule} oRule - the rule to add; if empty, nothing is inserted
* @returns {sap.m.MaskInput} Reference to this
in order to allow method chaining
*/
public addRule(oRule: sap.m.MaskInputRule): sap.m.MaskInput;
/**
* Destroys all the rules in the aggregation {@link #getRules rules}.
* @returns {sap.m.MaskInput} Reference to this
in order to allow method chaining
*/
public destroyRules(): sap.m.MaskInput;
/**
* Creates a new subclass of class sap.m.MaskInput with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.InputBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getMask mask}.
*
* Mask defined by its characters type (respectively, by its length).
* You should consider the following important facts:
* 1. The mask characters normally correspond to an existing rule (one rule per unique char).
* Characters which don't, are considered immutable characters (for example, the mask '2099', where '9' corresponds to a rule
* for digits, has the characters '2' and '0' as immutable).
* 2. Adding a rule corresponding to the placeholderSymbol
is not recommended and would lead to an unpredictable behavior.
* 3. You can use the special escape character '^' called "Caret" prepending a rule character to make it immutable.
* Use the double escape '^^' if you want to make use of the escape character as an immutable one.
* @returns {string} Value of property mask
*/
public getMask(): string;
/**
* Returns a metadata object for class sap.m.MaskInput.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPlaceholderSymbol placeholderSymbol}.
*
* Defines a placeholder symbol. Shown at the position where there is no user input yet.
*
* Default value is _
.
* @returns {string} Value of property placeholderSymbol
*/
public getPlaceholderSymbol(): string;
/**
* Gets content of aggregation {@link #getRules rules}.
*
* A list of validation rules (one rule per mask character).
* @returns {sap.m.MaskInputRule[]}
*/
public getRules(): sap.m.MaskInputRule[];
/**
* Checks for the provided sap.m.MaskInputRule
in the aggregation {@link #getRules rules}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.MaskInputRule} oRule - The rule whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfRule(oRule: sap.m.MaskInputRule): number;
/**
* Inserts a rule into the aggregation {@link #getRules rules}.
* @param {sap.m.MaskInputRule} oRule - the rule to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the rule should be inserted at; for a negative value of iIndex
, the rule is inserted at position 0; for a value greater than the current size of the aggregation, the rule is inserted at the last position
* @returns {sap.m.MaskInput} Reference to this
in order to allow method chaining
*/
public insertRule(oRule: sap.m.MaskInputRule, iIndex: number): sap.m.MaskInput;
/**
* Removes all the controls from the aggregation {@link #getRules rules}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.MaskInputRule[]} An array of the removed elements (might be empty)
*/
public removeAllRules(): sap.m.MaskInputRule[];
/**
* Removes a rule from the aggregation {@link #getRules rules}.
* @param {number|string|sap.m.MaskInputRule} vRule - The rule to remove or its index or id
* @returns {sap.m.MaskInputRule} The removed rule or null
*/
public removeRule(vRule: number|string|sap.m.MaskInputRule): sap.m.MaskInputRule;
/**
* Setter for property value
.
* @param {string} sValue - New value for property value
.
* @returns {sap.m.MaskInput} this
to allow method chaining.
*/
public setValue(sValue: string): sap.m.MaskInput;
}
/**
* The sap.m.MaskInputRule
control holds the mapping of a single maskFormatSymbol
* to the regular expression regex
that defines the allowed characters for the rule.
*/
export class MaskInputRule extends sap.ui.core.Element {
/**
* Constructor for a new MaskInputRule.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.MaskInputRule with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getMaskFormatSymbol maskFormatSymbol}.
*
* Defines the symbol used in the mask format which will accept a certain range of characters.
*
* Default value is *
.
* @returns {string} Value of property maskFormatSymbol
*/
public getMaskFormatSymbol(): string;
/**
* Returns a metadata object for class sap.m.MaskInputRule.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRegex regex}.
*
* Defines the allowed characters as a regular expression.
*
* Default value is [a-zA-Z0-9]
.
* @returns {string} Value of property regex
*/
public getRegex(): string;
/**
* Sets a new value for property {@link #getMaskFormatSymbol maskFormatSymbol}.
*
* Defines the symbol used in the mask format which will accept a certain range of characters.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is *
.
* @param {string} sMaskFormatSymbol - New value for property maskFormatSymbol
* @returns {sap.m.MaskInputRule} Reference to this
in order to allow method chaining
*/
public setMaskFormatSymbol(sMaskFormatSymbol: string): sap.m.MaskInputRule;
/**
* Sets a new value for property {@link #getRegex regex}.
*
* Defines the allowed characters as a regular expression.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is [a-zA-Z0-9]
.
* @param {string} sRegex - New value for property regex
* @returns {sap.m.MaskInputRule} Reference to this
in order to allow method chaining
*/
public setRegex(sRegex: string): sap.m.MaskInputRule;
}
/**
* The sap.m.Menu
control represents a hierarchical menu.
* When opened on mobile devices it occupies the whole screen.
*/
export class Menu extends sap.ui.core.Control {
/**
* Constructor for a new Menu.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.m.MenuItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.Menu} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.m.MenuItem): sap.m.Menu;
/**
* Attaches event handler fnFunction
to the {@link #event:closed closed} event of this sap.m.Menu
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Menu
itself.
*
* Fired when the menu is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Menu
itself
* @returns {sap.m.Menu} Reference to this
in order to allow method chaining
*/
public attachClosed(fnFunction: Function, oListener?: any): sap.m.Menu;
/**
* Attaches event handler fnFunction
to the {@link #event:closed closed} event of this sap.m.Menu
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Menu
itself.
*
* Fired when the menu is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Menu
itself
* @returns {sap.m.Menu} Reference to this
in order to allow method chaining
*/
public attachClosed(oData: any, fnFunction: Function, oListener?: any): sap.m.Menu;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelected itemSelected} event of this sap.m.Menu
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Menu
itself.
*
* Fired when a MenuItem
is selected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Menu
itself
* @returns {sap.m.Menu} Reference to this
in order to allow method chaining
*/
public attachItemSelected(fnFunction: Function, oListener?: any): sap.m.Menu;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelected itemSelected} event of this sap.m.Menu
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Menu
itself.
*
* Fired when a MenuItem
is selected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Menu
itself
* @returns {sap.m.Menu} Reference to this
in order to allow method chaining
*/
public attachItemSelected(oData: any, fnFunction: Function, oListener?: any): sap.m.Menu;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.Menu} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.m.Menu;
/**
* Closes the Menu
.
*/
public close(): void;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.Menu} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.Menu;
/**
* Detaches event handler fnFunction
from the {@link #event:closed closed} event of this sap.m.Menu
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Menu} Reference to this
in order to allow method chaining
*/
public detachClosed(fnFunction: Function, oListener: any): sap.m.Menu;
/**
* Detaches event handler fnFunction
from the {@link #event:itemSelected itemSelected} event of this sap.m.Menu
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Menu} Reference to this
in order to allow method chaining
*/
public detachItemSelected(fnFunction: Function, oListener: any): sap.m.Menu;
/**
* Creates a new subclass of class sap.m.Menu with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:closed closed} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Menu} Reference to this
in order to allow method chaining
*/
protected fireClosed(mParameters?: any): sap.m.Menu;
/**
* Fires event {@link #event:itemSelected itemSelected} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Menu} Reference to this
in order to allow method chaining
*/
protected fireItemSelected(mParameters?: any): sap.m.Menu;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Defines the items contained within this control.
* @returns {sap.m.MenuItem[]}
*/
public getItems(): sap.m.MenuItem[];
/**
* Returns a metadata object for class sap.m.Menu.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTitle title}.
*
* Defines the Menu
title.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Checks for the provided sap.m.MenuItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.MenuItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.m.MenuItem): number;
/**
* Initializes the control.
*/
public init(): void;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.m.MenuItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.Menu} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.m.MenuItem, iIndex: number): sap.m.Menu;
/**
* Opens the Menu
next to the given control.
* @param {any} oControl - The control that defines the position for the menu
* @param {any} bWithKeyboard - Whether the menu is opened with a shortcut or not
*/
public openBy(oControl: any, bWithKeyboard: any): void;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.MenuItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.m.MenuItem[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.m.MenuItem} vItem - The item to remove or its index or id
* @returns {sap.m.MenuItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.m.MenuItem): sap.m.MenuItem;
/**
* Sets the title of the Menu
.
* @param {string} sTitle - The new title of the Menu
*/
public setTitle(sTitle: string): void;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.m.Menu} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.m.Menu;
}
/**
* The sap.m.MenuButton
control enables the user to show a hierarchical menu.
*/
export class MenuButton extends sap.ui.core.Control {
/**
* Constructor for a new MenuButton.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:defaultAction defaultAction} event of this sap.m.MenuButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MenuButton
itself.
*
* Fired when the buttonMode
is set to Split
and the user presses the main button
* unless useDefaultActionOnly
is set to false
and another action
* from the menu has been selected previously.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MenuButton
itself
* @returns {sap.m.MenuButton} Reference to this
in order to allow method chaining
*/
public attachDefaultAction(fnFunction: Function, oListener?: any): sap.m.MenuButton;
/**
* Attaches event handler fnFunction
to the {@link #event:defaultAction defaultAction} event of this sap.m.MenuButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MenuButton
itself.
*
* Fired when the buttonMode
is set to Split
and the user presses the main button
* unless useDefaultActionOnly
is set to false
and another action
* from the menu has been selected previously.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MenuButton
itself
* @returns {sap.m.MenuButton} Reference to this
in order to allow method chaining
*/
public attachDefaultAction(oData: any, fnFunction: Function, oListener?: any): sap.m.MenuButton;
/**
* Destroys the menu in the aggregation {@link #getMenu menu}.
* @returns {sap.m.MenuButton} Reference to this
in order to allow method chaining
*/
public destroyMenu(): sap.m.MenuButton;
/**
* Detaches event handler fnFunction
from the {@link #event:defaultAction defaultAction} event of this sap.m.MenuButton
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MenuButton} Reference to this
in order to allow method chaining
*/
public detachDefaultAction(fnFunction: Function, oListener: any): sap.m.MenuButton;
/**
* Creates a new subclass of class sap.m.MenuButton with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:defaultAction defaultAction} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MenuButton} Reference to this
in order to allow method chaining
*/
protected fireDefaultAction(mParameters?: any): sap.m.MenuButton;
/**
* Gets current value of property {@link #getActiveIcon activeIcon}.
*
* The source property of an alternative icon for the active (pressed) state of the button.
* Both active and default icon properties should be defined and of the same type - image or icon font.
* If the icon
property is not set or has a different type, the active icon is not displayed.
* @returns {sap.ui.core.URI} Value of property activeIcon
*/
public getActiveIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getButtonMode buttonMode}.
*
* Defines whether the MenuButton
is set to Regular
or Split
mode.
*
* Default value is Regular
.
* @returns {sap.m.MenuButtonMode} Value of property buttonMode
*/
public getButtonMode(): sap.m.MenuButtonMode;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Boolean property to enable the control (default is true
).
* true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Defines the icon to be displayed as a graphical element within the button.
* It can be an image or an icon from the icon font.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconDensityAware iconDensityAware}.
*
* When set to true
(default), one or more requests are sent trying to get the
* density perfect version of image if this version of image doesn't exist on the server.
* If only one version of image is provided, set this value to false
to
* avoid the attempt of fetching density perfect image.
*
* Default value is true
.
* @returns {boolean} Value of property iconDensityAware
*/
public getIconDensityAware(): boolean;
/**
* Gets content of aggregation {@link #getMenu menu}.
*
* Defines the menu that opens for this button.
* @returns {sap.m.Menu}
*/
public getMenu(): sap.m.Menu;
/**
* Returns a metadata object for class sap.m.MenuButton.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* Defines the text of the MenuButton
.
* Split
buttonMode
with useDefaultActionOnly
* set to false
, the text is changed to display the last selected item's text,
* while in Regular
buttonMode the text stays unchanged.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Specifies the element's text directionality with enumerated options.
* By default, the control inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getType type}.
*
* Defines the type of the MenuButton
(for example, Default, Accept, Reject, Back, etc.)
*
* Default value is Default
.
* @returns {sap.m.ButtonType} Value of property type
*/
public getType(): sap.m.ButtonType;
/**
* Gets current value of property {@link #getUseDefaultActionOnly useDefaultActionOnly}.
*
* Controls whether the default action handler is invoked always or it is invoked only until a menu item is selected.
* Usable only if buttonMode
is set to Split
.
*
* Default value is false
.
* @returns {boolean} Value of property useDefaultActionOnly
*/
public getUseDefaultActionOnly(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the MenuButton
.
*
Note:As per visual design this width can be maximum of 12rem (192px).
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Initializes the control.
*/
public init(): void;
/**
* Sets a new value for property {@link #getActiveIcon activeIcon}.
*
* The source property of an alternative icon for the active (pressed) state of the button.
* Both active and default icon properties should be defined and of the same type - image or icon font.
* If the icon
property is not set or has a different type, the active icon is not displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sActiveIcon - New value for property activeIcon
* @returns {sap.m.MenuButton} Reference to this
in order to allow method chaining
*/
public setActiveIcon(sActiveIcon: sap.ui.core.URI): sap.m.MenuButton;
/**
* Sets the buttonMode
of the control.
* @param {sap.m.MenuButtonMode} sMode - The new button mode
* @returns {sap.m.MenuButton} This instance
*/
public setButtonMode(sMode: sap.m.MenuButtonMode): sap.m.MenuButton;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Boolean property to enable the control (default is true
).
*
Note: Depending on custom settings, the buttons that are disabled have other colors than the enabled ones.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.MenuButton} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.MenuButton;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Defines the icon to be displayed as a graphical element within the button.
* It can be an image or an icon from the icon font.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.MenuButton} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.MenuButton;
/**
* Sets a new value for property {@link #getIconDensityAware iconDensityAware}.
*
* When set to true
(default), one or more requests are sent trying to get the
* density perfect version of image if this version of image doesn't exist on the server.
* If only one version of image is provided, set this value to false
to
* avoid the attempt of fetching density perfect image.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconDensityAware - New value for property iconDensityAware
* @returns {sap.m.MenuButton} Reference to this
in order to allow method chaining
*/
public setIconDensityAware(bIconDensityAware: boolean): sap.m.MenuButton;
/**
* Sets the aggregated {@link #getMenu menu}.
* @param {sap.m.Menu} oMenu - The menu to set
* @returns {sap.m.MenuButton} Reference to this
in order to allow method chaining
*/
public setMenu(oMenu: sap.m.Menu): sap.m.MenuButton;
/**
* Sets a new value for property {@link #getText text}.
*
* Defines the text of the MenuButton
.
*
Note: In Split
buttonMode
with useDefaultActionOnly
* set to false
, the text is changed to display the last selected item's text,
* while in Regular
buttonMode the text stays unchanged.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.m.MenuButton} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.MenuButton;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Specifies the element's text directionality with enumerated options.
* By default, the control inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.MenuButton} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.MenuButton;
/**
* Sets the tooltip for the MenuButton
.
* Can either be an instance of a TooltipBase subclass or a simple string.
* @param {sap.ui.core.TooltipBase} vTooltip - The tooltip that should be shown.
*/
public setTooltip(vTooltip: sap.ui.core.TooltipBase): void;
/**
* Sets a new value for property {@link #getType type}.
*
* Defines the type of the MenuButton
(for example, Default, Accept, Reject, Back, etc.)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Default
.
* @param {sap.m.ButtonType} sType - New value for property type
* @returns {sap.m.MenuButton} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.m.ButtonType): sap.m.MenuButton;
/**
* Sets a new value for property {@link #getUseDefaultActionOnly useDefaultActionOnly}.
*
* Controls whether the default action handler is invoked always or it is invoked only until a menu item is selected.
* Usable only if buttonMode
is set to Split
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bUseDefaultActionOnly - New value for property useDefaultActionOnly
* @returns {sap.m.MenuButton} Reference to this
in order to allow method chaining
*/
public setUseDefaultActionOnly(bUseDefaultActionOnly: boolean): sap.m.MenuButton;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the MenuButton
.
*
Note:As per visual design this width can be maximum of 12rem (192px).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.MenuButton} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.MenuButton;
}
/**
* Different mode for a MenuButton (predefined types)
*/
export enum MenuButtonMode {
/**
* Default regular type (Menu button appears as a regular button, pressing opens a menu)
*/
Regular = "Regular",
/**
* Split type (Menu button appears as a split button, pressing fires the default action a menu,
* pressing the arrow part opens a menu)
*/
Split = "Split",
}
/**
* The MenuItem
control is used for creating items for the sap.m.Menu
.
* It is derived from a core sap.ui.core.Item
.
*/
export class MenuItem extends sap.ui.core.Item {
/**
* Constructor for a new MenuItem
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.m.MenuItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.m.MenuItem): sap.m.MenuItem;
/**
* Attaches event handler fnFunction
to the {@link #event:aggregationChanged aggregationChanged} event of this sap.m.MenuItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MenuItem
itself.
*
* Fired when aggregation of the item changes.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MenuItem
itself
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public attachAggregationChanged(fnFunction: Function, oListener?: any): sap.m.MenuItem;
/**
* Attaches event handler fnFunction
to the {@link #event:aggregationChanged aggregationChanged} event of this sap.m.MenuItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MenuItem
itself.
*
* Fired when aggregation of the item changes.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MenuItem
itself
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public attachAggregationChanged(oData: any, fnFunction: Function, oListener?: any): sap.m.MenuItem;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.MenuItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MenuItem
itself.
*
* Fired after the item has been pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MenuItem
itself
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.MenuItem;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.MenuItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MenuItem
itself.
*
* Fired after the item has been pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MenuItem
itself
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.MenuItem;
/**
* Attaches event handler fnFunction
to the {@link #event:propertyChanged propertyChanged} event of this sap.m.MenuItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MenuItem
itself.
*
* Fired when a property of the item changes.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MenuItem
itself
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public attachPropertyChanged(fnFunction: Function, oListener?: any): sap.m.MenuItem;
/**
* Attaches event handler fnFunction
to the {@link #event:propertyChanged propertyChanged} event of this sap.m.MenuItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MenuItem
itself.
*
* Fired when a property of the item changes.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MenuItem
itself
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public attachPropertyChanged(oData: any, fnFunction: Function, oListener?: any): sap.m.MenuItem;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.m.MenuItem;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.MenuItem;
/**
* Detaches event handler fnFunction
from the {@link #event:aggregationChanged aggregationChanged} event of this sap.m.MenuItem
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public detachAggregationChanged(fnFunction: Function, oListener: any): sap.m.MenuItem;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.MenuItem
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.MenuItem;
/**
* Detaches event handler fnFunction
from the {@link #event:propertyChanged propertyChanged} event of this sap.m.MenuItem
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public detachPropertyChanged(fnFunction: Function, oListener: any): sap.m.MenuItem;
/**
* Creates a new subclass of class sap.m.MenuItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:aggregationChanged aggregationChanged} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
protected fireAggregationChanged(mParameters?: any): sap.m.MenuItem;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.MenuItem;
/**
* Fires event {@link #event:propertyChanged propertyChanged} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
protected firePropertyChanged(mParameters?: any): sap.m.MenuItem;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Defines the icon, which belongs to the item.
* This can be a URI to an image or an icon font URI.
* @returns {string} Value of property icon
*/
public getIcon(): string;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Defines the sub-items contained within this element.
* @returns {sap.m.MenuItem[]}
*/
public getItems(): sap.m.MenuItem[];
/**
* Returns a metadata object for class sap.m.MenuItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getStartsSection startsSection}.
*
* Defines whether a visual separator should be rendered before the item.
* Note: If an item is invisible its separator is also not displayed.
*
* Default value is false
.
* @returns {boolean} Value of property startsSection
*/
public getStartsSection(): boolean;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Defines whether the item should be visible on the screen. If set to false
,
* a placeholder is rendered instead of the real item.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Checks for the provided sap.m.MenuItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.MenuItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.m.MenuItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.m.MenuItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.m.MenuItem, iIndex: number): sap.m.MenuItem;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.MenuItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.m.MenuItem[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.m.MenuItem} vItem - The item to remove or its index or id
* @returns {sap.m.MenuItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.m.MenuItem): sap.m.MenuItem;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Defines the icon, which belongs to the item.
* This can be a URI to an image or an icon font URI.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sIcon - New value for property icon
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: string): sap.m.MenuItem;
/**
* Sets a new value for property {@link #getStartsSection startsSection}.
*
* Defines whether a visual separator should be rendered before the item.
* Note: If an item is invisible its separator is also not displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bStartsSection - New value for property startsSection
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public setStartsSection(bStartsSection: boolean): sap.m.MenuItem;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Defines whether the item should be visible on the screen. If set to false
,
* a placeholder is rendered instead of the real item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.MenuItem;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.m.MenuItem} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.m.MenuItem;
}
/**
* Provides easier methods to create sap.m.Dialog with type sap.m.DialogType.Message, such as standard alerts,
* confirmation dialogs, or arbitrary message dialogs.
*
* As MessageBox
is a static class, a jQuery.sap.require("sap.m.MessageBox");
statement
* must be explicitly executed before the class can be used. Example:
*
* jQuery.sap.require("sap.m.MessageBox");
* sap.m.MessageBox.show(
* "This message should appear in the message box.", {
* icon: sap.m.MessageBox.Icon.INFORMATION,
* title: "My message box title",
* actions: [sap.m.MessageBox.Action.YES, sap.m.MessageBox.Action.NO],
* onClose: function(oAction) { / * do something * / }
* }
* );
*
*/
namespace MessageBox {
/**
* Displays an alert dialog with the given message and an OK button (no icons).
*
*
* sap.m.MessageBox.alert("This message should appear in the alert", {
* title: "Alert", // default
* onClose: null, // default
* styleClass: "" // default
* initialFocus: null // default
* textDirection: sap.ui.core.TextDirection.Inherit // default
* });
*
*
* If a callback is given, it is called after the alert dialog has been closed
* by the user via the OK button. The callback is called with the following signature:
*
*
* function (oAction)
*
*
* where oAction
can be either sap.m.MessageBox.Action.OK when the alert dialog is closed by tapping on the OK button
* or null when the alert dialog is closed by calling sap.m.InstanceManager.closeAllDialogs()
.
*
* The alert dialog opened by this method is processed asynchronously.
* Applications have to use fnCallback
to continue work after the
* user closed the alert dialog.
* @param {string} vMessage - Message to be displayed in the alert dialog. The usage of sap.core.Control as vMassage is deprecated since version 1.30.4.
* @param {any} mOptions - Other options (optional)
*/
function alert(vMessage: string, mOptions?: any): void;
/**
* Displays a confirmation dialog with the given message, a QUESTION icon, an OK button
* and a Cancel button. If a callback is given, it is called after the confirmation box
* has been closed by the user with one of the buttons.
*
*
* sap.m.MessageBox.confirm("This message should appear in the confirmation", {
* title: "Confirm", // default
* onClose: null // default
* styleClass: "" // default
* initialFocus: null // default
* textDirection: sap.ui.core.TextDirection.Inherit // default
* });
*
*
* The callback is called with the following signature
*
*
* function(oAction)
*
*
* where oAction is set by one of the following three values:
* 1. sap.m.MessageBox.Action.OK: OK (confirmed) button is tapped.
* 2. sap.m.MessageBox.Action.Cancel: Cancel (unconfirmed) button is tapped.
* 3. null: Confirm dialog is closed by calling sap.m.InstanceManager.closeAllDialogs()
*
* The confirmation dialog opened by this method is processed asynchronously.
* Applications have to use fnCallback
to continue work after the
* user closed the confirmation dialog
* @param {string} vMessage - Message to be displayed in the alert dialog. The usage of sap.core.Control as vMassage is deprecated since version 1.30.4.
* @param {any} mOptions - Other options (optional)
*/
function confirm(vMessage: string, mOptions?: any): void;
/**
* Displays an error dialog with the given message, an ERROR icon, a CLOSE button..
* If a callback is given, it is called after the error box
* has been closed by the user with one of the buttons.
*
*
* sap.m.MessageBox.error("This message should appear in the error message box", {
* title: "Error", // default
* onClose: null // default
* styleClass: "" // default
* initialFocus: null // default
* textDirection: sap.ui.core.TextDirection.Inherit // default
* });
*
*
* The callback is called with the following signature
*
*
*
* function (oAction)
*
*
* The error dialog opened by this method is processed asynchronously.
* Applications have to use fnCallback
to continue work after the
* user closed the error dialog.
* @param {string} vMessage - Message to be displayed in the alert dialog. The usage of sap.core.Control as vMassage is deprecated since version 1.30.4.
* @param {any} mOptions - Other options (optional)
*/
function error(vMessage: string, mOptions?: any): void;
/**
* Displays an information dialog with the given message, an INFO icon, an OK button.
* If a callback is given, it is called after the info box
* has been closed by the user with one of the buttons.
*
*
* sap.m.MessageBox.information("This message should appear in the information message box", {
* title: "Information", // default
* onClose: null // default
* styleClass: "" // default
* initialFocus: null // default
* textDirection: sap.ui.core.TextDirection.Inherit // default
* });
*
*
* The callback is called with the following signature
* *
*
* function (oAction)
*
*
* The information dialog opened by this method is processed asynchronously.
* Applications have to use fnCallback
to continue work after the
* user closed the information dialog
* @param {string} vMessage - Message to be displayed in the alert dialog. The usage of sap.core.Control as vMassage is deprecated since version 1.30.4.
* @param {any} mOptions - Other options (optional)
*/
function information(vMessage: string, mOptions?: any): void;
/**
* Creates and displays an sap.m.Dialog with type sap.m.DialogType.Message with the given text and buttons, and optionally other parts.
* After the user has tapped a button, the onClose
function is invoked when given.
*
* The only mandatory parameter is vMessage
. Either a string with the corresponding text or even
* a layout control could be provided.
*
*
* sap.m.MessageBox.show("This message should appear in the message box", {
* icon: sap.m.MessageBox.Icon.NONE, // default
* title: "", // default
* actions: sap.m.MessageBox.Action.OK // default
* onClose: null // default
* styleClass: "" // default
* initialFocus: null // default
* textDirection: sap.ui.core.TextDirection.Inherit // default
* });
*
*
* The created dialog is executed asynchronously. When it has been created and registered for rendering,
* this function returns without waiting for a user reaction.
*
* When applications have to react on the users choice, they have to provide a callback function and
* postpone any reaction on the user choice until that callback is triggered.
*
* The signature of the callback is
*
* function (oAction);
*
* where oAction
is the button that the user has tapped. For example, when the user has pressed the close button,
* an sap.m.MessageBox.Action.Close is returned.
* @param {string} vMessage - Message to be displayed in the alert dialog. The usage of sap.core.Control as vMassage is deprecated since version 1.30.4.
* @param {any} mOptions - Other options (optional)
*/
function show(vMessage: string, mOptions?: any): void;
/**
* Displays a success dialog with the given message, a SUCCESS icon, an OK button.
* If a callback is given, it is called after the success box
* has been closed by the user with one of the buttons.
*
*
* sap.m.MessageBox.success("This message should appear in the success message box", {
* title: "Success", // default
* onClose: null // default
* styleClass: "" // default
* initialFocus: null // default
* textDirection: sap.ui.core.TextDirection.Inherit // default
* });
*
*
* The callback is called with the following signature
*
*
* function(oAction)
*
*
* The success dialog opened by this method is processed asynchronously.
* Applications have to use fnCallback
to continue work after the
* user closed the success dialog
* @param {string} vMessage - Message to be displayed in the alert dialog. The usage of sap.core.Control as vMassage is deprecated since version 1.30.4.
* @param {any} mOptions - Other options (optional)
*/
function success(vMessage: string, mOptions?: any): void;
/**
* Displays a warning dialog with the given message, a WARNING icon, an OK button.
* If a callback is given, it is called after the warning box
* has been closed by the user with one of the buttons.
*
*
* sap.m.MessageBox.warning("This message should appear in the warning message box", {
* title: "Warning", // default
* onClose: null // default
* styleClass: "" // default
* initialFocus: null // default
* textDirection: sap.ui.core.TextDirection.Inherit // default
* });
*
*
* The callback is called with the following signature
* *
*
* function (oAction)
*
*
* The warning dialog opened by this method is processed asynchronously.
* Applications have to use fnCallback
to continue work after the
* user closed the warning dialog
* @param {string} vMessage - Message to be displayed in the alert dialog. The usage of sap.core.Control as vMassage is deprecated since version 1.30.4.
* @param {any} mOptions - Other options (optional)
*/
function warning(vMessage: string, mOptions?: any): void;
/**
* Enumeration of supported actions in a MessageBox.
*
* Each action is represented as a button in the message box. The values of this enumeration are used for both,
* specifying the set of allowed actions as well as reporting back the user choice.
*/
export enum Action {
/**
* Adds an "Abort" button to the message box.
*/
ABORT = "ABORT",
/**
* Adds a "Cancel" button to the message box.
*/
CANCEL = "CANCEL",
/**
* Adds a "Close" button to the message box.
*/
CLOSE = "CLOSE",
/**
* Adds a "Delete" button to the message box.
*/
DELETE = "DELETE",
/**
* Adds an "Ignore" button to the message box.
*/
IGNORE = "IGNORE",
/**
* Adds a "No" button to the message box.
*/
NO = "NO",
/**
* Adds an "OK" button to the message box.
*/
OK = "OK",
/**
* Adds a "Retry" button to the message box.
*/
RETRY = "RETRY",
/**
* Adds a "Yes" button to the message box.
*/
YES = "YES",
}
/**
* Enumeration of the pre-defined icons that can be used in a MessageBox.
*/
export enum Icon {
/**
* Shows the error icon in the message box.
*/
ERROR = "ERROR",
/**
* Shows the information icon in the message box.
*/
INFORMATION = "INFORMATION",
/**
* Shows no icon in the message box.
*/
NONE = "NONE",
/**
* Shows the question icon in the message box.
*/
QUESTION = "QUESTION",
/**
* Shows the success icon in the message box.
*/
SUCCESS = "SUCCESS",
/**
* Shows the warning icon in the message box.
*/
WARNING = "WARNING",
}
}
/**
* A wrapper control used to hold different types of system messages.
* Structure
* The message item holds the basic set of properties for a system message:
*
* - Type, title, subtitle and description
* - If the description contains markup, the
markupDescription
needs to be set to true, to ensure it is interpreted correctly.
* - If the long text description can be specified by a URL by setting, the
longtextUrl
property.
* - The message item can have a single {@link sap.m.Link} after the description. It is stored in the
link
aggregation.
* Usage
* Note: The MessageItem control replaces {@link sap.m.MessagePopoverItem} as a more generic wrapper for messages.
*/
export class MessageItem extends sap.ui.core.Item {
/**
* Constructor for a new MessageItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Destroys the link in the aggregation {@link #getLink link}.
* @returns {sap.m.MessageItem} Reference to this
in order to allow method chaining
*/
public destroyLink(): sap.m.MessageItem;
/**
* Creates a new subclass of class sap.m.MessageItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getCounter counter}.
*
* Defines the number of messages for a given message.
* @returns {number} Value of property counter
*/
public getCounter(): number;
/**
* Gets current value of property {@link #getDescription description}.
*
* Specifies detailed description of the message
*
* Default value is
.
* @returns {string} Value of property description
*/
public getDescription(): string;
/**
* Gets current value of property {@link #getGroupName groupName}.
*
* Name of a message group the current item belongs to.
*
* Default value is
.
* @returns {string} Value of property groupName
*/
public getGroupName(): string;
/**
* Gets content of aggregation {@link #getLink link}.
*
* Adds an sap.m.Link control which will be displayed at the end of the description of a message.
* @returns {sap.m.Link}
*/
public getLink(): sap.m.Link;
/**
* Gets current value of property {@link #getLongtextUrl longtextUrl}.
*
* Specifies long text description location URL
* @returns {sap.ui.core.URI} Value of property longtextUrl
*/
public getLongtextUrl(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getMarkupDescription markupDescription}.
*
* Specifies if description should be interpreted as markup
*
* Default value is false
.
* @returns {boolean} Value of property markupDescription
*/
public getMarkupDescription(): boolean;
/**
* Returns a metadata object for class sap.m.MessageItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSubtitle subtitle}.
*
* Specifies the subtitle of the message
* Note: This is only visible when the title
property is not empty.
* @returns {string} Value of property subtitle
*/
public getSubtitle(): string;
/**
* Gets current value of property {@link #getTitle title}.
*
* Specifies the title of the message
*
* Default value is
.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getType type}.
*
* Specifies the type of the message
*
* Default value is Error
.
* @returns {sap.ui.core.MessageType} Value of property type
*/
public getType(): sap.ui.core.MessageType;
/**
* Sets a new value for property {@link #getCounter counter}.
*
* Defines the number of messages for a given message.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iCounter - New value for property counter
* @returns {sap.m.MessageItem} Reference to this
in order to allow method chaining
*/
public setCounter(iCounter: number): sap.m.MessageItem;
/**
* Sets a new value for property {@link #getDescription description}.
*
* Specifies detailed description of the message
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sDescription - New value for property description
* @returns {sap.m.MessageItem} Reference to this
in order to allow method chaining
*/
public setDescription(sDescription: string): sap.m.MessageItem;
/**
* Sets a new value for property {@link #getGroupName groupName}.
*
* Name of a message group the current item belongs to.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sGroupName - New value for property groupName
* @returns {sap.m.MessageItem} Reference to this
in order to allow method chaining
*/
public setGroupName(sGroupName: string): sap.m.MessageItem;
/**
* Sets the aggregated {@link #getLink link}.
* @param {sap.m.Link} oLink - The link to set
* @returns {sap.m.MessageItem} Reference to this
in order to allow method chaining
*/
public setLink(oLink: sap.m.Link): sap.m.MessageItem;
/**
* Sets a new value for property {@link #getLongtextUrl longtextUrl}.
*
* Specifies long text description location URL
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sLongtextUrl - New value for property longtextUrl
* @returns {sap.m.MessageItem} Reference to this
in order to allow method chaining
*/
public setLongtextUrl(sLongtextUrl: sap.ui.core.URI): sap.m.MessageItem;
/**
* Sets a new value for property {@link #getMarkupDescription markupDescription}.
*
* Specifies if description should be interpreted as markup
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bMarkupDescription - New value for property markupDescription
* @returns {sap.m.MessageItem} Reference to this
in order to allow method chaining
*/
public setMarkupDescription(bMarkupDescription: boolean): sap.m.MessageItem;
/**
* Sets a new value for property {@link #getSubtitle subtitle}.
*
* Specifies the subtitle of the message
* Note: This is only visible when the title
property is not empty.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sSubtitle - New value for property subtitle
* @returns {sap.m.MessageItem} Reference to this
in order to allow method chaining
*/
public setSubtitle(sSubtitle: string): sap.m.MessageItem;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Specifies the title of the message
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sTitle - New value for property title
* @returns {sap.m.MessageItem} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.MessageItem;
/**
* Sets type of the MessageItem.
* Note: if you set the type to None it will be handled and rendered as Information.
* @param {sap.ui.core.MessageType} sType - Type of Message
* @returns {sap.m.MessageItem} The MessageItem
*/
public setType(sType: sap.ui.core.MessageType): sap.m.MessageItem;
}
/**
* MessagePage is displayed when there is no data or matching content. There are different use cases where a MessagePage might be visualized, for example:
* - The search query returned no results
* - The app contains no items
* - There are too many items
* - The application is loading
* The layout is unchanged but the text varies depending on the use case.
*
Note: The MessagePage
is not intended to be used as a top-level control,
* but rather used within controls such as NavContainer
, App
, Shell
or other container controls.
*/
export class MessagePage extends sap.ui.core.Control {
/**
* Constructor for a new MessagePage.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.MessagePage;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.MessagePage;
/**
* Attaches event handler fnFunction
to the {@link #event:navButtonPress navButtonPress} event of this sap.m.MessagePage
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePage
itself.
*
* This event is fired when Nav Button is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePage
itself
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public attachNavButtonPress(fnFunction: Function, oListener?: any): sap.m.MessagePage;
/**
* Attaches event handler fnFunction
to the {@link #event:navButtonPress navButtonPress} event of this sap.m.MessagePage
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePage
itself.
*
* This event is fired when Nav Button is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePage
itself
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public attachNavButtonPress(oData: any, fnFunction: Function, oListener?: any): sap.m.MessagePage;
/**
* Destroys the customDescription in the aggregation {@link #getCustomDescription customDescription}.
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public destroyCustomDescription(): sap.m.MessagePage;
/**
* Destroys the customText in the aggregation {@link #getCustomText customText}.
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public destroyCustomText(): sap.m.MessagePage;
/**
* Detaches event handler fnFunction
from the {@link #event:navButtonPress navButtonPress} event of this sap.m.MessagePage
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public detachNavButtonPress(fnFunction: Function, oListener: any): sap.m.MessagePage;
/**
* Creates a new subclass of class sap.m.MessagePage with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:navButtonPress navButtonPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
protected fireNavButtonPress(mParameters?: any): sap.m.MessagePage;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets content of aggregation {@link #getCustomDescription customDescription}.
*
* The (optional) custom description control of this page.
* Use this aggregation when the "description" (sap.m.Text) control needs to be replaced with an sap.m.Link control.
* "description" and "textDirection" setters can be used for this aggregation.
* @returns {sap.m.Link}
*/
public getCustomDescription(): sap.m.Link;
/**
* Gets content of aggregation {@link #getCustomText customText}.
*
* The (optional) custom Text control of this page.
* Use this aggregation when the "text" (sap.m.Text) control needs to be replaced with an sap.m.Link control.
* "text" and "textDirection" setters can be used for this aggregation.
* @returns {sap.m.Link}
*/
public getCustomText(): sap.m.Link;
/**
* Gets current value of property {@link #getDescription description}.
*
* Determines the detailed description that shows additional information on the MessagePage.
*
* Default value is Check the filter settings.
.
* @returns {string} Value of property description
*/
public getDescription(): string;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Determines the icon displayed on the MessagePage.
*
* Default value is sap-icon://documents
.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.m.MessagePage.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowHeader showHeader}.
*
* Determines the visibility of the MessagePage header.
* Can be used to hide the header of the MessagePage when it's embedded in another page.
*
* Default value is true
.
* @returns {boolean} Value of property showHeader
*/
public getShowHeader(): boolean;
/**
* Gets current value of property {@link #getShowNavButton showNavButton}.
*
* Determines the visibility of the navigation button in MessagePage header.
*
* Default value is false
.
* @returns {boolean} Value of property showNavButton
*/
public getShowNavButton(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* Determines the main text displayed on the MessagePage.
*
* Default value is No matching items found.
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Determines the element's text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getTitle title}.
*
* Determines the title in the header of MessagePage.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets the aggregated {@link #getCustomDescription customDescription}.
* @param {sap.m.Link} oCustomDescription - The customDescription to set
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public setCustomDescription(oCustomDescription: sap.m.Link): sap.m.MessagePage;
/**
* Sets the aggregated {@link #getCustomText customText}.
* @param {sap.m.Link} oCustomText - The customText to set
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public setCustomText(oCustomText: sap.m.Link): sap.m.MessagePage;
/**
* Sets a new value for property {@link #getDescription description}.
*
* Determines the detailed description that shows additional information on the MessagePage.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Check the filter settings.
.
* @param {string} sDescription - New value for property description
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public setDescription(sDescription: string): sap.m.MessagePage;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Determines the icon displayed on the MessagePage.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is sap-icon://documents
.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.MessagePage;
/**
* Sets a new value for property {@link #getShowHeader showHeader}.
*
* Determines the visibility of the MessagePage header.
* Can be used to hide the header of the MessagePage when it's embedded in another page.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowHeader - New value for property showHeader
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public setShowHeader(bShowHeader: boolean): sap.m.MessagePage;
/**
* Sets a new value for property {@link #getShowNavButton showNavButton}.
*
* Determines the visibility of the navigation button in MessagePage header.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowNavButton - New value for property showNavButton
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public setShowNavButton(bShowNavButton: boolean): sap.m.MessagePage;
/**
* Sets a new value for property {@link #getText text}.
*
* Determines the main text displayed on the MessagePage.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is No matching items found.
.
* @param {string} sText - New value for property text
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.MessagePage;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Determines the element's text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.MessagePage;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Determines the title in the header of MessagePage.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.MessagePage} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.MessagePage;
}
/**
* A summarized list of different types of messages.
* Overview
* A message popover is used to display a summarized list of different types of messages (errors, warnings, success and information).
* It provides a handy and systemized way to navigate and explore details for every message.
* Notes:
*
* - Messages can have descriptions pre-formatted with HTML markup. In this case, the
markupDescription
has to be set to true
.
* - If the message cannot be fully displayed or includes a long description, the message popover provides navigation to the detailed description.
*
* Structure
* The message popover stores all messages in an association of type {@link sap.m.MessageItem} named items
.
*
* A set of properties determines how the items are rendered:
*
* - counter - An integer that is used to indicate the number of errors for each type
* - type - The type of message
* - title/subtitle - The title and subtitle of the message
* - description - The long text description of the message
*
* Usage
* With the message concept, MessagePopover provides a way to centrally manage messages and show them to the user without additional work for the developer.
* The message popover is triggered from a messaging button in the footer toolbar. If an error has occurred at any validation point,
* the total number of messages should be incremented, but the user's work shouldn't be interrupted.
* Responsive Behavior
* On mobile phones, the message popover is automatically shown in full screen mode.
*/
export class MessagePopover extends sap.ui.core.Control {
/**
* Constructor for a new MessagePopover.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.m.MessageItem|sap.m.MessagePopoverItem} vItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public addItem(vItem: sap.m.MessageItem|sap.m.MessagePopoverItem): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:afterClose afterClose} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired after the popover is closed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachAfterClose(fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:afterClose afterClose} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired after the popover is closed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachAfterClose(oData: any, fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:afterOpen afterOpen} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired after the popover is opened
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachAfterOpen(fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:afterOpen afterOpen} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired after the popover is opened
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachAfterOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired before the popover is closed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachBeforeClose(fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired before the popover is closed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachBeforeClose(oData: any, fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired before the popover is opened
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired before the popover is opened
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelect itemSelect} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired when description is shown
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachItemSelect(fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelect itemSelect} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired when description is shown
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachItemSelect(oData: any, fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:listSelect listSelect} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired when one of the lists is shown when (not) filtered by type
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachListSelect(fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:listSelect listSelect} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired when one of the lists is shown when (not) filtered by type
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachListSelect(oData: any, fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:longtextLoaded longtextLoaded} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired when the long text description data from a remote URL is loaded
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachLongtextLoaded(fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:longtextLoaded longtextLoaded} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired when the long text description data from a remote URL is loaded
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachLongtextLoaded(oData: any, fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:urlValidated urlValidated} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired when a validation of a URL from long text description is ready
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachUrlValidated(fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:urlValidated urlValidated} event of this sap.m.MessagePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessagePopover
itself.
*
* This event will be fired when a validation of a URL from long text description is ready
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessagePopover
itself
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public attachUrlValidated(oData: any, fnFunction: Function, oListener?: any): sap.m.MessagePopover;
/**
* Closes the MessagePopover
* @returns {sap.m.MessagePopover} Reference to the 'this' for chaining purposes
*/
public close(): sap.m.MessagePopover;
/**
* Destroys the headerButton in the aggregation {@link #getHeaderButton headerButton}.
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public destroyHeaderButton(): sap.m.MessagePopover;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.MessagePopover;
/**
* Detaches event handler fnFunction
from the {@link #event:afterClose afterClose} event of this sap.m.MessagePopover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public detachAfterClose(fnFunction: Function, oListener: any): sap.m.MessagePopover;
/**
* Detaches event handler fnFunction
from the {@link #event:afterOpen afterOpen} event of this sap.m.MessagePopover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public detachAfterOpen(fnFunction: Function, oListener: any): sap.m.MessagePopover;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeClose beforeClose} event of this sap.m.MessagePopover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public detachBeforeClose(fnFunction: Function, oListener: any): sap.m.MessagePopover;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeOpen beforeOpen} event of this sap.m.MessagePopover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public detachBeforeOpen(fnFunction: Function, oListener: any): sap.m.MessagePopover;
/**
* Detaches event handler fnFunction
from the {@link #event:itemSelect itemSelect} event of this sap.m.MessagePopover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public detachItemSelect(fnFunction: Function, oListener: any): sap.m.MessagePopover;
/**
* Detaches event handler fnFunction
from the {@link #event:listSelect listSelect} event of this sap.m.MessagePopover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public detachListSelect(fnFunction: Function, oListener: any): sap.m.MessagePopover;
/**
* Detaches event handler fnFunction
from the {@link #event:longtextLoaded longtextLoaded} event of this sap.m.MessagePopover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public detachLongtextLoaded(fnFunction: Function, oListener: any): sap.m.MessagePopover;
/**
* Detaches event handler fnFunction
from the {@link #event:urlValidated urlValidated} event of this sap.m.MessagePopover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public detachUrlValidated(fnFunction: Function, oListener: any): sap.m.MessagePopover;
/**
* Creates a new subclass of class sap.m.MessagePopover with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:afterClose afterClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
protected fireAfterClose(mParameters?: any): sap.m.MessagePopover;
/**
* Fires event {@link #event:afterOpen afterOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
protected fireAfterOpen(mParameters?: any): sap.m.MessagePopover;
/**
* Fires event {@link #event:beforeClose beforeClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
protected fireBeforeClose(mParameters?: any): sap.m.MessagePopover;
/**
* Fires event {@link #event:beforeOpen beforeOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
protected fireBeforeOpen(mParameters?: any): sap.m.MessagePopover;
/**
* Fires event {@link #event:itemSelect itemSelect} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
protected fireItemSelect(mParameters?: any): sap.m.MessagePopover;
/**
* Fires event {@link #event:listSelect listSelect} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
protected fireListSelect(mParameters?: any): sap.m.MessagePopover;
/**
* Fires event {@link #event:longtextLoaded longtextLoaded} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
protected fireLongtextLoaded(mParameters?: any): sap.m.MessagePopover;
/**
* Fires event {@link #event:urlValidated urlValidated} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
protected fireUrlValidated(mParameters?: any): sap.m.MessagePopover;
/**
* Gets current value of property {@link #getAsyncDescriptionHandler asyncDescriptionHandler}.
*
* Callback function for resolving a promise after description has been asynchronously loaded inside this function
* @returns {any} Value of property asyncDescriptionHandler
*/
public getAsyncDescriptionHandler(): any;
/**
* Gets current value of property {@link #getAsyncURLHandler asyncURLHandler}.
*
* Callback function for resolving a promise after a link has been asynchronously validated inside this function
* @returns {any} Value of property asyncURLHandler
*/
public getAsyncURLHandler(): any;
/**
* Gets content of aggregation {@link #getHeaderButton headerButton}.
*
* A custom header button
* @returns {sap.m.Button}
*/
public getHeaderButton(): sap.m.Button;
/**
* Gets current value of property {@link #getInitiallyExpanded initiallyExpanded}.
*
* Sets the initial state of the control - expanded or collapsed. By default the control opens as expanded
*
* Default value is true
.
* @returns {boolean} Value of property initiallyExpanded
*/
public getInitiallyExpanded(): boolean;
/**
* Gets content of aggregation {@link #getItems items}.
*
* A list with message items
* @returns {any}
*/
public getItems(): any;
/**
* Returns a metadata object for class sap.m.MessagePopover.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPlacement placement}.
*
* Determines the position, where the control will appear on the screen. Possible values are: sap.m.VerticalPlacementType.Top, sap.m.VerticalPlacementType.Bottom and sap.m.VerticalPlacementType.Vertical.
* The default value is sap.m.VerticalPlacementType.Vertical. Setting this property while the control is open, will not cause any re-rendering and changing of the position. Changes will only be applied with the next interaction.
*
* Default value is Vertical
.
* @returns {sap.m.VerticalPlacementType} Value of property placement
*/
public getPlacement(): sap.m.VerticalPlacementType;
/**
* Checks for the provided sap.m.MessageItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.MessageItem|sap.m.MessagePopoverItem} vItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(vItem: sap.m.MessageItem|sap.m.MessagePopoverItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.m.MessageItem|sap.m.MessagePopoverItem} vItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public insertItem(vItem: sap.m.MessageItem|sap.m.MessagePopoverItem, iIndex: number): sap.m.MessagePopover;
/**
* The method checks if the MessagePopover is open. It returns true when the MessagePopover is currently open
* (this includes opening and closing animations), otherwise it returns false
* @returns {boolean} Whether the MessagePopover is open
*/
public isOpen(): boolean;
/**
* Opens the MessagePopover
* @param {sap.ui.core.Control} oControl - Control which opens the MessagePopover
* @returns {sap.m.MessagePopover} Reference to the 'this' for chaining purposes
*/
public openBy(oControl: sap.ui.core.Control): sap.m.MessagePopover;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
*/
public removeAllItems(): void;
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.m.MessageItem|sap.m.MessagePopoverItem} vItem - The item to remove or its index or id
* @returns {sap.m.MessageItem|sap.m.MessagePopoverItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.m.MessageItem|sap.m.MessagePopoverItem): sap.m.MessageItem|sap.m.MessagePopoverItem;
/**
* Sets a new value for property {@link #getAsyncDescriptionHandler asyncDescriptionHandler}.
*
* Callback function for resolving a promise after description has been asynchronously loaded inside this function
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oAsyncDescriptionHandler - New value for property asyncDescriptionHandler
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public setAsyncDescriptionHandler(oAsyncDescriptionHandler: any): sap.m.MessagePopover;
/**
* Sets a new value for property {@link #getAsyncURLHandler asyncURLHandler}.
*
* Callback function for resolving a promise after a link has been asynchronously validated inside this function
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oAsyncURLHandler - New value for property asyncURLHandler
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public setAsyncURLHandler(oAsyncURLHandler: any): sap.m.MessagePopover;
/**
* Setter for default description and URL validation callbacks across all instances of MessagePopover
* @param {any} mDefaultHandlers - An object setting default callbacks
*/
protected static setDefaultHandlers(mDefaultHandlers: any): void;
/**
* Sets the aggregated {@link #getHeaderButton headerButton}.
* @param {sap.m.Button} oHeaderButton - The headerButton to set
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public setHeaderButton(oHeaderButton: sap.m.Button): sap.m.MessagePopover;
/**
* Sets a new value for property {@link #getInitiallyExpanded initiallyExpanded}.
*
* Sets the initial state of the control - expanded or collapsed. By default the control opens as expanded
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bInitiallyExpanded - New value for property initiallyExpanded
* @returns {sap.m.MessagePopover} Reference to this
in order to allow method chaining
*/
public setInitiallyExpanded(bInitiallyExpanded: boolean): sap.m.MessagePopover;
/**
* This method toggles between open and closed state of the MessagePopover instance.
* oControl parameter is mandatory in the same way as in 'openBy' method
* @param {sap.ui.core.Control} oControl - Control which opens the MessagePopover
* @returns {sap.m.MessagePopover} Reference to the 'this' for chaining purposes
*/
public toggle(oControl: sap.ui.core.Control): sap.m.MessagePopover;
}
/**
* Items provide information about Error Messages in the page.
*/
export class MessagePopoverItem extends sap.ui.core.Item {
/**
* Constructor for a new MessagePopoverItem.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.MessagePopoverItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.MessagePopoverItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* MessageStrip is a control that enables the embedding of application-related messages in the application.
* There are 4 types of messages: Information, Success, Warning and Error.
* Each message can have a close button, so that it can be removed from the UI if needed.
*/
export class MessageStrip extends sap.ui.core.Control {
/**
* Constructor for a new MessageStrip.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:close close} event of this sap.m.MessageStrip
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessageStrip
itself.
*
* This event will be fired after the container is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessageStrip
itself
* @returns {sap.m.MessageStrip} Reference to this
in order to allow method chaining
*/
public attachClose(fnFunction: Function, oListener?: any): sap.m.MessageStrip;
/**
* Attaches event handler fnFunction
to the {@link #event:close close} event of this sap.m.MessageStrip
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessageStrip
itself.
*
* This event will be fired after the container is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessageStrip
itself
* @returns {sap.m.MessageStrip} Reference to this
in order to allow method chaining
*/
public attachClose(oData: any, fnFunction: Function, oListener?: any): sap.m.MessageStrip;
/**
* Closes the MessageStrip.
* This method sets the visible property of the MessageStrip to false.
* The MessageStrip can be shown again by setting the visible property to true.
*/
public close(): void;
/**
* Destroys the link in the aggregation {@link #getLink link}.
* @returns {sap.m.MessageStrip} Reference to this
in order to allow method chaining
*/
public destroyLink(): sap.m.MessageStrip;
/**
* Detaches event handler fnFunction
from the {@link #event:close close} event of this sap.m.MessageStrip
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MessageStrip} Reference to this
in order to allow method chaining
*/
public detachClose(fnFunction: Function, oListener: any): sap.m.MessageStrip;
/**
* Creates a new subclass of class sap.m.MessageStrip with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:close close} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MessageStrip} Reference to this
in order to allow method chaining
*/
protected fireClose(mParameters?: any): sap.m.MessageStrip;
/**
* Gets current value of property {@link #getCustomIcon customIcon}.
*
* Determines a custom icon which is displayed.
* If none is set, the default icon for this message type is used.
*
* Default value is
.
* @returns {sap.ui.core.URI} Value of property customIcon
*/
public getCustomIcon(): sap.ui.core.URI;
/**
* Gets content of aggregation {@link #getLink link}.
*
* Adds an sap.m.Link control which will be displayed at the end of the message.
* @returns {sap.m.Link}
*/
public getLink(): sap.m.Link;
/**
* Returns a metadata object for class sap.m.MessageStrip.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowCloseButton showCloseButton}.
*
* Determines if the message has a close button in the upper right corner.
*
* Default value is false
.
* @returns {boolean} Value of property showCloseButton
*/
public getShowCloseButton(): boolean;
/**
* Gets current value of property {@link #getShowIcon showIcon}.
*
* Determines if an icon is displayed for the message.
*
* Default value is false
.
* @returns {boolean} Value of property showIcon
*/
public getShowIcon(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* Determines the text of the message.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getType type}.
*
* Determines the type of messages that are displayed in the MessageStrip.
* Possible values are: Information (default), Success, Warning, Error.
* If None is passed, the value is set to Information and a warning is displayed in the console.
*
* Default value is Information
.
* @returns {sap.ui.core.MessageType} Value of property type
*/
public getType(): sap.ui.core.MessageType;
/**
* Sets a new value for property {@link #getCustomIcon customIcon}.
*
* Determines a custom icon which is displayed.
* If none is set, the default icon for this message type is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.URI} sCustomIcon - New value for property customIcon
* @returns {sap.m.MessageStrip} Reference to this
in order to allow method chaining
*/
public setCustomIcon(sCustomIcon: sap.ui.core.URI): sap.m.MessageStrip;
/**
* Sets the aggregated {@link #getLink link}.
* @param {sap.m.Link} oLink - The link to set
* @returns {sap.m.MessageStrip} Reference to this
in order to allow method chaining
*/
public setLink(oLink: sap.m.Link): sap.m.MessageStrip;
/**
* Sets a new value for property {@link #getShowCloseButton showCloseButton}.
*
* Determines if the message has a close button in the upper right corner.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowCloseButton - New value for property showCloseButton
* @returns {sap.m.MessageStrip} Reference to this
in order to allow method chaining
*/
public setShowCloseButton(bShowCloseButton: boolean): sap.m.MessageStrip;
/**
* Sets a new value for property {@link #getShowIcon showIcon}.
*
* Determines if an icon is displayed for the message.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowIcon - New value for property showIcon
* @returns {sap.m.MessageStrip} Reference to this
in order to allow method chaining
*/
public setShowIcon(bShowIcon: boolean): sap.m.MessageStrip;
/**
* Setter for property text.
* Default value is empty/undefined
* @param {string} sText - new value for property text
* @returns {sap.m.MessageStrip} this to allow method chaining
*/
public setText(sText: string): sap.m.MessageStrip;
/**
* Setter for property type.
* Default value is sap.ui.core.MessageType.Information
* @param {sap.ui.core.MessageType} sType - The Message type
* @returns {sap.m.MessageStrip} this to allow method chaining
*/
public setType(sType: sap.ui.core.MessageType): sap.m.MessageStrip;
}
/**
* A small, non-disruptive popup for messages.
* Overview
* A message toast is a small, non-disruptive popup for success or information messages that disappears automatically after a few seconds.
* Toasts automatically disappear after a timeout unless the user moves the mouse over the toast or taps on it.
* Notes:
*
* - If the configured message contains HTML code or script tags, those will be escaped.
* - Line breaks (\r\n, \n\r, \r, \n) will be visualized.
* - Only one message toast can be shown at a time in the same place.
*
* Example:
* Here is an example of a MessageToast with all default options:
*
* sap.m.MessageToast.show("This message should appear in the message toast", {
* duration: 3000, // default
* width: "15em", // default
* my: "center bottom", // default
* at: "center bottom", // default
* of: window, // default
* offset: "0 0", // default
* collision: "fit fit", // default
* onClose: null, // default
* autoClose: true, // default
* animationTimingFunction: "ease", // default
* animationDuration: 1000, // default
* closeOnBrowserNavigation: true // default
* });
*
* Usage
* When to use:
*
* - You want to display a short success of information message.
* - You do not want to interrupt users while they are performing an action.
* - You want to confirm a successful action.
*
* When not to use:
*
* - You want to display an error or warning message.
* - You want to interrupt users while they are performing an action.
* - You want to make sure that users read the message before they leave the page.
* - You want users to be able to copy some part of the message text. (In this case, show a success {@link sap.m.Dialog Message Dialog}.)
*
* Responsive Behavior
* The message toast has the same behavior on all devices. However, you can adjust the width of the control, for example, for use on a desktop device.
*/
namespace MessageToast {
/**
* Creates and displays a simple message toast notification message with the given text, and optionally other options.
*
* The only mandatory parameter is sMessage
.
* @param {string} sMessage - The message to be displayed.
* @param {any} mOptions - Object which can contain all other options. Not all entries in this object are required. This property is optional.
*/
function show(sMessage: string, mOptions?: any): void;
}
/**
* Overview
*
* A {@link sap.m.MessageView} is used to display a summarized list of different types of messages (errors, warnings, success and information).
* It provides a handy and systemized way to navigate and explore details for every message.
* It is meant to be embedded into container controls.
*
* Notes:
*
* - Messages can have descriptions pre-formatted with HTML markup. In this case, the
markupDescription
has to be set to true
.
* - If the message cannot be fully displayed or includes a long description, the MessageView provides navigation to the detailed description.
*
* Structure
*
* The MessageView stores all messages in an association of type {@link sap.m.MessageItem} named items
.
*
* A set of properties determines how the items are rendered:
*
* - counter - An integer that is used to indicate the number of errors for each type
* - type - The type of message
* - title/subtitle - The title and subtitle of the message
* - description - The long text description of the message
*
* Usage
*
* As part of the messaging concept, MessageView provides a way to centrally manage messages and show them to the user without additional work for the developer.
*
*/
export class MessageView {
/**
* Constructor for a new MessageView
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.m.MessageItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.m.MessageItem): sap.m.MessageView;
/**
* Attaches event handler fnFunction
to the {@link #event:afterOpen afterOpen} event of this sap.m.MessageView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessageView
itself.
*
* This event will be fired after the popover is opened
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessageView
itself
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public attachAfterOpen(fnFunction: Function, oListener?: any): sap.m.MessageView;
/**
* Attaches event handler fnFunction
to the {@link #event:afterOpen afterOpen} event of this sap.m.MessageView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessageView
itself.
*
* This event will be fired after the popover is opened
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessageView
itself
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public attachAfterOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.MessageView;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelect itemSelect} event of this sap.m.MessageView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessageView
itself.
*
* This event will be fired when description is shown
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessageView
itself
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public attachItemSelect(fnFunction: Function, oListener?: any): sap.m.MessageView;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelect itemSelect} event of this sap.m.MessageView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessageView
itself.
*
* This event will be fired when description is shown
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessageView
itself
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public attachItemSelect(oData: any, fnFunction: Function, oListener?: any): sap.m.MessageView;
/**
* Attaches event handler fnFunction
to the {@link #event:listSelect listSelect} event of this sap.m.MessageView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessageView
itself.
*
* This event will be fired when one of the lists is shown when (not) filtered by type
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessageView
itself
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public attachListSelect(fnFunction: Function, oListener?: any): sap.m.MessageView;
/**
* Attaches event handler fnFunction
to the {@link #event:listSelect listSelect} event of this sap.m.MessageView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessageView
itself.
*
* This event will be fired when one of the lists is shown when (not) filtered by type
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessageView
itself
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public attachListSelect(oData: any, fnFunction: Function, oListener?: any): sap.m.MessageView;
/**
* Attaches event handler fnFunction
to the {@link #event:longtextLoaded longtextLoaded} event of this sap.m.MessageView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessageView
itself.
*
* This event will be fired when the long text description data from a remote URL is loaded
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessageView
itself
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public attachLongtextLoaded(fnFunction: Function, oListener?: any): sap.m.MessageView;
/**
* Attaches event handler fnFunction
to the {@link #event:longtextLoaded longtextLoaded} event of this sap.m.MessageView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessageView
itself.
*
* This event will be fired when the long text description data from a remote URL is loaded
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessageView
itself
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public attachLongtextLoaded(oData: any, fnFunction: Function, oListener?: any): sap.m.MessageView;
/**
* Attaches event handler fnFunction
to the {@link #event:urlValidated urlValidated} event of this sap.m.MessageView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessageView
itself.
*
* This event will be fired when a validation of a URL from long text description is ready
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessageView
itself
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public attachUrlValidated(fnFunction: Function, oListener?: any): sap.m.MessageView;
/**
* Attaches event handler fnFunction
to the {@link #event:urlValidated urlValidated} event of this sap.m.MessageView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MessageView
itself.
*
* This event will be fired when a validation of a URL from long text description is ready
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MessageView
itself
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public attachUrlValidated(oData: any, fnFunction: Function, oListener?: any): sap.m.MessageView;
/**
* Destroys the headerButton in the aggregation {@link #getHeaderButton headerButton}.
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public destroyHeaderButton(): sap.m.MessageView;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.MessageView;
/**
* Detaches event handler fnFunction
from the {@link #event:afterOpen afterOpen} event of this sap.m.MessageView
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public detachAfterOpen(fnFunction: Function, oListener: any): sap.m.MessageView;
/**
* Detaches event handler fnFunction
from the {@link #event:itemSelect itemSelect} event of this sap.m.MessageView
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public detachItemSelect(fnFunction: Function, oListener: any): sap.m.MessageView;
/**
* Detaches event handler fnFunction
from the {@link #event:listSelect listSelect} event of this sap.m.MessageView
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public detachListSelect(fnFunction: Function, oListener: any): sap.m.MessageView;
/**
* Detaches event handler fnFunction
from the {@link #event:longtextLoaded longtextLoaded} event of this sap.m.MessageView
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public detachLongtextLoaded(fnFunction: Function, oListener: any): sap.m.MessageView;
/**
* Detaches event handler fnFunction
from the {@link #event:urlValidated urlValidated} event of this sap.m.MessageView
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public detachUrlValidated(fnFunction: Function, oListener: any): sap.m.MessageView;
/**
* Creates a new subclass of class sap.m.MessageView with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:afterOpen afterOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
protected fireAfterOpen(mParameters?: any): sap.m.MessageView;
/**
* Fires event {@link #event:itemSelect itemSelect} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
protected fireItemSelect(mParameters?: any): sap.m.MessageView;
/**
* Fires event {@link #event:listSelect listSelect} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
protected fireListSelect(mParameters?: any): sap.m.MessageView;
/**
* Fires event {@link #event:longtextLoaded longtextLoaded} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
protected fireLongtextLoaded(mParameters?: any): sap.m.MessageView;
/**
* Fires event {@link #event:urlValidated urlValidated} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
protected fireUrlValidated(mParameters?: any): sap.m.MessageView;
/**
* Gets current value of property {@link #getAsyncDescriptionHandler asyncDescriptionHandler}.
*
* Callback function for resolving a promise after description has been asynchronously loaded inside this function
* @returns {any} Value of property asyncDescriptionHandler
*/
public getAsyncDescriptionHandler(): any;
/**
* Gets current value of property {@link #getAsyncURLHandler asyncURLHandler}.
*
* Callback function for resolving a promise after a link has been asynchronously validated inside this function
* @returns {any} Value of property asyncURLHandler
*/
public getAsyncURLHandler(): any;
/**
* Gets current value of property {@link #getGroupItems groupItems}.
*
* Defines whether the MessageItems are grouped or not
*
* Default value is false
.
* @returns {boolean} Value of property groupItems
*/
public getGroupItems(): boolean;
/**
* Gets content of aggregation {@link #getHeaderButton headerButton}.
*
* A custom header button
* @returns {sap.m.Button}
*/
public getHeaderButton(): sap.m.Button;
/**
* Gets content of aggregation {@link #getItems items}.
*
* A list with message items
* @returns {sap.m.MessageItem[]}
*/
public getItems(): sap.m.MessageItem[];
/**
* Returns a metadata object for class sap.m.MessageView.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.m.MessageItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.MessageItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.m.MessageItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.m.MessageItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.m.MessageItem, iIndex: number): sap.m.MessageView;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.MessageItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.m.MessageItem[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.m.MessageItem} vItem - The item to remove or its index or id
* @returns {sap.m.MessageItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.m.MessageItem): sap.m.MessageItem;
/**
* Sets a new value for property {@link #getAsyncDescriptionHandler asyncDescriptionHandler}.
*
* Callback function for resolving a promise after description has been asynchronously loaded inside this function
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oAsyncDescriptionHandler - New value for property asyncDescriptionHandler
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public setAsyncDescriptionHandler(oAsyncDescriptionHandler: any): sap.m.MessageView;
/**
* Sets a new value for property {@link #getAsyncURLHandler asyncURLHandler}.
*
* Callback function for resolving a promise after a link has been asynchronously validated inside this function
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oAsyncURLHandler - New value for property asyncURLHandler
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public setAsyncURLHandler(oAsyncURLHandler: any): sap.m.MessageView;
/**
* Setter for default description and URL validation callbacks across all instances of MessageView
* @param {any} mDefaultHandlers - An object setting default callbacks
*/
protected static setDefaultHandlers(mDefaultHandlers: any): void;
/**
* Sets a new value for property {@link #getGroupItems groupItems}.
*
* Defines whether the MessageItems are grouped or not
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bGroupItems - New value for property groupItems
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public setGroupItems(bGroupItems: boolean): sap.m.MessageView;
/**
* Sets the aggregated {@link #getHeaderButton headerButton}.
* @param {sap.m.Button} oHeaderButton - The headerButton to set
* @returns {sap.m.MessageView} Reference to this
in order to allow method chaining
*/
public setHeaderButton(oHeaderButton: sap.m.Button): sap.m.MessageView;
}
/**
* The MultiComboBox control provides a list box with items and a text field allowing the user to either type a value directly into the control or choose from the list of existing items.
*/
export class MultiComboBox extends sap.m.ComboBoxBase {
/**
* Constructor for a new MultiComboBox.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item oItem
to the association named selectedItems
.
* @param {sap.ui.core.Item} oItem - The selected item to add; if empty, nothing is added.
* @returns {sap.m.MultiComboBox} this
to allow method chaining.
*/
public addSelectedItem(oItem: sap.ui.core.Item): sap.m.MultiComboBox;
/**
* Adds selected items. Only items with valid keys are added as selected.
* @param {string[]} aKeys - An array of item keys that identifies the items to be added as selected
* @returns {sap.m.MultiComboBox}
*/
public addSelectedKeys(aKeys: string[]): sap.m.MultiComboBox;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChange selectionChange} event of this sap.m.MultiComboBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MultiComboBox
itself.
*
* Event is fired when selection of an item is changed.
* Note: please do not use the "change" event inherited from sap.m.InputBase
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MultiComboBox
itself
* @returns {sap.m.MultiComboBox} Reference to this
in order to allow method chaining
*/
public attachSelectionChange(fnFunction: Function, oListener?: any): sap.m.MultiComboBox;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChange selectionChange} event of this sap.m.MultiComboBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MultiComboBox
itself.
*
* Event is fired when selection of an item is changed.
* Note: please do not use the "change" event inherited from sap.m.InputBase
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MultiComboBox
itself
* @returns {sap.m.MultiComboBox} Reference to this
in order to allow method chaining
*/
public attachSelectionChange(oData: any, fnFunction: Function, oListener?: any): sap.m.MultiComboBox;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionFinish selectionFinish} event of this sap.m.MultiComboBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MultiComboBox
itself.
*
* Event is fired when user has finished a selection of items in a list box and list box has been closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MultiComboBox
itself
* @returns {sap.m.MultiComboBox} Reference to this
in order to allow method chaining
*/
public attachSelectionFinish(fnFunction: Function, oListener?: any): sap.m.MultiComboBox;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionFinish selectionFinish} event of this sap.m.MultiComboBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MultiComboBox
itself.
*
* Event is fired when user has finished a selection of items in a list box and list box has been closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MultiComboBox
itself
* @returns {sap.m.MultiComboBox} Reference to this
in order to allow method chaining
*/
public attachSelectionFinish(oData: any, fnFunction: Function, oListener?: any): sap.m.MultiComboBox;
/**
* Clear the selection.
*/
protected clearSelection(): void;
/**
* Creates a picker. To be overwritten by subclasses.
* @param {string} sPickerType
* @returns {sap.m.Popover|sap.m.Dialog} The picker pop-up to be used.
*/
protected createPicker(sPickerType: string): sap.m.Popover|sap.m.Dialog;
/**
* Destroys all the items in the aggregation named items
.
* @returns {sap.m.ComboBox} this
to allow method chaining.
*/
public destroyItems(): sap.m.ComboBox;
/**
* Detaches event handler fnFunction
from the {@link #event:selectionChange selectionChange} event of this sap.m.MultiComboBox
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MultiComboBox} Reference to this
in order to allow method chaining
*/
public detachSelectionChange(fnFunction: Function, oListener: any): sap.m.MultiComboBox;
/**
* Detaches event handler fnFunction
from the {@link #event:selectionFinish selectionFinish} event of this sap.m.MultiComboBox
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MultiComboBox} Reference to this
in order to allow method chaining
*/
public detachSelectionFinish(fnFunction: Function, oListener: any): sap.m.MultiComboBox;
/**
* Creates a new subclass of class sap.m.MultiComboBox with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ComboBoxBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:selectionChange selectionChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MultiComboBox} Reference to this
in order to allow method chaining
*/
protected fireSelectionChange(mParameters?: any): sap.m.MultiComboBox;
/**
* Fires event {@link #event:selectionFinish selectionFinish} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MultiComboBox} Reference to this
in order to allow method chaining
*/
protected fireSelectionFinish(mParameters?: any): sap.m.MultiComboBox;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets the enabled items from the aggregation named items
.
* @param {sap.ui.core.Item[]} aItems - Items to filter.
* @returns {sap.ui.core.Item[]} An array containing the enabled items.
*/
public getEnabledItems(aItems?: sap.ui.core.Item[]): sap.ui.core.Item[];
/**
* Gets the item with the given key from the aggregation named items
.
* Note: If duplicate keys exist, the first item matching the key is returned.
* @param {string} sKey - An item key that specifies the item to retrieve.
* @returns {sap.ui.core.Item}
*/
public getItemByKey(sKey: string): sap.ui.core.Item;
/**
* Returns a metadata object for class sap.m.MultiComboBox.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Retrieves the selected item objects from the association named selectedItems
.
* @returns {sap.ui.core.Item[]} Array of sap.ui.core.Item instances. The current target of the selectedItems
association.
*/
public getSelectedItems(): sap.ui.core.Item[];
/**
* Gets current value of property {@link #getSelectedKeys selectedKeys}.
*
* Keys of the selected items. If the key has no corresponding item, no changes will apply. If duplicate keys exists the first item matching the key is used.
*
* Default value is []
.
* @returns {string[]} Value of property selectedKeys
*/
public getSelectedKeys(): string[];
/**
* Inserts an item into the aggregation named items
.
* @param {sap.ui.core.Item} oItem - The item to insert; if empty, nothing is inserted.
* @param {number} iIndex - The 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position.
* @returns {sap.m.MultiComboBox} this
to allow method chaining.
*/
public insertItem(oItem: sap.ui.core.Item, iIndex: number): sap.m.MultiComboBox;
/**
* This hook method is called after the MultiComboBox's Pop-up is rendered.
*/
protected onAfterRenderingPicker(): void;
/**
* This hook method is called before the MultiComboBox's Pop-up is rendered.
*/
protected onBeforeRenderingPicker(): void;
/**
* Removes all the items in the aggregation named items
.
* @returns {sap.ui.core.Item[]} An array of sap.ui.core.Item of the removed items (might be empty).
*/
public removeAllItems(): sap.ui.core.Item[];
/**
* Removes all the controls in the association named {@link #getSelectedItems selectedItems}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllSelectedItems(): sap.ui.core.ID[];
/**
* Removes an item from the aggregation named items
.
* @param {number|string|sap.ui.core.Item} oItem - The item to remove or its index or id.
* @returns {sap.ui.core.Item} The removed item or null.
*/
public removeItem(oItem: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Removes an selectedItem from the association named {@link #getSelectedItems selectedItems}.
* @param {number|sap.ui.core.ID|sap.ui.core.Item} vSelectedItem - The selectedItem to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed selectedItem or null
*/
public removeSelectedItem(vSelectedItem: number|sap.ui.core.ID|sap.ui.core.Item): sap.ui.core.ID;
/**
* Removes selected items. Only items with valid keys are removed.
* @param {string[]} aKeys - An array of item keys that identifies the items to be removed
* @returns {sap.m.MultiComboBox}
*/
public removeSelectedKeys(aKeys: string[]): sap.m.MultiComboBox;
/**
* Setter for association selectedItems
.
* @param {string[]|sap.ui.core.Item[]|null} aItems - new values for association selectedItems
. Array of sap.ui.core.Item Id which becomes the new target of this selectedItems
association. Alternatively, an array of sap.ui.core.Item instance may be given or null.
* @returns {sap.m.MultiComboBox} this
to allow method chaining.
*/
public setSelectedItems(aItems: string[]|sap.ui.core.Item[]|null): sap.m.MultiComboBox;
/**
* Sets a new value for property {@link #getSelectedKeys selectedKeys}.
*
* Keys of the selected items. If the key has no corresponding item, no changes will apply. If duplicate keys exists the first item matching the key is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is []
.
* @param {string[]} sSelectedKeys - New value for property selectedKeys
* @returns {sap.m.MultiComboBox} Reference to this
in order to allow method chaining
*/
public setSelectedKeys(sSelectedKeys: string[]): sap.m.MultiComboBox;
}
/**
* Overview
* A multi-input field allows the user to enter multiple values, which are displayed as {@link sap.m.Token tokens}. These can be displayed in single and multi-line mode.
* You can enable auto-complete suggestions or value help to help the user choose the correct entry. You can define
* validator functions to define what token values are accepted.
* Notes:
*
* - New valid tokens are created, when the user presses Enter, selects a value from the suggestions drop-down, or when the focus leaves the field.
* - Provide meaningful labels for all input fields. Do not use the placeholder as a replacement for the label.
*
* Usage
* When to use:
*
* - You need to provide the value help option to help users select or search multiple business objects.
* - The dataset to choose from is expected to increase over time (for example, to more than 200 values).
*
* When not to use:
*
* - When you need to select only one value.
* - When you want the user to select from a predefined set of options. Use {@link sap.m.MultiComboBox} instead.
*
* Responsive Behavior
* On Phones:
*
* - Only the last entered token is displayed.
* - A new full-screen dialog opens where the auto-complete suggestions can be selected.
* - You can review the tokens by tapping on the token or the input field.
*
* On Tablets:
*
* - The auto-complete suggestions appear below or above the multi-input field.
* - You can review the tokens by swiping them to the left or right.
* - (Multi-line Mode) Previously added tokens are visible above the input field.
*
* On Desktop:
*
* - The auto-complete suggestions appear below or above the multi-input field.
* - You can review the tokens by pressing the right or left arrows on the keyboard.
* - You can select single tokens or a range of tokens and you can copy/cut/delete them.
*
- (Multi-line Mode) Previously added tokens are visible above the input field.
*
*/
export class MultiInput extends sap.m.Input {
/**
* Constructor for a new MultiInput.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some token to the aggregation {@link #getTokens tokens}.
* @param {sap.m.Token} oToken - the token to add; if empty, nothing is inserted
* @returns {sap.m.MultiInput} Reference to this
in order to allow method chaining
*/
public addToken(oToken: sap.m.Token): sap.m.MultiInput;
/**
* Function adds a validation callback called before any new token gets added to the tokens aggregation
* @param {Function} fValidator
*/
public addValidator(fValidator: Function): void;
/**
* Attaches event handler fnFunction
to the {@link #event:tokenChange tokenChange} event of this sap.m.MultiInput
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MultiInput
itself.
*
* Fired when the tokens aggregation changed (add / remove token)
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MultiInput
itself
* @returns {sap.m.MultiInput} Reference to this
in order to allow method chaining
*/
public attachTokenChange(fnFunction: Function, oListener?: any): sap.m.MultiInput;
/**
* Attaches event handler fnFunction
to the {@link #event:tokenChange tokenChange} event of this sap.m.MultiInput
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MultiInput
itself.
*
* Fired when the tokens aggregation changed (add / remove token)
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MultiInput
itself
* @returns {sap.m.MultiInput} Reference to this
in order to allow method chaining
*/
public attachTokenChange(oData: any, fnFunction: Function, oListener?: any): sap.m.MultiInput;
/**
* Attaches event handler fnFunction
to the {@link #event:tokenUpdate tokenUpdate} event of this sap.m.MultiInput
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MultiInput
itself.
*
* Fired when the tokens aggregation changed (add / remove token)
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MultiInput
itself
* @returns {sap.m.MultiInput} Reference to this
in order to allow method chaining
*/
public attachTokenUpdate(fnFunction: Function, oListener?: any): sap.m.MultiInput;
/**
* Attaches event handler fnFunction
to the {@link #event:tokenUpdate tokenUpdate} event of this sap.m.MultiInput
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.MultiInput
itself.
*
* Fired when the tokens aggregation changed (add / remove token)
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.MultiInput
itself
* @returns {sap.m.MultiInput} Reference to this
in order to allow method chaining
*/
public attachTokenUpdate(oData: any, fnFunction: Function, oListener?: any): sap.m.MultiInput;
/**
* Function overwrites clone function to add tokens to MultiInput
* @returns {sap.ui.core.Element} reference to the newly created clone
*/
public clone(): sap.ui.core.Element;
/**
* Close multi-line MultiInput in multi-line mode
*/
public closeMultiLine(): void;
/**
* Destroys all the tokens in the aggregation {@link #getTokens tokens}.
* @returns {sap.m.MultiInput} Reference to this
in order to allow method chaining
*/
public destroyTokens(): sap.m.MultiInput;
/**
* Detaches event handler fnFunction
from the {@link #event:tokenChange tokenChange} event of this sap.m.MultiInput
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MultiInput} Reference to this
in order to allow method chaining
*/
public detachTokenChange(fnFunction: Function, oListener: any): sap.m.MultiInput;
/**
* Detaches event handler fnFunction
from the {@link #event:tokenUpdate tokenUpdate} event of this sap.m.MultiInput
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.MultiInput} Reference to this
in order to allow method chaining
*/
public detachTokenUpdate(fnFunction: Function, oListener: any): sap.m.MultiInput;
/**
* Creates a new subclass of class sap.m.MultiInput with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.Input.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:tokenChange tokenChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MultiInput} Reference to this
in order to allow method chaining
*/
protected fireTokenChange(mParameters?: any): sap.m.MultiInput;
/**
* Fires event {@link #event:tokenUpdate tokenUpdate} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.MultiInput} Reference to this
in order to allow method chaining
*/
protected fireTokenUpdate(mParameters?: any): sap.m.MultiInput;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Get the reference element which the message popup should dock to
* @returns {HTMLElement} Dom Element which the message popup should dock to
*/
protected getDomRefForValueStateMessage(): HTMLElement;
/**
* Gets current value of property {@link #getEnableMultiLineMode enableMultiLineMode}.
*
* If set to true, the MultiInput will be displayed in multi-line display mode.
* In multi-line display mode, all tokens can be fully viewed and easily edited in the MultiInput.
* The default value is false.
* Note: This property does not take effect on smartphones or when the editable property is set to false.
*
* Default value is false
.
* @returns {boolean} Value of property enableMultiLineMode
*/
public getEnableMultiLineMode(): boolean;
/**
* Gets current value of property {@link #getMaxTokens maxTokens}.
*
* The max number of tokens that is allowed in MultiInput.
* @returns {number} Value of property maxTokens
*/
public getMaxTokens(): number;
/**
* Returns a metadata object for class sap.m.MultiInput.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Function returns domref which acts as reference point for the opening suggestion menu
* @returns {HTMLElement} the domref at which to open the suggestion menu
*/
public getPopupAnchorDomRef(): HTMLElement;
/**
* Gets content of aggregation {@link #getTokens tokens}.
*
* The currently displayed tokens
* @returns {sap.m.Token[]}
*/
public getTokens(): sap.m.Token[];
/**
* Checks for the provided sap.m.Token
in the aggregation {@link #getTokens tokens}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Token} oToken - The token whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfToken(oToken: sap.m.Token): number;
/**
* Inserts a token into the aggregation {@link #getTokens tokens}.
* @param {sap.m.Token} oToken - the token to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the token should be inserted at; for a negative value of iIndex
, the token is inserted at position 0; for a value greater than the current size of the aggregation, the token is inserted at the last position
* @returns {sap.m.MultiInput} Reference to this
in order to allow method chaining
*/
public insertToken(oToken: sap.m.Token, iIndex: number): sap.m.MultiInput;
/**
* Focus is on MultiInput
* @param {JQueryEventObject} oEvent
*/
public onfocusin(oEvent: JQueryEventObject): void;
/**
* When press ESC, deselect all tokens and all texts
* @param {JQueryEventObject} oEvent
*/
public onsapescape(oEvent: JQueryEventObject): void;
/**
* When tap on text field, deselect all tokens
* @param {JQueryEventObject} oEvent
*/
public ontap(oEvent: JQueryEventObject): void;
/**
* Expand multi-line MultiInput in multi-line mode
*/
public openMultiLine(): void;
/**
* Removes all the controls from the aggregation {@link #getTokens tokens}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Token[]} An array of the removed elements (might be empty)
*/
public removeAllTokens(): sap.m.Token[];
/**
* Function removes all validation callbacks
*/
public removeAllValidators(): void;
/**
* Removes a token from the aggregation {@link #getTokens tokens}.
* @param {number|string|sap.m.Token} vToken - The token to remove or its index or id
* @returns {sap.m.Token} The removed token or null
*/
public removeToken(vToken: number|string|sap.m.Token): sap.m.Token;
/**
* Function removes a validation callback
* @param {Function} fValidator
*/
public removeValidator(fValidator: Function): void;
/**
* Setter for property enableMultiLineMode
.
*/
public setEnableMultiLineMode(): void;
/**
* Sets a new value for property {@link #getMaxTokens maxTokens}.
*
* The max number of tokens that is allowed in MultiInput.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iMaxTokens - New value for property maxTokens
* @returns {sap.m.MultiInput} Reference to this
in order to allow method chaining
*/
public setMaxTokens(iMaxTokens: number): sap.m.MultiInput;
/**
* Function sets an array of tokens, existing tokens will get overridden
* @param {sap.m.Token[]} aTokens - the new token set
* @returns {sap.m.MultiInput} Pointer to the control instance for chaining
*/
public setTokens(aTokens: sap.m.Token[]): sap.m.MultiInput;
}
/**
* The NavContainer control handles hierarchic navigation between Pages or other fullscreen controls.
*
* All children of this control will receive navigation events like {@link sap.m.NavContainerChild#beforeShow beforeShow}, they are documented in the pseudo interface {@link sap.m.NavContainerChild sap.m.NavContainerChild}
*/
export class NavContainer extends sap.ui.core.Control {
/**
* Constructor for a new NavContainer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds a custom transition to the NavContainer type (not to a particular instance!). The transition is identified by a "name". Make sure to only use names that will not collide with transitions which may be added to the NavContainer later. A suggestion is to use the prefix "c_" or "_" for your custom transitions to ensure this.
*
* "to" and "back" are the transition functions for the forward and backward navigation.
* Both will be called with the following parameters:
* - oFromPage: the Control which is currently being displayed by the NavContainer
* - oToPage: the Control which should be displayed by the NavContainer after the transition
* - fCallback: a function which MUST be called when the transition has completed
* - oTransitionParameters: a data object that can be given by application code when triggering the transition by calling to() or back(); this object could give additional information to the transition function, like the DOM element which triggered the transition or the desired transition duration
*
* The contract for "to" and "back" is that they may do an animation of their choice, but it should not take "too long". At the beginning of the transition the target page "oToPage" does have the CSS class "sapMNavItemHidden" which initially hides the target page (visibility:hidden). The transition can do any preparation (e.g. move that page out of the screen or make it transparent) and then should remove this CSS class.
* After the animation the target page "oToPage" should cover the entire screen and the source page "oFromPage" should not be visible anymore. This page should then have the CSS class "sapMNavItemHidden".
* For adding/removing this or other CSS classes, the transition can use the addStyleClass/removeStyleClass method:
* oFromPage.addStyleClass("sapMNavItemHidden");
* When the transition is complete, it MUST call the given fCallback method to inform the NavContainer that navigation has finished!
*
* Hint: if the target page of your transition stays black on iPhone, try wrapping the animation start into a
* setTimeout(..., 0)
* block (delayed, but without waiting).
*
* This method can be called on any NavContainer instance or statically on the sap.m.NavContainer type. However, the transition will always be registered for the type (and ALL instances), not for the single instance on which this method was invoked.
*
* Returns the sap.m.NavContainer type if called statically, or "this" (to allow method chaining) if called on a particular NavContainer instance.
* @param {string} sName - The name of the transition. This name can be used by the application to choose this transition when navigating "to()" or "back()": the "transitionName" parameter of "NavContainer.to()" corresponds to this name, the back() navigation will automatically use the same transition. Make sure to only use names that will not collide with transitions which may be added to the NavContainer later. A suggestion is to use the prefix "c_" or "_" for your custom transitions to ensure this.
* @param {any} oTo - The function which will be called by the NavContainer when the application navigates "to()", using this animation's name. The NavContainer instance is the "this" context within the animation function. See the documentation of NavContainer.addCustomTransitions for more details about this function.
* @param {any} oBack - The function which will be called by the NavContainer when the application navigates "back()" from a page where it had navigated to using this animation's name. The NavContainer instance is the "this" context within the animation function. See the documentation of NavContainer.addCustomTransitions for more details about this function.
* @returns {sap.m.NavContainer}
*/
public addCustomTransition(sName: string, oTo: any, oBack: any): sap.m.NavContainer;
/**
* Adds some page to the aggregation {@link #getPages pages}.
* @param {sap.ui.core.Control} oPage - the page to add; if empty, nothing is inserted
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
public addPage(oPage: sap.ui.core.Control): sap.m.NavContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:afterNavigate afterNavigate} event of this sap.m.NavContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.NavContainer
itself.
*
* The event is fired when navigation between two pages has completed. In case of animated transitions this event is fired with some delay after the "navigate" event.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.NavContainer
itself
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
public attachAfterNavigate(fnFunction: Function, oListener?: any): sap.m.NavContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:afterNavigate afterNavigate} event of this sap.m.NavContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.NavContainer
itself.
*
* The event is fired when navigation between two pages has completed. In case of animated transitions this event is fired with some delay after the "navigate" event.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.NavContainer
itself
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
public attachAfterNavigate(oData: any, fnFunction: Function, oListener?: any): sap.m.NavContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.m.NavContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.NavContainer
itself.
*
* The event is fired when navigation between two pages has been triggered. The transition (if any) to the new page has not started yet.
* This event can be aborted by the application with preventDefault(), which means that there will be no navigation.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.NavContainer
itself
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
public attachNavigate(fnFunction: Function, oListener?: any): sap.m.NavContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.m.NavContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.NavContainer
itself.
*
* The event is fired when navigation between two pages has been triggered. The transition (if any) to the new page has not started yet.
* This event can be aborted by the application with preventDefault(), which means that there will be no navigation.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.NavContainer
itself
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
public attachNavigate(oData: any, fnFunction: Function, oListener?: any): sap.m.NavContainer;
/**
* Navigates back one level. If already on the initial page and there is no place to go back, nothing happens.
*
* Calling this navigation method triggers first the (cancelable) "navigate" event on the NavContainer, then the "beforeHide" pseudo event on the source page and "beforeFirstShow" (if applicable) and"beforeShow" on the target page. Later - after the transition has completed - the "afterShow" pseudo event is triggered on the target page and "afterHide" on the page which has been left. The given backData object is available in the "beforeFirstShow", "beforeShow" and "afterShow" event object as "data" property. The original "data" object from the "to" navigation is also available in these event objects.
* @param {any} oBackData - Since version 1.7.1. This optional object can carry any payload data which should be made available to the target page of the back navigation. The event on the target page will contain this data object as "backData" property. (The original data from the "to()" navigation will still be available as "data" property.) In scenarios where the entity triggering the navigation can or should not directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data. For back navigation this can be used e.g. when returning from a detail page to transfer any settings done there. When the "transitionParameters" object is used, this "data" object must also be given (either as object or as null) in order to have a proper parameter order.
* @param {any} oTransitionParameters - Since version 1.7.1. This optional object can give additional information to the transition function, like the DOM element which triggered the transition or the desired transition duration. The animation type can NOT be selected here - it is always the inverse of the "to" navigation. In order to use the "transitionParameters" property, the "data" property must be used (at least "null" must be given) for a proper parameter order. NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition.
* @returns {sap.m.NavContainer}
*/
public back(oBackData?: any, oTransitionParameters?: any): sap.m.NavContainer;
/**
* Navigates back to the nearest previous page in the NavContainer history with the given ID. If there is no such page among the previous pages, nothing happens.
* The transition effect which had been used to get to the current page is inverted and used for this navigation.
*
* Calling this navigation method triggers first the (cancelable) "navigate" event on the NavContainer, then the "beforeHide" pseudo event on the source page and "beforeFirstShow" (if applicable) and"beforeShow" on the target page. Later - after the transition has completed - the "afterShow" pseudo event is triggered on the target page and "afterHide" on the page which has been left. The given backData object is available in the "beforeFirstShow", "beforeShow" and "afterShow" event object as "data" property. The original "data" object from the "to" navigation is also available in these event objects.
* @param {string} sPageId - The ID of the screen to which back navigation should happen. The ID or the control itself can be given. The nearest such page among the previous pages in the history stack will be used.
* @param {any} oBackData - This optional object can carry any payload data which should be made available to the target page of the "backToPage" navigation. The event on the target page will contain this data object as "backData" property. When the "transitionParameters" object is used, this "data" object must also be given (either as object or as null) in order to have a proper parameter order.
* @param {any} oTransitionParameters - This optional object can give additional information to the transition function, like the DOM element which triggered the transition or the desired transition duration. The animation type can NOT be selected here - it is always the inverse of the "to" navigation. In order to use the "transitionParameters" property, the "data" property must be used (at least "null" must be given) for a proper parameter order. NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition.
* @returns {sap.m.NavContainer}
*/
public backToPage(sPageId: string, oBackData?: any, oTransitionParameters?: any): sap.m.NavContainer;
/**
* Navigates back to the initial/top level (this is the element aggregated as "initialPage", or the first added element). If already on the initial page, nothing happens.
* The transition effect which had been used to get to the current page is inverted and used for this navigation.
*
* Calling this navigation method triggers first the (cancelable) "navigate" event on the NavContainer, then the "beforeHide" pseudo event on the source page and "beforeFirstShow" (if applicable) and"beforeShow" on the target page. Later - after the transition has completed - the "afterShow" pseudo event is triggered on the target page and "afterHide" on the page which has been left. The given backData object is available in the "beforeFirstShow", "beforeShow" and "afterShow" event object as "data" property.
* @param {any} oBackData - This optional object can carry any payload data which should be made available to the target page of the "backToTop" navigation. The event on the target page will contain this data object as "backData" property. When the "transitionParameters" object is used, this "data" object must also be given (either as object or as null) in order to have a proper parameter order.
* @param {any} oTransitionParameters - This optional object can give additional information to the transition function, like the DOM element which triggered the transition or the desired transition duration. The animation type can NOT be selected here - it is always the inverse of the "to" navigation. In order to use the "transitionParameters" property, the "data" property must be used (at least "null" must be given) for a proper parameter order. NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition.
* @returns {sap.m.NavContainer}
*/
public backToTop(oBackData?: any, oTransitionParameters?: any): sap.m.NavContainer;
/**
* Returns whether the current page is the top/initial page.
*
* Note: going to the initial page again with a row of "to" navigations causes the initial page to be displayed again, but logically one is not at the top level, so this method returns "false" in this case.
* @returns {boolean}
*/
public currentPageIsTopPage(): boolean;
/**
* Destroys all the pages in the aggregation {@link #getPages pages}.
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
public destroyPages(): sap.m.NavContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:afterNavigate afterNavigate} event of this sap.m.NavContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
public detachAfterNavigate(fnFunction: Function, oListener: any): sap.m.NavContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:navigate navigate} event of this sap.m.NavContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
public detachNavigate(fnFunction: Function, oListener: any): sap.m.NavContainer;
/**
* Creates a new subclass of class sap.m.NavContainer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:afterNavigate afterNavigate} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
protected fireAfterNavigate(mParameters?: any): sap.m.NavContainer;
/**
* Fires event {@link #event:navigate navigate} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireNavigate(mParameters?: any): boolean;
/**
* Gets current value of property {@link #getAutoFocus autoFocus}.
*
* Determines whether the initial focus is set automatically on first rendering and after navigating to a new page.
* This is useful when on touch devices the keyboard pops out due to the focus being automatically set on an input field.
* If necessary the "afterShow" event can be used to focus another element.
*
* Note: The following scenarios are possible, depending on where the focus
* was before navigation to a new page:
* - If
autoFocus is set to true and the focus was
* inside the current page, the focus will be moved automatically on the new page.
* - If
autoFocus is set to false and the focus was inside
* the current page, the focus will disappear.
* - If the focus was outside the current page, after the navigation it will remain
* unchanged regardless of what is set to the
autoFocus property.
*
* Default value is true
.
* @returns {boolean} Value of property autoFocus
*/
public getAutoFocus(): boolean;
/**
* Returns the currently displayed page-level control. Note: it is not necessarily an instance of sap.m.Page, but it could also be an sap.ui.core.View, sap.m.Carousel, or whatever is aggregated.
*
* Returns undefined if no page has been added yet.
* @returns {sap.ui.core.Control}
*/
public getCurrentPage(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getDefaultTransitionName defaultTransitionName}.
*
* The type of the transition/animation to apply when "to()" is called without defining a transition type to use. The default is "slide". Other options are: "fade", "flip" and "show" - and the names of any registered custom transitions.
*
* Default value is slide
.
* @returns {string} Value of property defaultTransitionName
*/
public getDefaultTransitionName(): string;
/**
* Gets current value of property {@link #getHeight height}.
*
* The height of the NavContainer. Can be changed when the NavContainer should not cover the whole available area.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* ID of the element which is the current target of the association {@link #getInitialPage initialPage}, or null
.
* @returns {sap.ui.core.ID}
*/
public getInitialPage(): sap.ui.core.ID;
/**
* Returns a metadata object for class sap.m.NavContainer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the control with the given ID from the "pages" aggregation (if available).
* @param {string} sId - The ID of the aggregated control to find.
* @returns {sap.ui.core.Control}
*/
public getPage(sId: string): sap.ui.core.Control;
/**
* Gets content of aggregation {@link #getPages pages}.
*
* The content entities between which this NavContainer navigates. These can be of type sap.m.Page, sap.ui.core.View, sap.m.Carousel or any other control with fullscreen/page semantics.
*
* These aggregated controls will receive navigation events like {@link sap.m.NavContainerChild#beforeShow beforeShow}, they are documented in the pseudo interface {@link sap.m.NavContainerChild sap.m.NavContainerChild}
* @returns {sap.ui.core.Control[]}
*/
public getPages(): sap.ui.core.Control[];
/**
* Returns the previous page (the page from which the user drilled down to the current page with "to()").
* Note: this is not the page which the user has seen before, but the page which is the target of the next "back()" navigation.
* If there is no previous page, "undefined" is returned.
* @returns {sap.ui.core.Control}
*/
public getPreviousPage(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Whether the NavContainer is visible.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* The width of the NavContainer. Can be changed when the NavContainer should not cover the whole available area.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getPages pages}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oPage - The page whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfPage(oPage: sap.ui.core.Control): number;
/**
* Inserts a page into the aggregation {@link #getPages pages}.
* @param {sap.ui.core.Control} oPage - the page to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the page should be inserted at; for a negative value of iIndex
, the page is inserted at position 0; for a value greater than the current size of the aggregation, the page is inserted at the last position
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
public insertPage(oPage: sap.ui.core.Control, iIndex: number): sap.m.NavContainer;
/**
* Inserts the page/control with the specified ID into the navigation history stack of the NavContainer.
*
* This can be used for deep-linking when the user directly reached a drilldown detail page using a bookmark and then wants to navigate up in the drilldown hierarchy. Normally such a back navigation would not be possible because there is no previous page in the NavContainer's history stack.
* @param {string} sPageId - The ID of the control/page/screen which is inserted into the history stack. The respective control must be aggregated by the NavContainer, otherwise this will cause an error.
* @param {string} sTransitionName - The type of the transition/animation which would have been used to navigate from the (inserted) previous page to the current page. When navigating back, the inverse animation will be applied. This parameter can be omitted; then the default is "slide" (horizontal movement from the right).
* @param {any} oData - This optional object can carry any payload data which would have been given to the inserted previous page if the user would have done a normal forward navigation to it.
* @returns {sap.m.NavContainer}
*/
public insertPreviousPage(sPageId: string, sTransitionName?: string, oData?: any): sap.m.NavContainer;
/**
* Removes all the controls from the aggregation {@link #getPages pages}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllPages(): sap.ui.core.Control[];
/**
* Removes a page from the aggregation {@link #getPages pages}.
* @param {number|string|sap.ui.core.Control} vPage - The page to remove or its index or id
* @returns {sap.ui.core.Control} The removed page or null
*/
public removePage(vPage: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getAutoFocus autoFocus}.
*
* Determines whether the initial focus is set automatically on first rendering and after navigating to a new page.
* This is useful when on touch devices the keyboard pops out due to the focus being automatically set on an input field.
* If necessary the "afterShow" event can be used to focus another element.
*
* Note: The following scenarios are possible, depending on where the focus
* was before navigation to a new page:
* - If
autoFocus is set to true and the focus was
* inside the current page, the focus will be moved automatically on the new page.
* - If
autoFocus is set to false and the focus was inside
* the current page, the focus will disappear.
* - If the focus was outside the current page, after the navigation it will remain
* unchanged regardless of what is set to the
autoFocus property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bAutoFocus - New value for property autoFocus
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
public setAutoFocus(bAutoFocus: boolean): sap.m.NavContainer;
/**
* Sets a new value for property {@link #getDefaultTransitionName defaultTransitionName}.
*
* The type of the transition/animation to apply when "to()" is called without defining a transition type to use. The default is "slide". Other options are: "fade", "flip" and "show" - and the names of any registered custom transitions.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is slide
.
* @param {string} sDefaultTransitionName - New value for property defaultTransitionName
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
public setDefaultTransitionName(sDefaultTransitionName: string): sap.m.NavContainer;
/**
* Sets a new value for property {@link #getHeight height}.
*
* The height of the NavContainer. Can be changed when the NavContainer should not cover the whole available area.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.m.NavContainer;
/**
* Sets the associated {@link #getInitialPage initialPage}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oInitialPage - ID of an element which becomes the new target of this initialPage association; alternatively, an element instance may be given
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
public setInitialPage(oInitialPage: sap.ui.core.ID|sap.ui.core.Control): sap.m.NavContainer;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Whether the NavContainer is visible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.NavContainer;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The width of the NavContainer. Can be changed when the NavContainer should not cover the whole available area.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.NavContainer} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.NavContainer;
/**
* Navigates to the next page (with drill-down semantic) with the given (or default) animation. This creates a new history item inside the NavContainer and allows going back.
*
* Note that any modifications to the target page (like setting its title, or anything else that could cause a re-rendering) should be done BEFORE calling to(), in order to avoid unwanted side effects, e.g. related to the page animation.
*
* Available transitions currently include "slide" (default), "fade", "flip", and "show". None of these is currently making use of any given transitionParameters.
*
* Calling this navigation method triggers first the (cancelable) "navigate" event on the NavContainer, then the "beforeHide" pseudo event on the source page and "beforeFirstShow" (if applicable) and"beforeShow" on the target page. Later - after the transition has completed - the "afterShow" pseudo event is triggered on the target page and "afterHide" on the page which has been left. The given data object is available in the "beforeFirstShow", "beforeShow" and "afterShow" event object as "data" property.
* @param {string} sPageId - The screen to which drilldown should happen. The ID or the control itself can be given.
* @param {string} sTransitionName - The type of the transition/animation to apply. This parameter can be omitted; then the default is "slide" (horizontal movement from the right). Other options are: "fade", "flip", and "show" and the names of any registered custom transitions. None of the standard transitions is currently making use of any given transition parameters.
* @param {any} oData - Since version 1.7.1. This optional object can carry any payload data which should be made available to the target page. The "beforeShow" event on the target page will contain this data object as "data" property. Use case: in scenarios where the entity triggering the navigation can or should not directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data. When the "transitionParameters" object is used, this "data" object must also be given (either as object or as null) in order to have a proper parameter order.
* @param {any} oTransitionParameters - Since version 1.7.1. This optional object can contain additional information for the transition function, like the DOM element which triggered the transition or the desired transition duration. For a proper parameter order, the "data" parameter must be given when the "transitionParameters" parameter is used. (it can be given as "null") NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition. The "show", "slide" and "fade" transitions do not use any parameter.
* @returns {sap.m.NavContainer}
*/
public to(sPageId: string, sTransitionName?: string, oData?: any, oTransitionParameters?: any): sap.m.NavContainer;
}
/**
* sap.m.NavContainerChild is an artificial interface with the only purpose to bear the documentation of
* pseudo events triggered by sap.m.NavContainer on its child controls when navigation occurs and child controls are displayed/hidden.
*
* Interested parties outside the child control can listen to one or more of these events by registering a Delegate:
*
* page1.addEventDelegate({
* onBeforeShow: function(evt) {
* // page1 is about to be shown; act accordingly - if required you can read event information from the evt object
* },
* onAfterHide: function(evt) {
* // ...
* }
* });
*
*/
export interface NavContainerChild {
}
/**
* This control displays the news content text and subheader in a tile.
*/
export class NewsContent extends sap.ui.core.Control {
/**
* Constructor for a new sap.m.NewsContent control.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.NewsContent
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.NewsContent
itself.
*
* The event is triggered when the News Content is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.NewsContent
itself
* @returns {sap.m.NewsContent} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.NewsContent;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.NewsContent
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.NewsContent
itself.
*
* The event is triggered when the News Content is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.NewsContent
itself
* @returns {sap.m.NewsContent} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.NewsContent;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.NewsContent
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.NewsContent} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.NewsContent;
/**
* Creates a new subclass of class sap.m.NewsContent with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.NewsContent} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.NewsContent;
/**
* Gets current value of property {@link #getContentText contentText}.
*
* The content text.
* @returns {string} Value of property contentText
*/
public getContentText(): string;
/**
* Returns a metadata object for class sap.m.NewsContent.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSize size}.
*
* Updates the size of the chart. If not set then the default size is applied based on the device tile.
*
* Default value is Auto
.
* @returns {sap.m.Size} Value of property size
*/
public getSize(): sap.m.Size;
/**
* Gets current value of property {@link #getSubheader subheader}.
*
* The subheader.
* @returns {string} Value of property subheader
*/
public getSubheader(): string;
/**
* Sets a new value for property {@link #getSize size}.
*
* Updates the size of the chart. If not set then the default size is applied based on the device tile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.m.Size} sSize - New value for property size
* @returns {sap.m.NewsContent} Reference to this
in order to allow method chaining
*/
public setSize(sSize: sap.m.Size): sap.m.NewsContent;
/**
* Sets a new value for property {@link #getSubheader subheader}.
*
* The subheader.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sSubheader - New value for property subheader
* @returns {sap.m.NewsContent} Reference to this
in order to allow method chaining
*/
public setSubheader(sSubheader: string): sap.m.NewsContent;
}
/**
* The NotificationListBase is the base class for NotificationListItem and NotificationListGroup.
*/
export class NotificationListBase extends sap.m.ListItemBase {
/**
* Constructor for a new NotificationListBase.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Returns the sap.m.Image or the sap.ui.core.Control used in the NotificationListBase's author picture.
* @returns {sap.m.Image|sap.ui.core.Control} The notification author picture text
*/
protected _getAuthorImage(): sap.m.Image|sap.ui.core.Control;
/**
* Returns the sap.m.Text control used in the NotificationListBase's author name.
* @returns {sap.m.Text} The notification author name text
*/
protected _getAuthorName(): sap.m.Text;
/**
* Returns the sap.m.Text control used in the NotificationListBase's header title.
* @returns {sap.m.Text} The datetime control inside the Notification List Base control
*/
protected _getDateTimeText(): sap.m.Text;
/**
* Returns the sap.m.Text control used in the NotificationListBase's header title.
* @returns {sap.m.Text} The title control inside the Notification List Base control
*/
protected _getHeaderTitle(): sap.m.Text;
/**
* Returns the sap.m.OverflowToolbar control used in the NotificationListBase.
* @returns {sap.m.OverflowToolbar} The footer toolbar
*/
protected _getToolbar(): sap.m.OverflowToolbar;
/**
* Adds some button to the aggregation {@link #getButtons buttons}.
* @param {sap.m.Button} oButton - the button to add; if empty, nothing is inserted
* @returns {sap.m.NotificationListBase} Reference to this
in order to allow method chaining
*/
public addButton(oButton: sap.m.Button): sap.m.NotificationListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:close close} event of this sap.m.NotificationListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.NotificationListBase
itself.
*
* Fired when the close button of the notification is pressed.
Note: Pressing the close button doesn't destroy the notification automatically.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.NotificationListBase
itself
* @returns {sap.m.NotificationListBase} Reference to this
in order to allow method chaining
*/
public attachClose(fnFunction: Function, oListener?: any): sap.m.NotificationListBase;
/**
* Attaches event handler fnFunction
to the {@link #event:close close} event of this sap.m.NotificationListBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.NotificationListBase
itself.
*
* Fired when the close button of the notification is pressed.
Note: Pressing the close button doesn't destroy the notification automatically.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.NotificationListBase
itself
* @returns {sap.m.NotificationListBase} Reference to this
in order to allow method chaining
*/
public attachClose(oData: any, fnFunction: Function, oListener?: any): sap.m.NotificationListBase;
/**
* Destroys all the buttons in the aggregation {@link #getButtons buttons}.
* @returns {sap.m.NotificationListBase} Reference to this
in order to allow method chaining
*/
public destroyButtons(): sap.m.NotificationListBase;
/**
* Detaches event handler fnFunction
from the {@link #event:close close} event of this sap.m.NotificationListBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.NotificationListBase} Reference to this
in order to allow method chaining
*/
public detachClose(fnFunction: Function, oListener: any): sap.m.NotificationListBase;
/**
* Creates a new subclass of class sap.m.NotificationListBase with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ListItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:close close} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.NotificationListBase} Reference to this
in order to allow method chaining
*/
protected fireClose(mParameters?: any): sap.m.NotificationListBase;
/**
* Gets current value of property {@link #getAuthorName authorName}.
*
* Determines the notification group's author name.
*
* Default value is
.
* @returns {string} Value of property authorName
*/
public getAuthorName(): string;
/**
* Gets current value of property {@link #getAuthorPicture authorPicture}.
*
* Determines the URL of the notification group's author picture.
* @returns {sap.ui.core.URI} Value of property authorPicture
*/
public getAuthorPicture(): sap.ui.core.URI;
/**
* Gets content of aggregation {@link #getButtons buttons}.
*
* Action buttons.
* @returns {sap.m.Button[]}
*/
public getButtons(): sap.m.Button[];
/**
* Gets current value of property {@link #getDatetime datetime}.
*
* Determines the due date of the NotificationListItem.
*
* Default value is
.
* @returns {string} Value of property datetime
*/
public getDatetime(): string;
/**
* Returns a metadata object for class sap.m.NotificationListBase.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPriority priority}.
*
* Determines the priority of the Notification.
*
* Default value is None
.
* @returns {sap.ui.core.Priority} Value of property priority
*/
public getPriority(): sap.ui.core.Priority;
/**
* Gets current value of property {@link #getShowButtons showButtons}.
*
* Determines the action buttons visibility.
*
* Default value is true
.
* @returns {boolean} Value of property showButtons
*/
public getShowButtons(): boolean;
/**
* Gets current value of property {@link #getShowCloseButton showCloseButton}.
*
* Determines the visibility of the close button.
*
* Default value is true
.
* @returns {boolean} Value of property showCloseButton
*/
public getShowCloseButton(): boolean;
/**
* Gets current value of property {@link #getTitle title}.
*
* Determines the title of the NotificationListBase item.
*
* Default value is
.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Checks for the provided sap.m.Button
in the aggregation {@link #getButtons buttons}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Button} oButton - The button whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfButton(oButton: sap.m.Button): number;
/**
* Inserts a button into the aggregation {@link #getButtons buttons}.
* @param {sap.m.Button} oButton - the button to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the button should be inserted at; for a negative value of iIndex
, the button is inserted at position 0; for a value greater than the current size of the aggregation, the button is inserted at the last position
* @returns {sap.m.NotificationListBase} Reference to this
in order to allow method chaining
*/
public insertButton(oButton: sap.m.Button, iIndex: number): sap.m.NotificationListBase;
/**
* Removes all the controls from the aggregation {@link #getButtons buttons}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Button[]} An array of the removed elements (might be empty)
*/
public removeAllButtons(): sap.m.Button[];
/**
* Removes a button from the aggregation {@link #getButtons buttons}.
* @param {number|string|sap.m.Button} vButton - The button to remove or its index or id
* @returns {sap.m.Button} The removed button or null
*/
public removeButton(vButton: number|string|sap.m.Button): sap.m.Button;
/**
* Sets a new value for property {@link #getAuthorName authorName}.
*
* Determines the notification group's author name.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sAuthorName - New value for property authorName
* @returns {sap.m.NotificationListBase} Reference to this
in order to allow method chaining
*/
public setAuthorName(sAuthorName: string): sap.m.NotificationListBase;
/**
* Sets a new value for property {@link #getAuthorPicture authorPicture}.
*
* Determines the URL of the notification group's author picture.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sAuthorPicture - New value for property authorPicture
* @returns {sap.m.NotificationListBase} Reference to this
in order to allow method chaining
*/
public setAuthorPicture(sAuthorPicture: sap.ui.core.URI): sap.m.NotificationListBase;
/**
* Sets a new value for property {@link #getDatetime datetime}.
*
* Determines the due date of the NotificationListItem.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sDatetime - New value for property datetime
* @returns {sap.m.NotificationListBase} Reference to this
in order to allow method chaining
*/
public setDatetime(sDatetime: string): sap.m.NotificationListBase;
/**
* Sets a new value for property {@link #getPriority priority}.
*
* Determines the priority of the Notification.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.Priority} sPriority - New value for property priority
* @returns {sap.m.NotificationListBase} Reference to this
in order to allow method chaining
*/
public setPriority(sPriority: sap.ui.core.Priority): sap.m.NotificationListBase;
/**
* Sets a new value for property {@link #getShowButtons showButtons}.
*
* Determines the action buttons visibility.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowButtons - New value for property showButtons
* @returns {sap.m.NotificationListBase} Reference to this
in order to allow method chaining
*/
public setShowButtons(bShowButtons: boolean): sap.m.NotificationListBase;
/**
* Sets a new value for property {@link #getShowCloseButton showCloseButton}.
*
* Determines the visibility of the close button.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowCloseButton - New value for property showCloseButton
* @returns {sap.m.NotificationListBase} Reference to this
in order to allow method chaining
*/
public setShowCloseButton(bShowCloseButton: boolean): sap.m.NotificationListBase;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Determines the title of the NotificationListBase item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sTitle - New value for property title
* @returns {sap.m.NotificationListBase} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.NotificationListBase;
}
/**
* The NotificationListItemGroup control is used for grouping NotificationListItems of the same type.
*/
export class NotificationListGroup extends sap.m.NotificationListBase {
/**
* Constructor for a new NotificationListGroup.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.m.NotificationListItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.NotificationListGroup} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.m.NotificationListItem): sap.m.NotificationListGroup;
/**
* Attaches event handler fnFunction
to the {@link #event:onCollapse onCollapse} event of this sap.m.NotificationListGroup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.NotificationListGroup
itself.
*
* This event is called when collapse property value is changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.NotificationListGroup
itself
* @returns {sap.m.NotificationListGroup} Reference to this
in order to allow method chaining
*/
public attachOnCollapse(fnFunction: Function, oListener?: any): sap.m.NotificationListGroup;
/**
* Attaches event handler fnFunction
to the {@link #event:onCollapse onCollapse} event of this sap.m.NotificationListGroup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.NotificationListGroup
itself.
*
* This event is called when collapse property value is changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.NotificationListGroup
itself
* @returns {sap.m.NotificationListGroup} Reference to this
in order to allow method chaining
*/
public attachOnCollapse(oData: any, fnFunction: Function, oListener?: any): sap.m.NotificationListGroup;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.NotificationListGroup} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.NotificationListGroup;
/**
* Detaches event handler fnFunction
from the {@link #event:onCollapse onCollapse} event of this sap.m.NotificationListGroup
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.NotificationListGroup} Reference to this
in order to allow method chaining
*/
public detachOnCollapse(fnFunction: Function, oListener: any): sap.m.NotificationListGroup;
/**
* Creates a new subclass of class sap.m.NotificationListGroup with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.NotificationListBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:onCollapse onCollapse} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.NotificationListGroup} Reference to this
in order to allow method chaining
*/
protected fireOnCollapse(mParameters?: any): sap.m.NotificationListGroup;
/**
* Gets current value of property {@link #getAutoPriority autoPriority}.
*
* Determines if the group will automatically set the priority based on the highest priority of its notifications or get its priority from the developer.
*
* Default value is true
.
* @returns {boolean} Value of property autoPriority
*/
public getAutoPriority(): boolean;
/**
* Gets current value of property {@link #getCollapsed collapsed}.
*
* Determines if the group is collapsed or expanded.
*
* Default value is false
.
* @returns {boolean} Value of property collapsed
*/
public getCollapsed(): boolean;
/**
* Gets current value of property {@link #getEnableCollapseButtonWhenEmpty enableCollapseButtonWhenEmpty}.
*
* Determines if the collapse/expand button should be enabled for an empty group.
*
* Default value is false
.
* @returns {boolean} Value of property enableCollapseButtonWhenEmpty
*/
public getEnableCollapseButtonWhenEmpty(): boolean;
/**
* Gets content of aggregation {@link #getItems items}.
*
* The NotificationListItems inside the group.
* @returns {sap.m.NotificationListItem[]}
*/
public getItems(): sap.m.NotificationListItem[];
/**
* Returns a metadata object for class sap.m.NotificationListGroup.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowEmptyGroup showEmptyGroup}.
*
* Determines if the group header/footer of the empty group will be always shown. By default groups with 0 notifications are not shown.
*
* Default value is false
.
* @returns {boolean} Value of property showEmptyGroup
*/
public getShowEmptyGroup(): boolean;
/**
* Checks for the provided sap.m.NotificationListItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.NotificationListItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.m.NotificationListItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.m.NotificationListItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.NotificationListGroup} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.m.NotificationListItem, iIndex: number): sap.m.NotificationListGroup;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.NotificationListItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.m.NotificationListItem[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.m.NotificationListItem} vItem - The item to remove or its index or id
* @returns {sap.m.NotificationListItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.m.NotificationListItem): sap.m.NotificationListItem;
/**
* Sets a new value for property {@link #getAutoPriority autoPriority}.
*
* Determines if the group will automatically set the priority based on the highest priority of its notifications or get its priority from the developer.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bAutoPriority - New value for property autoPriority
* @returns {sap.m.NotificationListGroup} Reference to this
in order to allow method chaining
*/
public setAutoPriority(bAutoPriority: boolean): sap.m.NotificationListGroup;
/**
* Sets a new value for property {@link #getCollapsed collapsed}.
*
* Determines if the group is collapsed or expanded.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bCollapsed - New value for property collapsed
* @returns {sap.m.NotificationListGroup} Reference to this
in order to allow method chaining
*/
public setCollapsed(bCollapsed: boolean): sap.m.NotificationListGroup;
/**
* Sets a new value for property {@link #getEnableCollapseButtonWhenEmpty enableCollapseButtonWhenEmpty}.
*
* Determines if the collapse/expand button should be enabled for an empty group.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableCollapseButtonWhenEmpty - New value for property enableCollapseButtonWhenEmpty
* @returns {sap.m.NotificationListGroup} Reference to this
in order to allow method chaining
*/
public setEnableCollapseButtonWhenEmpty(bEnableCollapseButtonWhenEmpty: boolean): sap.m.NotificationListGroup;
/**
* Sets a new value for property {@link #getShowEmptyGroup showEmptyGroup}.
*
* Determines if the group header/footer of the empty group will be always shown. By default groups with 0 notifications are not shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowEmptyGroup - New value for property showEmptyGroup
* @returns {sap.m.NotificationListGroup} Reference to this
in order to allow method chaining
*/
public setShowEmptyGroup(bShowEmptyGroup: boolean): sap.m.NotificationListGroup;
}
/**
* The NotificationListItem control is suitable for showing notifications to the user.
*/
export class NotificationListItem extends sap.m.NotificationListBase {
/**
* Constructor for a new NotificationListItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Destroys the processingMessage in the aggregation {@link #getProcessingMessage processingMessage}.
* @returns {sap.m.NotificationListItem} Reference to this
in order to allow method chaining
*/
public destroyProcessingMessage(): sap.m.NotificationListItem;
/**
* Creates a new subclass of class sap.m.NotificationListItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.NotificationListBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getDescription description}.
*
* Determines the description of the NotificationListItem.
*
* Default value is
.
* @returns {string} Value of property description
*/
public getDescription(): string;
/**
* Gets current value of property {@link #getHideShowMoreButton hideShowMoreButton}.
*
* Determines it the "Show More" button should be hidden.
*
* Default value is false
.
* @returns {boolean} Value of property hideShowMoreButton
*/
public getHideShowMoreButton(): boolean;
/**
* Returns a metadata object for class sap.m.NotificationListItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getProcessingMessage processingMessage}.
*
* The sap.m.MessageStrip control that holds the information about any error that may occur when pressing the notification buttons
* @returns {sap.m.MessageStrip}
*/
public getProcessingMessage(): sap.m.MessageStrip;
/**
* Gets current value of property {@link #getTruncate truncate}.
*
* Determines if the text in the title and the description of the notification are truncated to the first two lines.
*
* Default value is true
.
* @returns {boolean} Value of property truncate
*/
public getTruncate(): boolean;
/**
* Sets a new value for property {@link #getDescription description}.
*
* Determines the description of the NotificationListItem.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sDescription - New value for property description
* @returns {sap.m.NotificationListItem} Reference to this
in order to allow method chaining
*/
public setDescription(sDescription: string): sap.m.NotificationListItem;
/**
* Sets a new value for property {@link #getHideShowMoreButton hideShowMoreButton}.
*
* Determines it the "Show More" button should be hidden.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bHideShowMoreButton - New value for property hideShowMoreButton
* @returns {sap.m.NotificationListItem} Reference to this
in order to allow method chaining
*/
public setHideShowMoreButton(bHideShowMoreButton: boolean): sap.m.NotificationListItem;
/**
* Sets the aggregated {@link #getProcessingMessage processingMessage}.
* @param {sap.m.MessageStrip} oProcessingMessage - The processingMessage to set
* @returns {sap.m.NotificationListItem} Reference to this
in order to allow method chaining
*/
public setProcessingMessage(oProcessingMessage: sap.m.MessageStrip): sap.m.NotificationListItem;
/**
* Sets a new value for property {@link #getTruncate truncate}.
*
* Determines if the text in the title and the description of the notification are truncated to the first two lines.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bTruncate - New value for property truncate
* @returns {sap.m.NotificationListItem} Reference to this
in order to allow method chaining
*/
public setTruncate(bTruncate: boolean): sap.m.NotificationListItem;
}
/**
* Shows numeric values used for example in tiles colored according to their meaning and displays deviations.
*/
export class NumericContent extends sap.ui.core.Control {
/**
* Constructor for a new sap.m.GenericTile control.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.NumericContent
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.NumericContent
itself.
*
* The event is fired when the user chooses the numeric content.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.NumericContent
itself
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.NumericContent;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.NumericContent
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.NumericContent
itself.
*
* The event is fired when the user chooses the numeric content.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.NumericContent
itself
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.NumericContent;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.NumericContent
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.NumericContent;
/**
* Creates a new subclass of class sap.m.NumericContent with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.NumericContent;
/**
* Gets current value of property {@link #getAnimateTextChange animateTextChange}.
*
* If set to true, the change of the value will be animated.
*
* Default value is true
.
* @returns {boolean} Value of property animateTextChange
*/
public getAnimateTextChange(): boolean;
/**
* Gets current value of property {@link #getFormatterValue formatterValue}.
*
* If set to true, the value parameter contains a numeric value and scale. If set to false (default), the value parameter contains a numeric value only.
*
* Default value is false
.
* @returns {boolean} Value of property formatterValue
*/
public getFormatterValue(): boolean;
/**
* Gets current value of property {@link #getIcon icon}.
*
* The icon to be displayed as a graphical element within the control. This can be an image or an icon from the icon font.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconDescription iconDescription}.
*
* Description of an icon that is used in the tooltip.
* @returns {string} Value of property iconDescription
*/
public getIconDescription(): string;
/**
* Gets current value of property {@link #getIndicator indicator}.
*
* The indicator arrow that shows value deviation.
*
* Default value is None
.
* @returns {sap.m.DeviationIndicator} Value of property indicator
*/
public getIndicator(): sap.m.DeviationIndicator;
/**
* Returns a metadata object for class sap.m.NumericContent.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getNullifyValue nullifyValue}.
*
* If set to true, the omitted value property is set to 0.
*
* Default value is true
.
* @returns {boolean} Value of property nullifyValue
*/
public getNullifyValue(): boolean;
/**
* Gets current value of property {@link #getScale scale}.
*
* The scaling prefix. Financial characters can be used for currencies and counters. The SI prefixes can be used for units. If the scaling prefix contains more than three characters, only the first three characters are displayed.
* @returns {string} Value of property scale
*/
public getScale(): string;
/**
* Gets current value of property {@link #getSize size}.
*
* Updates the size of the control. If not set then the default size is applied based on the device tile.
*
* Default value is Auto
.
* @returns {sap.m.Size} Value of property size
*/
public getSize(): sap.m.Size;
/**
* Gets current value of property {@link #getState state}.
*
* Indicates the load status.
*
* Default value is Loaded
.
* @returns {sap.m.LoadState} Value of property state
*/
public getState(): sap.m.LoadState;
/**
* Gets current value of property {@link #getTruncateValueTo truncateValueTo}.
*
* The number of characters to display for the value property.
*
* Default value is 4
.
* @returns {number} Value of property truncateValueTo
*/
public getTruncateValueTo(): number;
/**
* Gets current value of property {@link #getValue value}.
*
* The actual value.
* @returns {string} Value of property value
*/
public getValue(): string;
/**
* Gets current value of property {@link #getValueColor valueColor}.
*
* The semantic color of the value.
*
* Default value is Neutral
.
* @returns {sap.m.ValueColor} Value of property valueColor
*/
public getValueColor(): sap.m.ValueColor;
/**
* Gets current value of property {@link #getWidth width}.
*
* The width of the control. If it is not set, the size of the control is defined by the 'size' property.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getWithMargin withMargin}.
*
* If the value is set to false, the content will fit to the whole size of the control.
*
* Default value is true
.
* @returns {boolean} Value of property withMargin
*/
public getWithMargin(): boolean;
/**
* Sets a new value for property {@link #getAnimateTextChange animateTextChange}.
*
* If set to true, the change of the value will be animated.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bAnimateTextChange - New value for property animateTextChange
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public setAnimateTextChange(bAnimateTextChange: boolean): sap.m.NumericContent;
/**
* Sets a new value for property {@link #getFormatterValue formatterValue}.
*
* If set to true, the value parameter contains a numeric value and scale. If set to false (default), the value parameter contains a numeric value only.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bFormatterValue - New value for property formatterValue
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public setFormatterValue(bFormatterValue: boolean): sap.m.NumericContent;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* The icon to be displayed as a graphical element within the control. This can be an image or an icon from the icon font.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.NumericContent;
/**
* Sets a new value for property {@link #getIconDescription iconDescription}.
*
* Description of an icon that is used in the tooltip.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sIconDescription - New value for property iconDescription
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public setIconDescription(sIconDescription: string): sap.m.NumericContent;
/**
* Sets a new value for property {@link #getIndicator indicator}.
*
* The indicator arrow that shows value deviation.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.m.DeviationIndicator} sIndicator - New value for property indicator
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public setIndicator(sIndicator: sap.m.DeviationIndicator): sap.m.NumericContent;
/**
* Sets a new value for property {@link #getNullifyValue nullifyValue}.
*
* If set to true, the omitted value property is set to 0.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bNullifyValue - New value for property nullifyValue
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public setNullifyValue(bNullifyValue: boolean): sap.m.NumericContent;
/**
* Sets a new value for property {@link #getScale scale}.
*
* The scaling prefix. Financial characters can be used for currencies and counters. The SI prefixes can be used for units. If the scaling prefix contains more than three characters, only the first three characters are displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sScale - New value for property scale
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public setScale(sScale: string): sap.m.NumericContent;
/**
* Sets a new value for property {@link #getSize size}.
*
* Updates the size of the control. If not set then the default size is applied based on the device tile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.m.Size} sSize - New value for property size
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public setSize(sSize: sap.m.Size): sap.m.NumericContent;
/**
* Sets a new value for property {@link #getState state}.
*
* Indicates the load status.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Loaded
.
* @param {sap.m.LoadState} sState - New value for property state
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public setState(sState: sap.m.LoadState): sap.m.NumericContent;
/**
* Sets a new value for property {@link #getTruncateValueTo truncateValueTo}.
*
* The number of characters to display for the value property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 4
.
* @param {number} iTruncateValueTo - New value for property truncateValueTo
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public setTruncateValueTo(iTruncateValueTo: number): sap.m.NumericContent;
/**
* Sets a new value for property {@link #getValue value}.
*
* The actual value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sValue - New value for property value
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public setValue(sValue: string): sap.m.NumericContent;
/**
* Sets a new value for property {@link #getValueColor valueColor}.
*
* The semantic color of the value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Neutral
.
* @param {sap.m.ValueColor} sValueColor - New value for property valueColor
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public setValueColor(sValueColor: sap.m.ValueColor): sap.m.NumericContent;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The width of the control. If it is not set, the size of the control is defined by the 'size' property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.NumericContent;
/**
* Sets a new value for property {@link #getWithMargin withMargin}.
*
* If the value is set to false, the content will fit to the whole size of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bWithMargin - New value for property withMargin
* @returns {sap.m.NumericContent} Reference to this
in order to allow method chaining
*/
public setWithMargin(bWithMargin: boolean): sap.m.NumericContent;
}
/**
* The ObjectAttribute
control displays a text field that can be normal or active.
* The ObjectAttribute
fires a press
event when the user chooses the active text.
*
* Note: If property active
is set to true
, only the value of the
* text
property is styled and acts as a link. In this case the text
* property must also be set, as otherwise there will be no link displayed for the user.
*/
export class ObjectAttribute extends sap.ui.core.Control {
/**
* Constructor for a new ObjectAttribute
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.ObjectAttribute
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ObjectAttribute
itself.
*
* Fires when the user clicks on active text.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ObjectAttribute
itself
* @returns {sap.m.ObjectAttribute} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.ObjectAttribute;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.ObjectAttribute
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ObjectAttribute
itself.
*
* Fires when the user clicks on active text.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ObjectAttribute
itself
* @returns {sap.m.ObjectAttribute} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.ObjectAttribute;
/**
* Destroys the customContent in the aggregation {@link #getCustomContent customContent}.
* @returns {sap.m.ObjectAttribute} Reference to this
in order to allow method chaining
*/
public destroyCustomContent(): sap.m.ObjectAttribute;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.ObjectAttribute
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ObjectAttribute} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.ObjectAttribute;
/**
* Creates a new subclass of class sap.m.ObjectAttribute with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ObjectAttribute} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.ObjectAttribute;
/**
* Gets current value of property {@link #getActive active}.
*
* Indicates if the ObjectAttribute
text is selectable for the user.
*
* Note: As of version 1.48, only the value of the text
property becomes active (styled and acts like a link) as opposed to both the title
and text
in the previous versions. If you set this property to true
, you have to also set the text
property.
* @returns {boolean} Value of property active
*/
public getActive(): boolean;
/**
* Gets content of aggregation {@link #getCustomContent customContent}.
*
* When the aggregation is set, it replaces the text, active and textDirection properties. This also ignores the press event. The provided control is displayed as an active link.
* Note: It will only allow sap.m.Text and sap.m.Link controls.
* @returns {sap.ui.core.Control}
*/
public getCustomContent(): sap.ui.core.Control;
/**
* Returns a metadata object for class sap.m.ObjectAttribute.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Defines to which DOM reference the Popup should be docked.
* @returns {HTMLElement} The DOM reference that Popup should dock to
*/
protected getPopupAnchorDomRef(): HTMLElement;
/**
* Gets current value of property {@link #getText text}.
*
* Defines the ObjectAttribute text.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Determines the direction of the text, not including the title.
* Available options for the text direction are LTR (left-to-right) and RTL (right-to-left). By default the control inherits the text direction from its parent control.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getTitle title}.
*
* Defines the ObjectAttribute title.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Sets a new value for property {@link #getActive active}.
*
* Indicates if the ObjectAttribute
text is selectable for the user.
*
* Note: As of version 1.48, only the value of the text
property becomes active (styled and acts like a link) as opposed to both the title
and text
in the previous versions. If you set this property to true
, you have to also set the text
property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bActive - New value for property active
* @returns {sap.m.ObjectAttribute} Reference to this
in order to allow method chaining
*/
public setActive(bActive: boolean): sap.m.ObjectAttribute;
/**
* Sets the aggregated {@link #getCustomContent customContent}.
* @param {sap.ui.core.Control} oCustomContent - The customContent to set
* @returns {sap.m.ObjectAttribute} Reference to this
in order to allow method chaining
*/
public setCustomContent(oCustomContent: sap.ui.core.Control): sap.m.ObjectAttribute;
/**
* Sets a new value for property {@link #getText text}.
*
* Defines the ObjectAttribute text.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.m.ObjectAttribute} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.ObjectAttribute;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Determines the direction of the text, not including the title.
* Available options for the text direction are LTR (left-to-right) and RTL (right-to-left). By default the control inherits the text direction from its parent control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.ObjectAttribute} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.ObjectAttribute;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Defines the ObjectAttribute title.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.ObjectAttribute} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.ObjectAttribute;
}
/**
* ObjectHeader
is a display control that enables the user to easily identify
* a specific object. The object header title is the key identifier of the object and
* additional text and icons can be used to further distinguish it from other objects.
*/
export class ObjectHeader extends sap.ui.core.Control {
/**
* Constructor for a new
ObjectHeader
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some additionalNumber to the aggregation {@link #getAdditionalNumbers additionalNumbers}.
* @param {sap.m.ObjectNumber} oAdditionalNumber - the additionalNumber to add; if empty, nothing is inserted
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public addAdditionalNumber(oAdditionalNumber: sap.m.ObjectNumber): sap.m.ObjectHeader;
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.ObjectHeader;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.ObjectHeader;
/**
* Adds some attribute to the aggregation {@link #getAttributes attributes}.
* @param {sap.m.ObjectAttribute} oAttribute - the attribute to add; if empty, nothing is inserted
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public addAttribute(oAttribute: sap.m.ObjectAttribute): sap.m.ObjectHeader;
/**
* Adds some marker to the aggregation {@link #getMarkers markers}.
* @param {sap.m.ObjectMarker} oMarker - the marker to add; if empty, nothing is inserted
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public addMarker(oMarker: sap.m.ObjectMarker): sap.m.ObjectHeader;
/**
* Adds some status to the aggregation {@link #getStatuses statuses}.
* @param {sap.ui.core.Control} oStatus - the status to add; if empty, nothing is inserted
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public addStatus(oStatus: sap.ui.core.Control): sap.m.ObjectHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:iconPress iconPress} event of this sap.m.ObjectHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ObjectHeader
itself.
*
* Event is fired when the title icon is active and the user taps/clicks on it
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ObjectHeader
itself
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public attachIconPress(fnFunction: Function, oListener?: any): sap.m.ObjectHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:iconPress iconPress} event of this sap.m.ObjectHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ObjectHeader
itself.
*
* Event is fired when the title icon is active and the user taps/clicks on it
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ObjectHeader
itself
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public attachIconPress(oData: any, fnFunction: Function, oListener?: any): sap.m.ObjectHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:introPress introPress} event of this sap.m.ObjectHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ObjectHeader
itself.
*
* Event is fired when the intro is active and the user taps/clicks on it
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ObjectHeader
itself
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public attachIntroPress(fnFunction: Function, oListener?: any): sap.m.ObjectHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:introPress introPress} event of this sap.m.ObjectHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ObjectHeader
itself.
*
* Event is fired when the intro is active and the user taps/clicks on it
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ObjectHeader
itself
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public attachIntroPress(oData: any, fnFunction: Function, oListener?: any): sap.m.ObjectHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:titlePress titlePress} event of this sap.m.ObjectHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ObjectHeader
itself.
*
* Event is fired when the title is active and the user taps/clicks on it
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ObjectHeader
itself
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public attachTitlePress(fnFunction: Function, oListener?: any): sap.m.ObjectHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:titlePress titlePress} event of this sap.m.ObjectHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ObjectHeader
itself.
*
* Event is fired when the title is active and the user taps/clicks on it
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ObjectHeader
itself
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public attachTitlePress(oData: any, fnFunction: Function, oListener?: any): sap.m.ObjectHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:titleSelectorPress titleSelectorPress} event of this sap.m.ObjectHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ObjectHeader
itself.
*
* Event is fired when the object header title selector (down-arrow) is pressed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ObjectHeader
itself
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public attachTitleSelectorPress(fnFunction: Function, oListener?: any): sap.m.ObjectHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:titleSelectorPress titleSelectorPress} event of this sap.m.ObjectHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ObjectHeader
itself.
*
* Event is fired when the object header title selector (down-arrow) is pressed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ObjectHeader
itself
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public attachTitleSelectorPress(oData: any, fnFunction: Function, oListener?: any): sap.m.ObjectHeader;
/**
* Destroys all the additionalNumbers in the aggregation {@link #getAdditionalNumbers additionalNumbers}.
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public destroyAdditionalNumbers(): sap.m.ObjectHeader;
/**
* Destroys all the attributes in the aggregation {@link #getAttributes attributes}.
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public destroyAttributes(): sap.m.ObjectHeader;
/**
* Destroys the firstStatus in the aggregation {@link #getFirstStatus firstStatus}.
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public destroyFirstStatus(): sap.m.ObjectHeader;
/**
* Destroys the headerContainer in the aggregation {@link #getHeaderContainer headerContainer}.
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public destroyHeaderContainer(): sap.m.ObjectHeader;
/**
* Destroys all the markers in the aggregation {@link #getMarkers markers}.
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public destroyMarkers(): sap.m.ObjectHeader;
/**
* Destroys the secondStatus in the aggregation {@link #getSecondStatus secondStatus}.
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public destroySecondStatus(): sap.m.ObjectHeader;
/**
* Destroys all the statuses in the aggregation {@link #getStatuses statuses}.
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public destroyStatuses(): sap.m.ObjectHeader;
/**
* Detaches event handler fnFunction
from the {@link #event:iconPress iconPress} event of this sap.m.ObjectHeader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public detachIconPress(fnFunction: Function, oListener: any): sap.m.ObjectHeader;
/**
* Detaches event handler fnFunction
from the {@link #event:introPress introPress} event of this sap.m.ObjectHeader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public detachIntroPress(fnFunction: Function, oListener: any): sap.m.ObjectHeader;
/**
* Detaches event handler fnFunction
from the {@link #event:titlePress titlePress} event of this sap.m.ObjectHeader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public detachTitlePress(fnFunction: Function, oListener: any): sap.m.ObjectHeader;
/**
* Detaches event handler fnFunction
from the {@link #event:titleSelectorPress titleSelectorPress} event of this sap.m.ObjectHeader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public detachTitleSelectorPress(fnFunction: Function, oListener: any): sap.m.ObjectHeader;
/**
* Creates a new subclass of class sap.m.ObjectHeader with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:iconPress iconPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
protected fireIconPress(mParameters?: any): sap.m.ObjectHeader;
/**
* Fires event {@link #event:introPress introPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
protected fireIntroPress(mParameters?: any): sap.m.ObjectHeader;
/**
* Fires event {@link #event:titlePress titlePress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
protected fireTitlePress(mParameters?: any): sap.m.ObjectHeader;
/**
* Fires event {@link #event:titleSelectorPress titleSelectorPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
protected fireTitleSelectorPress(mParameters?: any): sap.m.ObjectHeader;
/**
* Gets content of aggregation {@link #getAdditionalNumbers additionalNumbers}.
*
* NOTE: Only applied if you set "responsive=false".
* Additional object numbers and units are managed in this aggregation.
* The numbers are hidden on tablet and phone size screens.
* When only one number is provided, it is rendered with additional separator from the main ObjectHeader number.
* @returns {sap.m.ObjectNumber[]}
*/
public getAdditionalNumbers(): sap.m.ObjectNumber[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets content of aggregation {@link #getAttributes attributes}.
*
* The list of Object Attributes
* @returns {sap.m.ObjectAttribute[]}
*/
public getAttributes(): sap.m.ObjectAttribute[];
/**
* Gets current value of property {@link #getBackgroundDesign backgroundDesign}.
*
* Determines the background color of the ObjectHeader
.
*
* Note: The different types of ObjectHeader
come with different default background:
*
* - non responsive - Transparent
* - responsive - Translucent
* - condensed - Solid
*
* @returns {sap.m.BackgroundDesign} Value of property backgroundDesign
*/
public getBackgroundDesign(): sap.m.BackgroundDesign;
/**
* Gets current value of property {@link #getCondensed condensed}.
*
* ObjectHeader
with title, one attribute, number, and number unit.
*
* Note: Only applied if the responsive
property is set to false
.
*
* Default value is false
.
* @returns {boolean} Value of property condensed
*/
public getCondensed(): boolean;
/**
* Gets content of aggregation {@link #getFirstStatus firstStatus}.
*
* First status shown on the right side of the attributes above the second status.
* If it is not set the first attribute will expand to take the entire row.
* @returns {sap.m.ObjectStatus}
*/
public getFirstStatus(): sap.m.ObjectStatus;
/**
* Gets current value of property {@link #getFullScreenOptimized fullScreenOptimized}.
*
* Optimizes the display of the elements of the ObjectHeader
.
*
* Set this property to true
if your app uses a fullscreen layout (as opposed
* to a master-detail or other split-screen layout).
*
* Note: Only applied if the responsive
property is also set to true
.
*
* If set to true
, the following situations apply:
*
* - On desktop, 1-3 attributes/statuses - positioned as a third block on the right side of the Title/Number group
* - On desktop, 4+ attributes/statuses - 4 columns below the Title/Number
* - On tablet (portrait mode), always in 2 columns below the Title/Number
* - On tablet (landscape mode), 1-2 attributes/statuses - 2 columns below the Title/Number
* - On tablet (landscape mode), 3+ attributes/statuses - 3 columns below the Title/Number
*
* On phone, the attributes and statuses are always positioned in 1 column below the Title/Number of the ObjectHeader
.
*
* If set to false
, the attributes and statuses are being positioned below the
* Title/Number of the ObjectHeader
in 2 or 3 columns depending on their number:
*
* - On desktop, 1-4 attributes/statuses - 2 columns
* - On desktop, 5+ attributes/statuses - 3 columns
* - On tablet, always in 2 columns
*
*
* Default value is false
.
* @returns {boolean} Value of property fullScreenOptimized
*/
public getFullScreenOptimized(): boolean;
/**
* Gets content of aggregation {@link #getHeaderContainer headerContainer}.
*
* This aggregation takes only effect when you set "responsive" to true.
* It can either be filled with an sap.m.IconTabBar or an sap.suite.ui.commons.HeaderContainer control. Overflow handling must be taken care of by the inner control. If used with an IconTabBar control, only the header will be displayed inside the object header, the content will be displayed below the ObjectHeader.
* @returns {sap.m.ObjectHeaderContainer}
*/
public getHeaderContainer(): sap.m.ObjectHeaderContainer;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Defines the icon of the ObjectHeader
.
*
* Note: Recursive resolution of binding expressions is not supported by the framework.
* It works only in ObjectHeader, since it is a composite control and creates an Image control internally.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconActive iconActive}.
*
* Determines whether the ObjectHeader
icon is clickable.
* @returns {boolean} Value of property iconActive
*/
public getIconActive(): boolean;
/**
* Gets current value of property {@link #getIconAlt iconAlt}.
*
* Determines the alternative text of the ObjectHeader
icon. The text is
* displayed if the image for the icon is not available, or cannot be displayed.
* @returns {string} Value of property iconAlt
*/
public getIconAlt(): string;
/**
* Gets current value of property {@link #getIconDensityAware iconDensityAware}.
*
* By default, this is set to true
but then one or more requests are sent trying to get
* the density perfect version of image if this version of image doesn't exist on the server.
*
* If bandwidth is the key for the application, set this value to false
.
*
* Default value is true
.
* @returns {boolean} Value of property iconDensityAware
*/
public getIconDensityAware(): boolean;
/**
* Gets current value of property {@link #getIconTooltip iconTooltip}.
*
* Determines the tooltip text of the ObjectHeader
icon.
* @returns {string} Value of property iconTooltip
*/
public getIconTooltip(): string;
/**
* Gets current value of property {@link #getIntro intro}.
*
* Determines the introductory text for the ObjectHeader
.
* @returns {string} Value of property intro
*/
public getIntro(): string;
/**
* Gets current value of property {@link #getIntroActive introActive}.
*
* Determines whether the introductory text of the ObjectHeader
is clickable.
* @returns {boolean} Value of property introActive
*/
public getIntroActive(): boolean;
/**
* Gets current value of property {@link #getIntroHref introHref}.
*
* Determines the intro link target URI. Supports standard hyperlink behavior. If an action should be triggered,
* this should not be set, but instead an event handler for the introPress
event should be registered.
* @returns {sap.ui.core.URI} Value of property introHref
*/
public getIntroHref(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIntroTarget introTarget}.
*
* Determines the target
attribute for the intro link. Options are _self
,
* _top
, _blank
, _parent
, _search
. Alternatively,
* a frame name can be entered.
* @returns {string} Value of property introTarget
*/
public getIntroTarget(): string;
/**
* Gets current value of property {@link #getIntroTextDirection introTextDirection}.
*
* Specifies the intro text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property introTextDirection
*/
public getIntroTextDirection(): sap.ui.core.TextDirection;
/**
* Gets content of aggregation {@link #getMarkers markers}.
*
* List of markers (icon and/or text) that can be displayed for the ObjectHeader
, such as favorite and flagged.
* Note: You should use either this aggregation or the already deprecated properties - markFlagged
and markFavorite
. Using both can lead to unexpected results.
* @returns {sap.m.ObjectMarker[]}
*/
public getMarkers(): sap.m.ObjectMarker[];
/**
* Gets current value of property {@link #getMarkFavorite markFavorite}.
*
* Sets the favorite state for the ObjectHeader
. The showMarkers
* property must be set to true
for this property to take effect.
*
* Note: As this property is deprecated, we recommend that you use the markers
* aggregation - add sap.m.ObjectMarker
with type sap.m.ObjectMarkerType.Favorite
.
* You should use either this property or the markers
aggregation, using both may lead to unpredicted behavior.
*
* Default value is false
.
* @returns {boolean} Value of property markFavorite
*/
public getMarkFavorite(): boolean;
/**
* Gets current value of property {@link #getMarkFlagged markFlagged}.
*
* Sets the flagged state for the ObjectHeader
. The showMarkers
property
* must be set to true
for this property to take effect.
*
* Note: As this property is deprecated, we recommend that you use the markers
* aggregation - add sap.m.ObjectMarker
with type sap.m.ObjectMarkerType.Flagged
.
* You should use either this property or the markers
aggregation, using both may lead to unpredicted behavior.
*
* Default value is false
.
* @returns {boolean} Value of property markFlagged
*/
public getMarkFlagged(): boolean;
/**
* Returns a metadata object for class sap.m.ObjectHeader.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getNumber number}.
*
* Determines the displayed number of the ObjectHeader
number field.
* @returns {string} Value of property number
*/
public getNumber(): string;
/**
* Gets current value of property {@link #getNumberState numberState}.
*
* Determines the value state of the number and numberUnit properties.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property numberState
*/
public getNumberState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getNumberTextDirection numberTextDirection}.
*
* Specifies the number and unit text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property numberTextDirection
*/
public getNumberTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getNumberUnit numberUnit}.
*
* Determines the units qualifier of the ObjectHeader
number.
*
* Note: The value of the numberUnit
is not displayed if the
* number property is set to null
.
* @returns {string} Value of property numberUnit
*/
public getNumberUnit(): string;
/**
* Gets current value of property {@link #getResponsive responsive}.
*
* Determines whether the ObjectHeader is rendered with a different design that
* reacts responsively to the screen sizes.
*
* Note: Be aware that the design and behavior of the responsive ObjectHeader
* could change without further notification.
*
* Default value is false
.
* @returns {boolean} Value of property responsive
*/
public getResponsive(): boolean;
/**
* Gets content of aggregation {@link #getSecondStatus secondStatus}.
*
* Second status shown on the right side of the attributes below the first status.
* If it is not set the second attribute will expand to take the entire row.
* @returns {sap.m.ObjectStatus}
*/
public getSecondStatus(): sap.m.ObjectStatus;
/**
* Gets current value of property {@link #getShowMarkers showMarkers}.
*
* If set to true
, the ObjectHeader
can be marked with icons such as favorite and flag.
*
* Note: This property is valid only if you are using the already deprecated properties - markFlagged
and markFavorite
.
* If you are using the markers
aggregation, the visibility of the markers depends on what is set in the aggregation itself.
*
* Default value is false
.
* @returns {boolean} Value of property showMarkers
*/
public getShowMarkers(): boolean;
/**
* Gets current value of property {@link #getShowTitleSelector showTitleSelector}.
*
* Determines whether the selector arrow icon/image is displayed and can be pressed.
*
* Default value is false
.
* @returns {boolean} Value of property showTitleSelector
*/
public getShowTitleSelector(): boolean;
/**
* Gets content of aggregation {@link #getStatuses statuses}.
*
* The list of Object sap.ui.core.Control. It will only allow sap.m.ObjectStatus and sap.m.ProgressIndicator controls.
* @returns {sap.ui.core.Control[]}
*/
public getStatuses(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getTitle title}.
*
* Determines the title of the ObjectHeader
.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getTitleActive titleActive}.
*
* Determines whether the title of the ObjectHeader
is clickable
* and is set only if a title is provided.
* @returns {boolean} Value of property titleActive
*/
public getTitleActive(): boolean;
/**
* Gets current value of property {@link #getTitleHref titleHref}.
*
* Defines the title link target URI. Supports standard hyperlink behavior.
*
* Note: If an action should be triggered, this property should not be set, but instead
* an event handler for the titlePress
event should be registered.
* @returns {sap.ui.core.URI} Value of property titleHref
*/
public getTitleHref(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getTitleLevel titleLevel}.
*
* Defines the semantic level of the title.
*
* This information is used by assistive technologies, such as screen readers to create a hierarchical site map for faster navigation.
* Depending on this setting an HTML h1-h6 element is used.
*
* Default value is H1
.
* @returns {sap.ui.core.TitleLevel} Value of property titleLevel
*/
public getTitleLevel(): sap.ui.core.TitleLevel;
/**
* Gets current value of property {@link #getTitleSelectorTooltip titleSelectorTooltip}.
*
* Determines a custom text for the tooltip of the select title arrow. If not set, a default text of the tooltip will be displayed.
*
* Default value is Options
.
* @returns {string} Value of property titleSelectorTooltip
*/
public getTitleSelectorTooltip(): string;
/**
* Gets current value of property {@link #getTitleTarget titleTarget}.
*
* Determines the target
attribute for the title link. Options are _self
,
* _top
, _blank
, _parent
, _search
. Alternatively,
* a frame name can be entered.
* @returns {string} Value of property titleTarget
*/
public getTitleTarget(): string;
/**
* Gets current value of property {@link #getTitleTextDirection titleTextDirection}.
*
* Specifies the title text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property titleTextDirection
*/
public getTitleTextDirection(): sap.ui.core.TextDirection;
/**
* Checks for the provided sap.m.ObjectNumber
in the aggregation {@link #getAdditionalNumbers additionalNumbers}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ObjectNumber} oAdditionalNumber - The additionalNumber whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAdditionalNumber(oAdditionalNumber: sap.m.ObjectNumber): number;
/**
* Checks for the provided sap.m.ObjectAttribute
in the aggregation {@link #getAttributes attributes}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ObjectAttribute} oAttribute - The attribute whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAttribute(oAttribute: sap.m.ObjectAttribute): number;
/**
* Checks for the provided sap.m.ObjectMarker
in the aggregation {@link #getMarkers markers}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ObjectMarker} oMarker - The marker whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfMarker(oMarker: sap.m.ObjectMarker): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getStatuses statuses}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oStatus - The status whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfStatus(oStatus: sap.ui.core.Control): number;
/**
* Inserts a additionalNumber into the aggregation {@link #getAdditionalNumbers additionalNumbers}.
* @param {sap.m.ObjectNumber} oAdditionalNumber - the additionalNumber to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the additionalNumber should be inserted at; for a negative value of iIndex
, the additionalNumber is inserted at position 0; for a value greater than the current size of the aggregation, the additionalNumber is inserted at the last position
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public insertAdditionalNumber(oAdditionalNumber: sap.m.ObjectNumber, iIndex: number): sap.m.ObjectHeader;
/**
* Inserts a attribute into the aggregation {@link #getAttributes attributes}.
* @param {sap.m.ObjectAttribute} oAttribute - the attribute to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the attribute should be inserted at; for a negative value of iIndex
, the attribute is inserted at position 0; for a value greater than the current size of the aggregation, the attribute is inserted at the last position
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public insertAttribute(oAttribute: sap.m.ObjectAttribute, iIndex: number): sap.m.ObjectHeader;
/**
* Inserts a marker into the aggregation {@link #getMarkers markers}.
* @param {sap.m.ObjectMarker} oMarker - the marker to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the marker should be inserted at; for a negative value of iIndex
, the marker is inserted at position 0; for a value greater than the current size of the aggregation, the marker is inserted at the last position
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public insertMarker(oMarker: sap.m.ObjectMarker, iIndex: number): sap.m.ObjectHeader;
/**
* Inserts a status into the aggregation {@link #getStatuses statuses}.
* @param {sap.ui.core.Control} oStatus - the status to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the status should be inserted at; for a negative value of iIndex
, the status is inserted at position 0; for a value greater than the current size of the aggregation, the status is inserted at the last position
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public insertStatus(oStatus: sap.ui.core.Control, iIndex: number): sap.m.ObjectHeader;
/**
* Removes a additionalNumber from the aggregation {@link #getAdditionalNumbers additionalNumbers}.
* @param {number|string|sap.m.ObjectNumber} vAdditionalNumber - The additionalNumber to remove or its index or id
* @returns {sap.m.ObjectNumber} The removed additionalNumber or null
*/
public removeAdditionalNumber(vAdditionalNumber: number|string|sap.m.ObjectNumber): sap.m.ObjectNumber;
/**
* Removes all the controls from the aggregation {@link #getAdditionalNumbers additionalNumbers}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ObjectNumber[]} An array of the removed elements (might be empty)
*/
public removeAllAdditionalNumbers(): sap.m.ObjectNumber[];
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getAttributes attributes}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ObjectAttribute[]} An array of the removed elements (might be empty)
*/
public removeAllAttributes(): sap.m.ObjectAttribute[];
/**
* Removes all the controls from the aggregation {@link #getMarkers markers}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ObjectMarker[]} An array of the removed elements (might be empty)
*/
public removeAllMarkers(): sap.m.ObjectMarker[];
/**
* Removes all the controls from the aggregation {@link #getStatuses statuses}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllStatuses(): sap.ui.core.Control[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a attribute from the aggregation {@link #getAttributes attributes}.
* @param {number|string|sap.m.ObjectAttribute} vAttribute - The attribute to remove or its index or id
* @returns {sap.m.ObjectAttribute} The removed attribute or null
*/
public removeAttribute(vAttribute: number|string|sap.m.ObjectAttribute): sap.m.ObjectAttribute;
/**
* Removes a marker from the aggregation {@link #getMarkers markers}.
* @param {number|string|sap.m.ObjectMarker} vMarker - The marker to remove or its index or id
* @returns {sap.m.ObjectMarker} The removed marker or null
*/
public removeMarker(vMarker: number|string|sap.m.ObjectMarker): sap.m.ObjectMarker;
/**
* Removes a status from the aggregation {@link #getStatuses statuses}.
* @param {number|string|sap.ui.core.Control} vStatus - The status to remove or its index or id
* @returns {sap.ui.core.Control} The removed status or null
*/
public removeStatus(vStatus: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
*
* Determines the background color of the ObjectHeader
.
*
* Note: The different types of ObjectHeader
come with different default background:
*
* - non responsive - Transparent
* - responsive - Translucent
* - condensed - Solid
*
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.m.BackgroundDesign} sBackgroundDesign - New value for property backgroundDesign
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setBackgroundDesign(sBackgroundDesign: sap.m.BackgroundDesign): sap.m.ObjectHeader;
/**
* Set the condensed flag
* @param {boolean} bCondensed - the new value
* @returns {sap.m.ObjectHeader} this pointer for chaining
*/
public setCondensed(bCondensed: boolean): sap.m.ObjectHeader;
/**
* Sets the aggregated {@link #getFirstStatus firstStatus}.
* @param {sap.m.ObjectStatus} oFirstStatus - The firstStatus to set
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setFirstStatus(oFirstStatus: sap.m.ObjectStatus): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getFullScreenOptimized fullScreenOptimized}.
*
* Optimizes the display of the elements of the ObjectHeader
.
*
* Set this property to true
if your app uses a fullscreen layout (as opposed
* to a master-detail or other split-screen layout).
*
* Note: Only applied if the responsive
property is also set to true
.
*
* If set to true
, the following situations apply:
*
* - On desktop, 1-3 attributes/statuses - positioned as a third block on the right side of the Title/Number group
* - On desktop, 4+ attributes/statuses - 4 columns below the Title/Number
* - On tablet (portrait mode), always in 2 columns below the Title/Number
* - On tablet (landscape mode), 1-2 attributes/statuses - 2 columns below the Title/Number
* - On tablet (landscape mode), 3+ attributes/statuses - 3 columns below the Title/Number
*
* On phone, the attributes and statuses are always positioned in 1 column below the Title/Number of the ObjectHeader
.
*
* If set to false
, the attributes and statuses are being positioned below the
* Title/Number of the ObjectHeader
in 2 or 3 columns depending on their number:
*
* - On desktop, 1-4 attributes/statuses - 2 columns
* - On desktop, 5+ attributes/statuses - 3 columns
* - On tablet, always in 2 columns
*
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bFullScreenOptimized - New value for property fullScreenOptimized
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setFullScreenOptimized(bFullScreenOptimized: boolean): sap.m.ObjectHeader;
/**
* Sets the aggregated {@link #getHeaderContainer headerContainer}.
* @param {sap.m.ObjectHeaderContainer} oHeaderContainer - The headerContainer to set
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setHeaderContainer(oHeaderContainer: sap.m.ObjectHeaderContainer): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Defines the icon of the ObjectHeader
.
*
* Note: Recursive resolution of binding expressions is not supported by the framework.
* It works only in ObjectHeader, since it is a composite control and creates an Image control internally.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getIconActive iconActive}.
*
* Determines whether the ObjectHeader
icon is clickable.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bIconActive - New value for property iconActive
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setIconActive(bIconActive: boolean): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getIconAlt iconAlt}.
*
* Determines the alternative text of the ObjectHeader
icon. The text is
* displayed if the image for the icon is not available, or cannot be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sIconAlt - New value for property iconAlt
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setIconAlt(sIconAlt: string): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getIconDensityAware iconDensityAware}.
*
* By default, this is set to true
but then one or more requests are sent trying to get
* the density perfect version of image if this version of image doesn't exist on the server.
*
* If bandwidth is the key for the application, set this value to false
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconDensityAware - New value for property iconDensityAware
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setIconDensityAware(bIconDensityAware: boolean): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getIconTooltip iconTooltip}.
*
* Determines the tooltip text of the ObjectHeader
icon.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sIconTooltip - New value for property iconTooltip
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setIconTooltip(sIconTooltip: string): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getIntro intro}.
*
* Determines the introductory text for the ObjectHeader
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sIntro - New value for property intro
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setIntro(sIntro: string): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getIntroActive introActive}.
*
* Determines whether the introductory text of the ObjectHeader
is clickable.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bIntroActive - New value for property introActive
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setIntroActive(bIntroActive: boolean): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getIntroHref introHref}.
*
* Determines the intro link target URI. Supports standard hyperlink behavior. If an action should be triggered,
* this should not be set, but instead an event handler for the introPress
event should be registered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIntroHref - New value for property introHref
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setIntroHref(sIntroHref: sap.ui.core.URI): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getIntroTarget introTarget}.
*
* Determines the target
attribute for the intro link. Options are _self
,
* _top
, _blank
, _parent
, _search
. Alternatively,
* a frame name can be entered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sIntroTarget - New value for property introTarget
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setIntroTarget(sIntroTarget: string): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getIntroTextDirection introTextDirection}.
*
* Specifies the intro text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sIntroTextDirection - New value for property introTextDirection
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setIntroTextDirection(sIntroTextDirection: sap.ui.core.TextDirection): sap.m.ObjectHeader;
/**
* Sets the visibility value of the Favorite marker.
* @param {boolean} bMarked - visibility of the marker
* @returns {sap.m.ObjectHeader} this pointer for chaining
*/
public setMarkFavorite(bMarked: boolean): sap.m.ObjectHeader;
/**
* Sets the visibility value of the Flagged marker.
* @param {boolean} bMarked - visibility of the marker
* @returns {sap.m.ObjectHeader} this pointer for chaining
*/
public setMarkFlagged(bMarked: boolean): sap.m.ObjectHeader;
/**
* Set the number value to the internal aggregation
* @param {string} sNumber - the new value
* @returns {sap.m.ObjectHeader} this pointer for chaining
*/
public setNumber(sNumber: string): sap.m.ObjectHeader;
/**
* Set the number state to the internal aggregation
* @param {sap.ui.core.ValueState} sState - the new value
* @returns {sap.m.ObjectHeader} this pointer for chaining
*/
public setNumberState(sState: sap.ui.core.ValueState): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getNumberTextDirection numberTextDirection}.
*
* Specifies the number and unit text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sNumberTextDirection - New value for property numberTextDirection
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setNumberTextDirection(sNumberTextDirection: sap.ui.core.TextDirection): sap.m.ObjectHeader;
/**
* Set the number unit to the internal aggregation
* @param {string} sUnit - the new value
* @returns {sap.m.ObjectHeader} this pointer for chaining
*/
public setNumberUnit(sUnit: string): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getResponsive responsive}.
*
* Determines whether the ObjectHeader is rendered with a different design that
* reacts responsively to the screen sizes.
*
* Note: Be aware that the design and behavior of the responsive ObjectHeader
* could change without further notification.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bResponsive - New value for property responsive
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setResponsive(bResponsive: boolean): sap.m.ObjectHeader;
/**
* Sets the aggregated {@link #getSecondStatus secondStatus}.
* @param {sap.m.ObjectStatus} oSecondStatus - The secondStatus to set
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setSecondStatus(oSecondStatus: sap.m.ObjectStatus): sap.m.ObjectHeader;
/**
* Sets the visibility value of the Flagged and Favorite markers.
* @param {boolean} bMarked - visibility of all markers
* @returns {sap.m.ObjectHeader} this pointer for chaining
*/
public setShowMarkers(bMarked: boolean): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getShowTitleSelector showTitleSelector}.
*
* Determines whether the selector arrow icon/image is displayed and can be pressed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowTitleSelector - New value for property showTitleSelector
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setShowTitleSelector(bShowTitleSelector: boolean): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Determines the title of the ObjectHeader
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getTitleActive titleActive}.
*
* Determines whether the title of the ObjectHeader
is clickable
* and is set only if a title is provided.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bTitleActive - New value for property titleActive
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setTitleActive(bTitleActive: boolean): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getTitleHref titleHref}.
*
* Defines the title link target URI. Supports standard hyperlink behavior.
*
* Note: If an action should be triggered, this property should not be set, but instead
* an event handler for the titlePress
event should be registered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sTitleHref - New value for property titleHref
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setTitleHref(sTitleHref: sap.ui.core.URI): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getTitleLevel titleLevel}.
*
* Defines the semantic level of the title.
*
* This information is used by assistive technologies, such as screen readers to create a hierarchical site map for faster navigation.
* Depending on this setting an HTML h1-h6 element is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is H1
.
* @param {sap.ui.core.TitleLevel} sTitleLevel - New value for property titleLevel
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setTitleLevel(sTitleLevel: sap.ui.core.TitleLevel): sap.m.ObjectHeader;
/**
* Sets the new text for the tooltip of the select title arrow to the internal aggregation
* @param {any} sTooltip - the tooltip of the title selector
* @returns {sap.m.ObjectHeader} this pointer for chaining
*/
public setTitleSelectorTooltip(sTooltip: any): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getTitleTarget titleTarget}.
*
* Determines the target
attribute for the title link. Options are _self
,
* _top
, _blank
, _parent
, _search
. Alternatively,
* a frame name can be entered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitleTarget - New value for property titleTarget
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setTitleTarget(sTitleTarget: string): sap.m.ObjectHeader;
/**
* Sets a new value for property {@link #getTitleTextDirection titleTextDirection}.
*
* Specifies the title text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTitleTextDirection - New value for property titleTextDirection
* @returns {sap.m.ObjectHeader} Reference to this
in order to allow method chaining
*/
public setTitleTextDirection(sTitleTextDirection: sap.ui.core.TextDirection): sap.m.ObjectHeader;
}
/**
* Marker interface for controls which are suitable as items for the ObjectHeader.
*/
export interface ObjectHeaderContainer {
}
/**
* The ObjectIdentifier is a display control that enables the user to easily identify a specific object. The ObjectIdentifier title is the key identifier of the object and additional text and icons can be used to further distinguish it from other objects.
*/
export class ObjectIdentifier extends sap.ui.core.Control {
/**
* Constructor for a new ObjectIdentifier.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.ObjectIdentifier} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.ObjectIdentifier;
/**
* Attaches event handler fnFunction
to the {@link #event:titlePress titlePress} event of this sap.m.ObjectIdentifier
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ObjectIdentifier
itself.
*
* Fires when the title is active and the user taps/clicks on it.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ObjectIdentifier
itself
* @returns {sap.m.ObjectIdentifier} Reference to this
in order to allow method chaining
*/
public attachTitlePress(fnFunction: Function, oListener?: any): sap.m.ObjectIdentifier;
/**
* Attaches event handler fnFunction
to the {@link #event:titlePress titlePress} event of this sap.m.ObjectIdentifier
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ObjectIdentifier
itself.
*
* Fires when the title is active and the user taps/clicks on it.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ObjectIdentifier
itself
* @returns {sap.m.ObjectIdentifier} Reference to this
in order to allow method chaining
*/
public attachTitlePress(oData: any, fnFunction: Function, oListener?: any): sap.m.ObjectIdentifier;
/**
* Detaches event handler fnFunction
from the {@link #event:titlePress titlePress} event of this sap.m.ObjectIdentifier
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ObjectIdentifier} Reference to this
in order to allow method chaining
*/
public detachTitlePress(fnFunction: Function, oListener: any): sap.m.ObjectIdentifier;
/**
* Creates a new subclass of class sap.m.ObjectIdentifier with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:titlePress titlePress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ObjectIdentifier} Reference to this
in order to allow method chaining
*/
protected fireTitlePress(mParameters?: any): sap.m.ObjectIdentifier;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getBadgeAttachments badgeAttachments}.
*
* Indicates whether or not the attachments icon is displayed.
* @returns {boolean} Value of property badgeAttachments
*/
public getBadgeAttachments(): boolean;
/**
* Gets current value of property {@link #getBadgeNotes badgeNotes}.
*
* Indicates whether or not the notes icon is displayed.
* @returns {boolean} Value of property badgeNotes
*/
public getBadgeNotes(): boolean;
/**
* Gets current value of property {@link #getBadgePeople badgePeople}.
*
* Indicates whether or not the address book icon is displayed.
* @returns {boolean} Value of property badgePeople
*/
public getBadgePeople(): boolean;
/**
* Returns a metadata object for class sap.m.ObjectIdentifier.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* Defines the object text.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Specifies the element's text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getTitle title}.
*
* Defines the object title.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getTitleActive titleActive}.
*
* Indicates if the ObjectIdentifier's title is clickable.
*
* Default value is false
.
* @returns {boolean} Value of property titleActive
*/
public getTitleActive(): boolean;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Indicates if the ObjectIdentifier is visible. An invisible ObjectIdentifier is not being rendered.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getBadgeAttachments badgeAttachments}.
*
* Indicates whether or not the attachments icon is displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bBadgeAttachments - New value for property badgeAttachments
* @returns {sap.m.ObjectIdentifier} Reference to this
in order to allow method chaining
*/
public setBadgeAttachments(bBadgeAttachments: boolean): sap.m.ObjectIdentifier;
/**
* Sets a new value for property {@link #getBadgeNotes badgeNotes}.
*
* Indicates whether or not the notes icon is displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bBadgeNotes - New value for property badgeNotes
* @returns {sap.m.ObjectIdentifier} Reference to this
in order to allow method chaining
*/
public setBadgeNotes(bBadgeNotes: boolean): sap.m.ObjectIdentifier;
/**
* Sets a new value for property {@link #getBadgePeople badgePeople}.
*
* Indicates whether or not the address book icon is displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bBadgePeople - New value for property badgePeople
* @returns {sap.m.ObjectIdentifier} Reference to this
in order to allow method chaining
*/
public setBadgePeople(bBadgePeople: boolean): sap.m.ObjectIdentifier;
/**
* Sets text.
* Default value is empty/undefined.
* @param {string} sText - New value for property text
* @returns {sap.m.ObjectIdentifier} this to allow method chaining
*/
public setText(sText: string): sap.m.ObjectIdentifier;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Specifies the element's text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.ObjectIdentifier} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.ObjectIdentifier;
/**
* Sets the title.
* Default value is empty/undefined.
* @param {string} sTitle - New value for property title
* @returns {sap.m.ObjectIdentifier} this to allow method chaining
*/
public setTitle(sTitle: string): sap.m.ObjectIdentifier;
/**
* Sets property titleActive.
* Default value is false.
* @param {boolean} bValue - new value for property titleActive
* @returns {sap.m.ObjectIdentifier} this to allow method chaining
*/
public setTitleActive(bValue: boolean): sap.m.ObjectIdentifier;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Indicates if the ObjectIdentifier is visible. An invisible ObjectIdentifier is not being rendered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.ObjectIdentifier} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.ObjectIdentifier;
}
/**
* ObjectListItem is a display control that provides summary information about an object as a list item. The ObjectListItem title is the key identifier of the object. Additional text and icons can be used to further distinguish it from other objects. Attributes and statuses can be used to provide additional meaning about the object to the user.
*/
export class ObjectListItem extends sap.m.ListItemBase {
/**
* Constructor for a new ObjectListItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some attribute to the aggregation {@link #getAttributes attributes}.
* @param {sap.m.ObjectAttribute} oAttribute - the attribute to add; if empty, nothing is inserted
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public addAttribute(oAttribute: sap.m.ObjectAttribute): sap.m.ObjectListItem;
/**
* Adds some marker to the aggregation {@link #getMarkers markers}.
* @param {sap.m.ObjectMarker} oMarker - the marker to add; if empty, nothing is inserted
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public addMarker(oMarker: sap.m.ObjectMarker): sap.m.ObjectListItem;
/**
* Destroys all the attributes in the aggregation {@link #getAttributes attributes}.
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public destroyAttributes(): sap.m.ObjectListItem;
/**
* Destroys the firstStatus in the aggregation {@link #getFirstStatus firstStatus}.
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public destroyFirstStatus(): sap.m.ObjectListItem;
/**
* Destroys all the markers in the aggregation {@link #getMarkers markers}.
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public destroyMarkers(): sap.m.ObjectListItem;
/**
* Destroys the secondStatus in the aggregation {@link #getSecondStatus secondStatus}.
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public destroySecondStatus(): sap.m.ObjectListItem;
/**
* Creates a new subclass of class sap.m.ObjectListItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ListItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getActiveIcon activeIcon}.
*
* Icon displayed when the ObjectListItem is active.
* @returns {sap.ui.core.URI} Value of property activeIcon
*/
public getActiveIcon(): sap.ui.core.URI;
/**
* Gets content of aggregation {@link #getAttributes attributes}.
*
* List of attributes displayed below the title to the left of the status fields.
* @returns {sap.m.ObjectAttribute[]}
*/
public getAttributes(): sap.m.ObjectAttribute[];
/**
* Gets content of aggregation {@link #getFirstStatus firstStatus}.
*
* First status text field displayed on the right side of the attributes.
* @returns {sap.m.ObjectStatus}
*/
public getFirstStatus(): sap.m.ObjectStatus;
/**
* Gets current value of property {@link #getIcon icon}.
*
* ObjectListItem icon displayed to the left of the title.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconDensityAware iconDensityAware}.
*
* By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image (in case this version of image doesn't exist on the server).
*
* If bandwidth is key for the application, set this value to false.
*
* Default value is true
.
* @returns {boolean} Value of property iconDensityAware
*/
public getIconDensityAware(): boolean;
/**
* Gets current value of property {@link #getIntro intro}.
*
* Defines the introductory text for the ObjectListItem.
* @returns {string} Value of property intro
*/
public getIntro(): string;
/**
* Gets current value of property {@link #getIntroTextDirection introTextDirection}.
*
* Determines the text direction of the item intro.
* Available options for the intro direction are LTR (left-to-right) and RTL (right-to-left).
* By default the item intro inherits the text direction from its parent.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property introTextDirection
*/
public getIntroTextDirection(): sap.ui.core.TextDirection;
/**
* Gets content of aggregation {@link #getMarkers markers}.
*
* List of markers (icon and/or text) that can be displayed for the ObjectListItems
, such as favorite and flagged.
* Note: You should use either this aggregation or the already deprecated properties - markFlagged
, markFavorite
, and markLocked
. Using both can lead to unexpected results.
* @returns {sap.m.ObjectMarker[]}
*/
public getMarkers(): sap.m.ObjectMarker[];
/**
* Gets current value of property {@link #getMarkFavorite markFavorite}.
*
* Sets the favorite state for the ObjectListItem.
* Note: As this property is deprecated, we recommend you use the markers
aggregation - add sap.m.ObjectMarker
with type sap.m.ObjectMarkerType.Favorite
.
* You should use either this property or the markers
aggregation, using both may lead to unpredicted behavior.
* @returns {boolean} Value of property markFavorite
*/
public getMarkFavorite(): boolean;
/**
* Gets current value of property {@link #getMarkFlagged markFlagged}.
*
* Sets the flagged state for the ObjectListItem.
* Note: As this property is deprecated, we recommend you use the markers
aggregation - add sap.m.ObjectMarker
with type sap.m.ObjectMarkerType.Flagged
.
* You should use either this property or the markers
aggregation, using both may lead to unpredicted behavior.
* @returns {boolean} Value of property markFlagged
*/
public getMarkFlagged(): boolean;
/**
* Gets current value of property {@link #getMarkLocked markLocked}.
*
* Sets the locked state of the ObjectListItem.
* Note: As this property is deprecated, we recommend you use the markers
aggregation - add sap.m.ObjectMarker
with type sap.m.ObjectMarkerType.Locked
.
* You should use either this property or the markers
aggregation, using both may lead to unpredicted behavior.
*
* Default value is false
.
* @returns {boolean} Value of property markLocked
*/
public getMarkLocked(): boolean;
/**
* Returns a metadata object for class sap.m.ObjectListItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getNumber number}.
*
* Defines the ObjectListItem number.
* @returns {string} Value of property number
*/
public getNumber(): string;
/**
* Gets current value of property {@link #getNumberState numberState}.
*
* Defines the ObjectListItem number and numberUnit value state.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property numberState
*/
public getNumberState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getNumberTextDirection numberTextDirection}.
*
* Determines the text direction of the item number.
* Available options for the number direction are LTR (left-to-right) and RTL (right-to-left).
* By default the item number inherits the text direction from its parent.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property numberTextDirection
*/
public getNumberTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getNumberUnit numberUnit}.
*
* Defines the number units qualifier of the ObjectListItem.
* @returns {string} Value of property numberUnit
*/
public getNumberUnit(): string;
/**
* Gets content of aggregation {@link #getSecondStatus secondStatus}.
*
* Second status text field displayed on the right side of the attributes.
* @returns {sap.m.ObjectStatus}
*/
public getSecondStatus(): sap.m.ObjectStatus;
/**
* Gets current value of property {@link #getShowMarkers showMarkers}.
*
* If set to true, the ObjectListItem can be marked with icons such as favorite and flag.
* Note: This property is valid only if you are using the already deprecated properties - markFlagged
, markFavorite
, and markLocked
.
* If you are using the markers
aggregation, the visibility of the markers depends on what is set in the aggregation itself.
* @returns {boolean} Value of property showMarkers
*/
public getShowMarkers(): boolean;
/**
* Gets current value of property {@link #getTitle title}.
*
* Defines the ObjectListItem title.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getTitleTextDirection titleTextDirection}.
*
* Determines the text direction of the item title.
* Available options for the title direction are LTR (left-to-right) and RTL (right-to-left).
* By default the item title inherits the text direction from its parent.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property titleTextDirection
*/
public getTitleTextDirection(): sap.ui.core.TextDirection;
/**
* Checks for the provided sap.m.ObjectAttribute
in the aggregation {@link #getAttributes attributes}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ObjectAttribute} oAttribute - The attribute whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAttribute(oAttribute: sap.m.ObjectAttribute): number;
/**
* Checks for the provided sap.m.ObjectMarker
in the aggregation {@link #getMarkers markers}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ObjectMarker} oMarker - The marker whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfMarker(oMarker: sap.m.ObjectMarker): number;
/**
* Inserts a attribute into the aggregation {@link #getAttributes attributes}.
* @param {sap.m.ObjectAttribute} oAttribute - the attribute to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the attribute should be inserted at; for a negative value of iIndex
, the attribute is inserted at position 0; for a value greater than the current size of the aggregation, the attribute is inserted at the last position
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public insertAttribute(oAttribute: sap.m.ObjectAttribute, iIndex: number): sap.m.ObjectListItem;
/**
* Inserts a marker into the aggregation {@link #getMarkers markers}.
* @param {sap.m.ObjectMarker} oMarker - the marker to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the marker should be inserted at; for a negative value of iIndex
, the marker is inserted at position 0; for a value greater than the current size of the aggregation, the marker is inserted at the last position
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public insertMarker(oMarker: sap.m.ObjectMarker, iIndex: number): sap.m.ObjectListItem;
/**
* Removes all the controls from the aggregation {@link #getAttributes attributes}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ObjectAttribute[]} An array of the removed elements (might be empty)
*/
public removeAllAttributes(): sap.m.ObjectAttribute[];
/**
* Removes all the controls from the aggregation {@link #getMarkers markers}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ObjectMarker[]} An array of the removed elements (might be empty)
*/
public removeAllMarkers(): sap.m.ObjectMarker[];
/**
* Removes a attribute from the aggregation {@link #getAttributes attributes}.
* @param {number|string|sap.m.ObjectAttribute} vAttribute - The attribute to remove or its index or id
* @returns {sap.m.ObjectAttribute} The removed attribute or null
*/
public removeAttribute(vAttribute: number|string|sap.m.ObjectAttribute): sap.m.ObjectAttribute;
/**
* Removes a marker from the aggregation {@link #getMarkers markers}.
* @param {number|string|sap.m.ObjectMarker} vMarker - The marker to remove or its index or id
* @returns {sap.m.ObjectMarker} The removed marker or null
*/
public removeMarker(vMarker: number|string|sap.m.ObjectMarker): sap.m.ObjectMarker;
/**
* Sets a new value for property {@link #getActiveIcon activeIcon}.
*
* Icon displayed when the ObjectListItem is active.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sActiveIcon - New value for property activeIcon
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public setActiveIcon(sActiveIcon: sap.ui.core.URI): sap.m.ObjectListItem;
/**
* Sets the aggregated {@link #getFirstStatus firstStatus}.
* @param {sap.m.ObjectStatus} oFirstStatus - The firstStatus to set
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public setFirstStatus(oFirstStatus: sap.m.ObjectStatus): sap.m.ObjectListItem;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* ObjectListItem icon displayed to the left of the title.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.ObjectListItem;
/**
* Sets a new value for property {@link #getIconDensityAware iconDensityAware}.
*
* By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image (in case this version of image doesn't exist on the server).
*
* If bandwidth is key for the application, set this value to false.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconDensityAware - New value for property iconDensityAware
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public setIconDensityAware(bIconDensityAware: boolean): sap.m.ObjectListItem;
/**
* Sets a new value for property {@link #getIntro intro}.
*
* Defines the introductory text for the ObjectListItem.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sIntro - New value for property intro
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public setIntro(sIntro: string): sap.m.ObjectListItem;
/**
* Sets a new value for property {@link #getIntroTextDirection introTextDirection}.
*
* Determines the text direction of the item intro.
* Available options for the intro direction are LTR (left-to-right) and RTL (right-to-left).
* By default the item intro inherits the text direction from its parent.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sIntroTextDirection - New value for property introTextDirection
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public setIntroTextDirection(sIntroTextDirection: sap.ui.core.TextDirection): sap.m.ObjectListItem;
/**
* Sets the visibility value of the Favorite marker.
* @param {boolean} bMarked - the new value
* @returns {sap.m.ObjectListItem} this pointer for chaining
*/
public setMarkFavorite(bMarked: boolean): sap.m.ObjectListItem;
/**
* Sets the visibility value of the Flagged marker.
* @param {boolean} bMarked - the new value
* @returns {sap.m.ObjectListItem} this pointer for chaining
*/
public setMarkFlagged(bMarked: boolean): sap.m.ObjectListItem;
/**
* Sets the visibility value of the Favorite marker.
* @param {boolean} bMarked - the new value
* @returns {sap.m.ObjectListItem} this pointer for chaining
*/
public setMarkLocked(bMarked: boolean): sap.m.ObjectListItem;
/**
* Sets a new value for property {@link #getNumber number}.
*
* Defines the ObjectListItem number.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sNumber - New value for property number
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public setNumber(sNumber: string): sap.m.ObjectListItem;
/**
* Sets a new value for property {@link #getNumberState numberState}.
*
* Defines the ObjectListItem number and numberUnit value state.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sNumberState - New value for property numberState
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public setNumberState(sNumberState: sap.ui.core.ValueState): sap.m.ObjectListItem;
/**
* Sets a new value for property {@link #getNumberTextDirection numberTextDirection}.
*
* Determines the text direction of the item number.
* Available options for the number direction are LTR (left-to-right) and RTL (right-to-left).
* By default the item number inherits the text direction from its parent.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sNumberTextDirection - New value for property numberTextDirection
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public setNumberTextDirection(sNumberTextDirection: sap.ui.core.TextDirection): sap.m.ObjectListItem;
/**
* Sets a new value for property {@link #getNumberUnit numberUnit}.
*
* Defines the number units qualifier of the ObjectListItem.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sNumberUnit - New value for property numberUnit
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public setNumberUnit(sNumberUnit: string): sap.m.ObjectListItem;
/**
* Sets the aggregated {@link #getSecondStatus secondStatus}.
* @param {sap.m.ObjectStatus} oSecondStatus - The secondStatus to set
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public setSecondStatus(oSecondStatus: sap.m.ObjectStatus): sap.m.ObjectListItem;
/**
* Sets the visibility value of the Flagged and Favorite markers.
* @param {boolean} bMarked - the new value
* @returns {sap.m.ObjectListItem} this pointer for chaining
*/
public setShowMarkers(bMarked: boolean): sap.m.ObjectListItem;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Defines the ObjectListItem title.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.ObjectListItem;
/**
* Sets a new value for property {@link #getTitleTextDirection titleTextDirection}.
*
* Determines the text direction of the item title.
* Available options for the title direction are LTR (left-to-right) and RTL (right-to-left).
* By default the item title inherits the text direction from its parent.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTitleTextDirection - New value for property titleTextDirection
* @returns {sap.m.ObjectListItem} Reference to this
in order to allow method chaining
*/
public setTitleTextDirection(sTitleTextDirection: sap.ui.core.TextDirection): sap.m.ObjectListItem;
}
/**
* The sap.m.ObjectMarker
control represents one of the following predefined types:
*
* Flagged
* Favorite
* Draft
* Locked
* LockedBy
* Unsaved
* UnsavedBy
*
* Note: Use the LockedBy/UnsavedBy
type along with the additionalInfo
property to display the name of the user who locked/changed the object.
* If additionalInfo
property is not set when using LockedBy/UnsavedBy
types, the string "Locked by another user"/"Unsaved changes by another user" will be displayed.
* If you don't want to display name of the user, simply use the Locked/Unsaved
types.
*/
export class ObjectMarker extends sap.ui.core.Control {
/**
* Constructor for a new ObjectMarker.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.ObjectMarker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ObjectMarker
itself.
*
* Event is fired when the ObjectMarker
is interactive and the user taps/clicks on it.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ObjectMarker
itself
* @returns {sap.m.ObjectMarker} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.ObjectMarker;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.ObjectMarker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ObjectMarker
itself.
*
* Event is fired when the ObjectMarker
is interactive and the user taps/clicks on it.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ObjectMarker
itself
* @returns {sap.m.ObjectMarker} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.ObjectMarker;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.ObjectMarker
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ObjectMarker} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.ObjectMarker;
/**
* Creates a new subclass of class sap.m.ObjectMarker with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ObjectMarker} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.ObjectMarker;
/**
* Gets current value of property {@link #getAdditionalInfo additionalInfo}.
*
* Sets additional information to the displayed type
.
*
* Note: If no type is set, the additional information will not be displayed.
*
* Default value is
.
* @returns {string} Value of property additionalInfo
*/
public getAdditionalInfo(): string;
/**
* Returns a metadata object for class sap.m.ObjectMarker.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getType type}.
*
* Sets one of the predefined types.
*
* Note: If the visibility
property is not specified explicitly, every type
comes with predefined one as follows:
*
* - For
Flagged
and Favorite
the icon is visible and the text is not displayed
* - For
Draft
the text is visible and the icon is not displayed
* - For
Locked
, LockedBy
, Unsaved
and UnsavedBy
- on screens larger than 600px both icon and text are visible, otherwise only the icon
*
*
* @returns {sap.m.ObjectMarkerType} Value of property type
*/
public getType(): sap.m.ObjectMarkerType;
/**
* Gets current value of property {@link #getVisibility visibility}.
*
* Sets one of the visibility states.
* Visibility states are as follows:
*
* IconOnly
- displays only icon, regardless of the screen size
* TextOnly
- displays only text, regardless of the screen size
* IconAndText
- displays both icon and text, regardless of the screen size
*
* @returns {sap.m.ObjectMarkerVisibility} Value of property visibility
*/
public getVisibility(): sap.m.ObjectMarkerVisibility;
/**
* Sets a new value for property {@link #getAdditionalInfo additionalInfo}.
*
* Sets additional information to the displayed type
.
*
* Note: If no type is set, the additional information will not be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sAdditionalInfo - New value for property additionalInfo
* @returns {sap.m.ObjectMarker} Reference to this
in order to allow method chaining
*/
public setAdditionalInfo(sAdditionalInfo: string): sap.m.ObjectMarker;
/**
* Sets a new value for property {@link #getType type}.
*
* Sets one of the predefined types.
*
* Note: If the visibility
property is not specified explicitly, every type
comes with predefined one as follows:
*
* - For
Flagged
and Favorite
the icon is visible and the text is not displayed
* - For
Draft
the text is visible and the icon is not displayed
* - For
Locked
, LockedBy
, Unsaved
and UnsavedBy
- on screens larger than 600px both icon and text are visible, otherwise only the icon
*
*
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.m.ObjectMarkerType} sType - New value for property type
* @returns {sap.m.ObjectMarker} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.m.ObjectMarkerType): sap.m.ObjectMarker;
/**
* Sets a new value for property {@link #getVisibility visibility}.
*
* Sets one of the visibility states.
* Visibility states are as follows:
*
* IconOnly
- displays only icon, regardless of the screen size
* TextOnly
- displays only text, regardless of the screen size
* IconAndText
- displays both icon and text, regardless of the screen size
*
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.m.ObjectMarkerVisibility} sVisibility - New value for property visibility
* @returns {sap.m.ObjectMarker} Reference to this
in order to allow method chaining
*/
public setVisibility(sVisibility: sap.m.ObjectMarkerVisibility): sap.m.ObjectMarker;
}
/**
* Predefined types for ObjectMarker.
*/
export enum ObjectMarkerType {
/**
* Draft type
*/
Draft = "Draft",
/**
* Favorite type
*/
Favorite = "Favorite",
/**
* Flagged type
*/
Flagged = "Flagged",
/**
* Locked type
*/
Locked = "Locked",
/**
* LockedBy type
* Use when you need to display the name of the user who locked the object.
*/
LockedBy = "LockedBy",
/**
* Unsaved type
*/
Unsaved = "Unsaved",
/**
* UnsavedBy type
* Use when you need to display the name of the user whos changes were unsaved.
*/
UnsavedBy = "UnsavedBy",
}
/**
* Predefined visibility for ObjectMarker.
*/
export enum ObjectMarkerVisibility {
/**
* Shows icon and text
*/
IconAndText = "IconAndText",
/**
* Shows only icon
*/
IconOnly = "IconOnly",
/**
* Shows only text
*/
TextOnly = "TextOnly",
}
/**
* The ObjectNumber control displays number and number unit properties for an object. The number can be displayed using semantic
* colors to provide additional meaning about the object to the user.
*/
export class ObjectNumber extends sap.ui.core.Control {
/**
* Constructor for a new ObjectNumber.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.ObjectNumber} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.ObjectNumber;
/**
* Creates a new subclass of class sap.m.ObjectNumber with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEmphasized emphasized}.
*
* Indicates if the object number should appear emphasized.
*
* Default value is true
.
* @returns {boolean} Value of property emphasized
*/
public getEmphasized(): boolean;
/**
* Returns a metadata object for class sap.m.ObjectNumber.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getNumber number}.
*
* Defines the number field.
* @returns {string} Value of property number
*/
public getNumber(): string;
/**
* Gets current value of property {@link #getNumberUnit numberUnit}.
*
* Defines the number units qualifier.
* @returns {string} Value of property numberUnit
*/
public getNumberUnit(): string;
/**
* Gets current value of property {@link #getState state}.
*
* Determines the object number's value state. Setting this state will cause the number to be rendered in state-specific colors (only blue-crystal theme).
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property state
*/
public getState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getTextAlign textAlign}.
*
* Sets the horizontal alignment of the number and unit.
*
* Default value is Begin
.
* @returns {sap.ui.core.TextAlign} Value of property textAlign
*/
public getTextAlign(): sap.ui.core.TextAlign;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Available options for the number and unit text direction are LTR(left-to-right) and RTL(right-to-left). By default, the control inherits the text direction from its parent control.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getUnit unit}.
*
* Defines the number units qualifier. If numberUnit and unit are both set, the unit value is used.
* @returns {string} Value of property unit
*/
public getUnit(): string;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getEmphasized emphasized}.
*
* Indicates if the object number should appear emphasized.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEmphasized - New value for property emphasized
* @returns {sap.m.ObjectNumber} Reference to this
in order to allow method chaining
*/
public setEmphasized(bEmphasized: boolean): sap.m.ObjectNumber;
/**
* Sets a new value for property {@link #getNumber number}.
*
* Defines the number field.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sNumber - New value for property number
* @returns {sap.m.ObjectNumber} Reference to this
in order to allow method chaining
*/
public setNumber(sNumber: string): sap.m.ObjectNumber;
/**
* Sets a new value for property {@link #getNumberUnit numberUnit}.
*
* Defines the number units qualifier.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sNumberUnit - New value for property numberUnit
* @returns {sap.m.ObjectNumber} Reference to this
in order to allow method chaining
*/
public setNumberUnit(sNumberUnit: string): sap.m.ObjectNumber;
/**
* Sets the ObjectNumber's value state.
* @param {sap.ui.core.ValueState} sState - The state to be set to
* @returns {sap.m.ObjectNumber} this pointer for chaining
*/
public setState(sState: sap.ui.core.ValueState): sap.m.ObjectNumber;
/**
* Sets the text alignment of the control without re-rendering the whole ObjectNumber.
* @param {sap.ui.core.TextAlign} sAlign - The new value
* @returns {sap.m.ObjectNumber} this
pointer for chaining
*/
public setTextAlign(sAlign: sap.ui.core.TextAlign): sap.m.ObjectNumber;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Available options for the number and unit text direction are LTR(left-to-right) and RTL(right-to-left). By default, the control inherits the text direction from its parent control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.ObjectNumber} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.ObjectNumber;
/**
* Sets a new value for property {@link #getUnit unit}.
*
* Defines the number units qualifier. If numberUnit and unit are both set, the unit value is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sUnit - New value for property unit
* @returns {sap.m.ObjectNumber} Reference to this
in order to allow method chaining
*/
public setUnit(sUnit: string): sap.m.ObjectNumber;
}
/**
* Status information that can be either text with a value state, or an icon.
*/
export class ObjectStatus extends sap.ui.core.Control {
/**
* Constructor for a new ObjectStatus.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.ObjectStatus} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.ObjectStatus;
/**
* Creates a new subclass of class sap.m.ObjectStatus with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getIcon icon}.
*
* Icon URI. This may be either an icon font or image path.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconDensityAware iconDensityAware}.
*
* By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
*
* If bandwidth is key for the application, set this value to false.
*
* Default value is true
.
* @returns {boolean} Value of property iconDensityAware
*/
public getIconDensityAware(): boolean;
/**
* Returns a metadata object for class sap.m.ObjectStatus.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getState state}.
*
* Defines the text value state.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property state
*/
public getState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getText text}.
*
* Defines the ObjectStatus text.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Determines the direction of the text, not including the title.
* Available options for the text direction are LTR (left-to-right) and RTL (right-to-left). By default the control inherits the text direction from its parent control.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getTitle title}.
*
* Defines the ObjectStatus title.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Icon URI. This may be either an icon font or image path.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.ObjectStatus} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.ObjectStatus;
/**
* Sets a new value for property {@link #getIconDensityAware iconDensityAware}.
*
* By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
*
* If bandwidth is key for the application, set this value to false.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconDensityAware - New value for property iconDensityAware
* @returns {sap.m.ObjectStatus} Reference to this
in order to allow method chaining
*/
public setIconDensityAware(bIconDensityAware: boolean): sap.m.ObjectStatus;
/**
* Sets a new value for property {@link #getState state}.
*
* Defines the text value state.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sState - New value for property state
* @returns {sap.m.ObjectStatus} Reference to this
in order to allow method chaining
*/
public setState(sState: sap.ui.core.ValueState): sap.m.ObjectStatus;
/**
* Sets the text.
* The default value is empty/undefined.
* @param {string} sText - New value for property text
* @returns {sap.m.ObjectStatus} this to allow method chaining
*/
public setText(sText: string): sap.m.ObjectStatus;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Determines the direction of the text, not including the title.
* Available options for the text direction are LTR (left-to-right) and RTL (right-to-left). By default the control inherits the text direction from its parent control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.ObjectStatus} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.ObjectStatus;
/**
* Sets the title.
* The default value is empty/undefined.
* @param {string} sTitle - New value for property title
* @returns {sap.m.ObjectStatus} this to allow method chaining
*/
public setTitle(sTitle: string): sap.m.ObjectStatus;
}
/**
* A container control based on {@link sap.m.Toolbar}, that provides overflow when
* its content does not fit in the visible area.
*
* Overview
*
* The content of the OverflowToolbar
moves into the overflow area from
* right to left when the the available space is not enough in the visible area of
* the container. It can be accessed by the user through the overflow button that
* opens it in a popover.
*
* Note: It is recommended that you use OverflowToolbar
over
* {@link sap.m.Toolbar}, unless you want to avoid overflow in favor of shrinking.
*
* Usage
*
* Different behavior and priorities can be set for each control inside the
* OverflowToolbar
, such as certain actions to appear only in the
* overflow area or to never move there. For more information, see
* {@link sap.m.OverflowToolbarLayoutData} and {@link sap.m.OverflowToolbarPriority}.
*
* Only the following controls can be moved in the overflow area:
*
* - {@link sap.m.Button}
* - {@link sap.m.CheckBox}
* - {@link sap.m.ComboBox}
* - {@link sap.m.DatePicker}
* - {@link sap.m.DateTimeInput}
* - {@link sap.m.DateTimePicker}
* - {@link sap.m.Input}
* - {@link sap.m.OverflowToolbarButton}
* - {@link sap.m.SearchField}
* - {@link sap.m.SegmentedButton}
* - {@link sap.m.Select}
* - {@link sap.m.TimePicker}
* - {@link sap.m.ToggleButton}
* - {@link sap.ui.comp.smartfield.SmartField}
* - {@link sap.ui.comp.smartfield.SmartLabel}
*
* Responsive behavior
*
* The height of the toolbar changes on desktop, tablet, and smartphones.
*/
export class OverflowToolbar extends sap.m.Toolbar {
/**
* Constructor for a new OverflowToolbar
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Returns all the controls from the sap.m.OverflowToolbar
,
* that are not in the overflow area and their visible
property is true
.
* @returns {sap.ui.core.Control[]}
*/
protected _getVisibleAndNonOverflowContent(): sap.ui.core.Control[];
/**
* Closes the overflow area.
* Useful to manually close the overflow after having suppressed automatic closing with "closeOverflowOnInteraction=false".
*/
public closeOverflow(): void;
/**
* Creates a new subclass of class sap.m.OverflowToolbar with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.Toolbar.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.OverflowToolbar.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Represents an {@link sap.m.Button} that shows its text only when in the overflow area of an {@link sap.m.OverflowToolbar}.
*
* Note: This control is intended to be used exclusively in the context of the OverflowToolbar
, whenever it is required
* to have buttons that show only an icon in the toolbar, but icon and text in the overflow menu.
*/
export class OverflowToolbarButton extends sap.m.Button {
/**
* Constructor for a new OverflowToolbarButton
.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.OverflowToolbarButton with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.Button.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.OverflowToolbarButton.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Holds layout data for the {@link sap.m.OverflowToolbar} items.
*/
export class OverflowToolbarLayoutData extends sap.m.ToolbarLayoutData {
/**
* Constructor for a new OverflowToolbarLayoutData
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new element, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.OverflowToolbarLayoutData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ToolbarLayoutData.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getCloseOverflowOnInteraction closeOverflowOnInteraction}.
*
* Defines whether the overflow area is automatically closed when interacting with a control in it
*
* Default value is true
.
* @returns {boolean} Value of property closeOverflowOnInteraction
*/
public getCloseOverflowOnInteraction(): boolean;
/**
* Gets current value of property {@link #getGroup group}.
*
* Defines OverflowToolbar items group number.
* Default value is 0, which means that the control does not belong to any group.
* Elements that belong to a group overflow together. The overall priority of the group is defined by the element with highest priority.
* Elements that belong to a group are not allowed to have AlwaysOverflow or NeverOverflow priority.
*
* Default value is 0
.
* @returns {number} Value of property group
*/
public getGroup(): number;
/**
* Returns a metadata object for class sap.m.OverflowToolbarLayoutData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMoveToOverflow moveToOverflow}.
*
* The OverflowToolbar item can or cannot move to the overflow area
*
* Default value is true
.
* @returns {boolean} Value of property moveToOverflow
*/
public getMoveToOverflow(): boolean;
/**
* Gets current value of property {@link #getPriority priority}.
*
* Defines OverflowToolbar items priority, Available priorities ate NeverOverflow, High, Low, Disappear and AlwaysOverflow
*
* Default value is High
.
* @returns {sap.m.OverflowToolbarPriority} Value of property priority
*/
public getPriority(): sap.m.OverflowToolbarPriority;
/**
* Gets current value of property {@link #getStayInOverflow stayInOverflow}.
*
* The OverflowToolbar item can or cannot stay in the overflow area
*
* Default value is false
.
* @returns {boolean} Value of property stayInOverflow
*/
public getStayInOverflow(): boolean;
/**
* Sets a new value for property {@link #getCloseOverflowOnInteraction closeOverflowOnInteraction}.
*
* Defines whether the overflow area is automatically closed when interacting with a control in it
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bCloseOverflowOnInteraction - New value for property closeOverflowOnInteraction
* @returns {sap.m.OverflowToolbarLayoutData} Reference to this
in order to allow method chaining
*/
public setCloseOverflowOnInteraction(bCloseOverflowOnInteraction: boolean): sap.m.OverflowToolbarLayoutData;
/**
* Sets a new value for property {@link #getGroup group}.
*
* Defines OverflowToolbar items group number.
* Default value is 0, which means that the control does not belong to any group.
* Elements that belong to a group overflow together. The overall priority of the group is defined by the element with highest priority.
* Elements that belong to a group are not allowed to have AlwaysOverflow or NeverOverflow priority.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iGroup - New value for property group
* @returns {sap.m.OverflowToolbarLayoutData} Reference to this
in order to allow method chaining
*/
public setGroup(iGroup: number): sap.m.OverflowToolbarLayoutData;
/**
* Sets a new value for property {@link #getMoveToOverflow moveToOverflow}.
*
* The OverflowToolbar item can or cannot move to the overflow area
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bMoveToOverflow - New value for property moveToOverflow
* @returns {sap.m.OverflowToolbarLayoutData} Reference to this
in order to allow method chaining
*/
public setMoveToOverflow(bMoveToOverflow: boolean): sap.m.OverflowToolbarLayoutData;
/**
* Sets a new value for property {@link #getPriority priority}.
*
* Defines OverflowToolbar items priority, Available priorities ate NeverOverflow, High, Low, Disappear and AlwaysOverflow
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is High
.
* @param {sap.m.OverflowToolbarPriority} sPriority - New value for property priority
* @returns {sap.m.OverflowToolbarLayoutData} Reference to this
in order to allow method chaining
*/
public setPriority(sPriority: sap.m.OverflowToolbarPriority): sap.m.OverflowToolbarLayoutData;
/**
* Sets a new value for property {@link #getStayInOverflow stayInOverflow}.
*
* The OverflowToolbar item can or cannot stay in the overflow area
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bStayInOverflow - New value for property stayInOverflow
* @returns {sap.m.OverflowToolbarLayoutData} Reference to this
in order to allow method chaining
*/
public setStayInOverflow(bStayInOverflow: boolean): sap.m.OverflowToolbarLayoutData;
}
/**
* Defines the priorities of the controls within sap.m.OverflowToolbar
*/
export enum OverflowToolbarPriority {
/**
* Deprecated - Use sap.m.OverflowToolbarPriority.AlwaysOverflow
instead
*/
Always = "Always",
/**
* AlwaysOverflow priority forces OverflowToolbar items to remain always in the overflow area
*/
AlwaysOverflow = "AlwaysOverflow",
/**
* Disappear priority OverflowToolbar items overflow before the items with higher priority such as Low and High priority items and remain hidden in the overflow area
*/
Disappear = "Disappear",
/**
* High priority OverflowToolbar items overflow after the items with lower priority
*/
High = "High",
/**
* Low priority OverflowToolbar items overflow before the items with higher priority such as High priority items
*/
Low = "Low",
/**
* Deprecated - Use sap.m.OverflowToolbarPriority.NeverOverflow
instead
*/
Never = "Never",
/**
* NeverOverflow priority forces OverflowToolbar items to remain always in the toolbar
*/
NeverOverflow = "NeverOverflow",
}
/**
* Type for columnsItems
aggregation in P13nColumnsPanel
control.
*/
export class P13nColumnsItem extends sap.ui.core.Item {
/**
* Constructor for a new P13nColumnsItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.P13nColumnsItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getColumnKey columnKey}.
*
* This property contains the unique table column key
* @returns {string} Value of property columnKey
*/
public getColumnKey(): string;
/**
* Gets current value of property {@link #getIndex index}.
*
* This property contains the index of a table column
* @returns {number} Value of property index
*/
public getIndex(): number;
/**
* Returns a metadata object for class sap.m.P13nColumnsItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTotal total}.
*
* This property contains the total flag of a table column.
* @returns {boolean} Value of property total
*/
public getTotal(): boolean;
/**
* Gets current value of property {@link #getVisible visible}.
*
* This property decides whether a P13nColumnsItem
is visible
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* This property contains the with of a table column.
* @returns {string} Value of property width
*/
public getWidth(): string;
/**
* Sets a new value for property {@link #getColumnKey columnKey}.
*
* This property contains the unique table column key
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sColumnKey - New value for property columnKey
* @returns {sap.m.P13nColumnsItem} Reference to this
in order to allow method chaining
*/
public setColumnKey(sColumnKey: string): sap.m.P13nColumnsItem;
/**
* Sets a new value for property {@link #getIndex index}.
*
* This property contains the index of a table column
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iIndex - New value for property index
* @returns {sap.m.P13nColumnsItem} Reference to this
in order to allow method chaining
*/
public setIndex(iIndex: number): sap.m.P13nColumnsItem;
/**
* Sets a new value for property {@link #getTotal total}.
*
* This property contains the total flag of a table column.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bTotal - New value for property total
* @returns {sap.m.P13nColumnsItem} Reference to this
in order to allow method chaining
*/
public setTotal(bTotal: boolean): sap.m.P13nColumnsItem;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* This property decides whether a P13nColumnsItem
is visible
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.P13nColumnsItem} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.P13nColumnsItem;
/**
* Sets a new value for property {@link #getWidth width}.
*
* This property contains the with of a table column.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sWidth - New value for property width
* @returns {sap.m.P13nColumnsItem} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: string): sap.m.P13nColumnsItem;
}
/**
* The P13nColumnsPanel
control is used to define column-specific settings for table personalization.
*/
export class P13nColumnsPanel extends sap.m.P13nPanel {
/**
* Constructor for a new P13nColumnsPanel.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some columnsItem to the aggregation {@link #getColumnsItems columnsItems}.
* @param {sap.m.P13nColumnsItem} oColumnsItem - the columnsItem to add; if empty, nothing is inserted
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
public addColumnsItem(oColumnsItem: sap.m.P13nColumnsItem): sap.m.P13nColumnsPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:addColumnsItem addColumnsItem} event of this sap.m.P13nColumnsPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nColumnsPanel
itself.
*
* Event raised when a columnsItem
is added.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nColumnsPanel
itself
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
public attachAddColumnsItem(fnFunction: Function, oListener?: any): sap.m.P13nColumnsPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:addColumnsItem addColumnsItem} event of this sap.m.P13nColumnsPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nColumnsPanel
itself.
*
* Event raised when a columnsItem
is added.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nColumnsPanel
itself
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
public attachAddColumnsItem(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nColumnsPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:changeColumnsItems changeColumnsItems} event of this sap.m.P13nColumnsPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nColumnsPanel
itself.
*
* Event raised if columnsItems
is changed or new one needs to be created in the model.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nColumnsPanel
itself
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
public attachChangeColumnsItems(fnFunction: Function, oListener?: any): sap.m.P13nColumnsPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:changeColumnsItems changeColumnsItems} event of this sap.m.P13nColumnsPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nColumnsPanel
itself.
*
* Event raised if columnsItems
is changed or new one needs to be created in the model.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nColumnsPanel
itself
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
public attachChangeColumnsItems(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nColumnsPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:setData setData} event of this sap.m.P13nColumnsPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nColumnsPanel
itself.
*
* Event raised if setData
is called in model. The event serves the purpose of minimizing such calls since they can
* take up a lot of performance.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nColumnsPanel
itself
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
public attachSetData(fnFunction: Function, oListener?: any): sap.m.P13nColumnsPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:setData setData} event of this sap.m.P13nColumnsPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nColumnsPanel
itself.
*
* Event raised if setData
is called in model. The event serves the purpose of minimizing such calls since they can
* take up a lot of performance.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nColumnsPanel
itself
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
public attachSetData(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nColumnsPanel;
/**
* Binds aggregation {@link #getColumnsItems columnsItems} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
public bindColumnsItems(oBindingInfo: any): sap.m.P13nColumnsPanel;
/**
* Destroys all the columnsItems in the aggregation {@link #getColumnsItems columnsItems}.
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
public destroyColumnsItems(): sap.m.P13nColumnsPanel;
/**
* Detaches event handler fnFunction
from the {@link #event:addColumnsItem addColumnsItem} event of this sap.m.P13nColumnsPanel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
public detachAddColumnsItem(fnFunction: Function, oListener: any): sap.m.P13nColumnsPanel;
/**
* Detaches event handler fnFunction
from the {@link #event:changeColumnsItems changeColumnsItems} event of this sap.m.P13nColumnsPanel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
public detachChangeColumnsItems(fnFunction: Function, oListener: any): sap.m.P13nColumnsPanel;
/**
* Detaches event handler fnFunction
from the {@link #event:setData setData} event of this sap.m.P13nColumnsPanel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
public detachSetData(fnFunction: Function, oListener: any): sap.m.P13nColumnsPanel;
/**
* Creates a new subclass of class sap.m.P13nColumnsPanel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.P13nPanel.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:addColumnsItem addColumnsItem} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
protected fireAddColumnsItem(mParameters?: any): sap.m.P13nColumnsPanel;
/**
* Fires event {@link #event:changeColumnsItems changeColumnsItems} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
protected fireChangeColumnsItems(mParameters?: any): sap.m.P13nColumnsPanel;
/**
* Fires event {@link #event:setData setData} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
protected fireSetData(mParameters?: any): sap.m.P13nColumnsPanel;
/**
* Gets content of aggregation {@link #getColumnsItems columnsItems}.
*
* List of columns that has been changed.
* @returns {sap.m.P13nColumnsItem[]}
*/
public getColumnsItems(): sap.m.P13nColumnsItem[];
/**
* Returns a metadata object for class sap.m.P13nColumnsPanel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Delivers a payload for columnsPanel that can be used at consumer side
* @returns {any} oPayload, which contains useful information
*/
public getOkPayload(): any;
/**
* Delivers a payload for columnsPanel that can be used at consumer side
* @returns {any} oPayload, which contains useful information
*/
public getResetPayload(): any;
/**
* Gets current value of property {@link #getVisibleItemsThreshold visibleItemsThreshold}.
*
* Specifies a threshold of visible items. If the end user makes a lot of columns visible, this might cause performance to slow down.
* When this happens, the user can receive a corresponding warning triggered by the visibleItemsThreshold
property. The
* property needs to be activated and set to the required value by the consuming application to ensure that the warning message is
* shown when the threshold has been exceeded. In the following example the message will be shown if more than 100 visible columns are
* selected:
*
*
* customData>
* core:CustomData key="p13nDialogSettings"
* value='\{"columns":\{"visible": true, "payload": \{"visibleItemsThreshold": 3\}\}\}' />
* /customData>
*
*
* Default value is -1
.
* @returns {number} Value of property visibleItemsThreshold
*/
public getVisibleItemsThreshold(): number;
/**
* Checks for the provided sap.m.P13nColumnsItem
in the aggregation {@link #getColumnsItems columnsItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.P13nColumnsItem} oColumnsItem - The columnsItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfColumnsItem(oColumnsItem: sap.m.P13nColumnsItem): number;
/**
* Inserts a columnsItem into the aggregation {@link #getColumnsItems columnsItems}.
* @param {sap.m.P13nColumnsItem} oColumnsItem - the columnsItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the columnsItem should be inserted at; for a negative value of iIndex
, the columnsItem is inserted at position 0; for a value greater than the current size of the aggregation, the columnsItem is inserted at the last position
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
public insertColumnsItem(oColumnsItem: sap.m.P13nColumnsItem, iIndex: number): sap.m.P13nColumnsPanel;
/**
* This method does a re-initialization of the panel
*/
public reInitialize(): void;
/**
* Removes all the controls from the aggregation {@link #getColumnsItems columnsItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.P13nColumnsItem[]} An array of the removed elements (might be empty)
*/
public removeAllColumnsItems(): sap.m.P13nColumnsItem[];
/**
* Removes a columnsItem from the aggregation {@link #getColumnsItems columnsItems}.
* @param {number|string|sap.m.P13nColumnsItem} vColumnsItem - The columnsItem to remove or its index or id
* @returns {sap.m.P13nColumnsItem} The removed columnsItem or null
*/
public removeColumnsItem(vColumnsItem: number|string|sap.m.P13nColumnsItem): sap.m.P13nColumnsItem;
/**
* Sets a new value for property {@link #getVisibleItemsThreshold visibleItemsThreshold}.
*
* Specifies a threshold of visible items. If the end user makes a lot of columns visible, this might cause performance to slow down.
* When this happens, the user can receive a corresponding warning triggered by the visibleItemsThreshold
property. The
* property needs to be activated and set to the required value by the consuming application to ensure that the warning message is
* shown when the threshold has been exceeded. In the following example the message will be shown if more than 100 visible columns are
* selected:
*
*
* customData>
* core:CustomData key="p13nDialogSettings"
* value='\{"columns":\{"visible": true, "payload": \{"visibleItemsThreshold": 3\}\}\}' />
* /customData>
*
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {number} iVisibleItemsThreshold - New value for property visibleItemsThreshold
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
public setVisibleItemsThreshold(iVisibleItemsThreshold: number): sap.m.P13nColumnsPanel;
/**
* Unbinds aggregation {@link #getColumnsItems columnsItems} from model data.
* @returns {sap.m.P13nColumnsPanel} Reference to this
in order to allow method chaining
*/
public unbindColumnsItems(): sap.m.P13nColumnsPanel;
}
/**
*/
export enum P13nConditionOperation {
/**
*/
Ascending = "Ascending",
/**
*/
Average = "Average",
/**
*/
BT = "BT",
/**
*/
Contains = "Contains",
/**
*/
Descending = "Descending",
/**
*/
Empty = "Empty",
/**
*/
EndsWith = "EndsWith",
/**
*/
EQ = "EQ",
/**
*/
GE = "GE",
/**
*/
GroupAscending = "GroupAscending",
/**
*/
GroupDescending = "GroupDescending",
/**
*/
GT = "GT",
/**
*/
Initial = "Initial",
/**
*/
LE = "LE",
/**
*/
LT = "LT",
/**
*/
Maximum = "Maximum",
/**
*/
Minimum = "Minimum",
/**
*/
NotEmpty = "NotEmpty",
/**
*/
StartsWith = "StartsWith",
/**
*/
Total = "Total",
}
/**
* The ConditionPanel Control will be used to implement the Sorting, Filtering and Grouping panel of the new Personalization dialog.
*/
export class P13nConditionPanel extends sap.ui.core.Control {
/**
* Constructor for a new P13nConditionPanel.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* add a single condition.
* @param {any} oCondition - the new condition of type { "key": "007", "operation": sap.m.P13nConditionOperation.Ascending, "keyField": "keyFieldKey", "value1": "", "value2": ""};
*/
public addCondition(oCondition: any): void;
/**
* add a single KeyField
* @param {any} oKeyField - {key: "CompanyCode", text: "ID"}
*/
public addKeyField(oKeyField: any): void;
/**
* add a single operation
* @param {sap.m.P13nConditionOperation} oOperation
* @param {string} sType - defines the type for which this operations will be used.
*/
public addOperation(oOperation: sap.m.P13nConditionOperation, sType: string): void;
/**
* Attaches event handler fnFunction
to the {@link #event:dataChange dataChange} event of this sap.m.P13nConditionPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nConditionPanel
itself.
*
* Workaround for updating the binding
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nConditionPanel
itself
* @returns {sap.m.P13nConditionPanel} Reference to this
in order to allow method chaining
*/
public attachDataChange(fnFunction: Function, oListener?: any): sap.m.P13nConditionPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:dataChange dataChange} event of this sap.m.P13nConditionPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nConditionPanel
itself.
*
* Workaround for updating the binding
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nConditionPanel
itself
* @returns {sap.m.P13nConditionPanel} Reference to this
in order to allow method chaining
*/
public attachDataChange(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nConditionPanel;
/**
* Detaches event handler fnFunction
from the {@link #event:dataChange dataChange} event of this sap.m.P13nConditionPanel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nConditionPanel} Reference to this
in order to allow method chaining
*/
public detachDataChange(fnFunction: Function, oListener: any): sap.m.P13nConditionPanel;
/**
* Creates a new subclass of class sap.m.P13nConditionPanel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:dataChange dataChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nConditionPanel} Reference to this
in order to allow method chaining
*/
protected fireDataChange(mParameters?: any): sap.m.P13nConditionPanel;
/**
* Gets current value of property {@link #getAlwaysShowAddIcon alwaysShowAddIcon}.
*
* makes the Add icon visible on each condition row. If is set to false the Add is only visible at the end and you can only append a
* new condition.
*
* Default value is true
.
* @returns {boolean} Value of property alwaysShowAddIcon
*/
public getAlwaysShowAddIcon(): boolean;
/**
* Gets current value of property {@link #getAutoAddNewRow autoAddNewRow}.
*
* adds initial a new empty condition row
*
* Default value is false
.
* @returns {boolean} Value of property autoAddNewRow
*/
public getAutoAddNewRow(): boolean;
/**
* Gets current value of property {@link #getAutoReduceKeyFieldItems autoReduceKeyFieldItems}.
*
* KeyField value can only be selected once. When you set the property to true
the ConditionPanel will automatically offers on the
* KeyField drop down only the keyFields which are not used. The default behavior is that in each keyField dropdown all keyfields are
* listed.
*
* Default value is false
.
* @returns {boolean} Value of property autoReduceKeyFieldItems
*/
public getAutoReduceKeyFieldItems(): boolean;
/**
* returns array of all defined conditions.
* @returns {any[]} array of Conditions
*/
public getConditions(): any[];
/**
* Gets current value of property {@link #getContainerQuery containerQuery}.
*
* defines if the mediaQuery or a ContainerResize will be used for layout update.
* When the P13nConditionPanel
is used on a dialog the property should be set to true
!
*
* Default value is false
.
* @returns {boolean} Value of property containerQuery
*/
public getContainerQuery(): boolean;
/**
* Gets current value of property {@link #getDisableFirstRemoveIcon disableFirstRemoveIcon}.
*
* makes the remove icon on the first condition row disabled when only one condition exist.
*
* Default value is false
.
* @returns {boolean} Value of property disableFirstRemoveIcon
*/
public getDisableFirstRemoveIcon(): boolean;
/**
* Gets current value of property {@link #getDisplayFormat displayFormat}.
*
* This represents the displayFormat of the condition Values. With the value "UpperCase" the entered value of the condition will be
* converted to upperCase.
* @returns {string} Value of property displayFormat
*/
public getDisplayFormat(): string;
/**
* Gets current value of property {@link #getExclude exclude}.
*
* exclude options for filter
*
* Default value is false
.
* @returns {boolean} Value of property exclude
*/
public getExclude(): boolean;
/**
* getter for KeyFields array
* @returns {{ key: string, text: string }[]} array of KeyFields [{key: "CompanyCode", text: "ID"}, {key:"CompanyName", text : "Name"}]
*/
public getKeyFields(): { key: string, text: string }[];
/**
* Gets current value of property {@link #getLayoutMode layoutMode}.
*
* can be used to control the layout behavior. Default is "" which will automatically change the layout. With "Desktop", "Table"
* or "Phone" you can set a fixed layout.
* @returns {string} Value of property layoutMode
*/
public getLayoutMode(): string;
/**
* Gets current value of property {@link #getMaxConditions maxConditions}.
*
* defines the max number of conditions on the ConditionPanel
*
* Default value is -1
.
* @returns {string} Value of property maxConditions
*/
public getMaxConditions(): string;
/**
* Returns a metadata object for class sap.m.P13nConditionPanel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* returns the default array of operations
* @param {string} sType - defines the type for which the operations should be returned.
* @returns {sap.m.P13nConditionOperation[]} array of operations
*/
public getOperations(sType: string): sap.m.P13nConditionOperation[];
/**
* Gets current value of property {@link #getShowLabel showLabel}.
*
* show additional labels in the condition
*
* Default value is false
.
* @returns {boolean} Value of property showLabel
*/
public getShowLabel(): boolean;
/**
* Gets current value of property {@link #getUsePrevConditionSetting usePrevConditionSetting}.
*
* new added condition use the settings from the previous condition as default.
*
* Default value is true
.
* @returns {boolean} Value of property usePrevConditionSetting
*/
public getUsePrevConditionSetting(): boolean;
/**
* Gets current value of property {@link #getValidationExecutor validationExecutor}.
*
* Calls the validation listener tbd...
* @returns {any} Value of property validationExecutor
*/
public getValidationExecutor(): any;
/**
* insert a single condition.
* @param {any} oCondition - the new condition of type { "key": "007", "operation": sap.m.P13nConditionOperation.Ascending, "keyField": "keyFieldKey", "value1": "", "value2": ""};
* @param {number} index - of the new condition
*/
public insertCondition(oCondition: any, index: number): void;
/**
* remove all conditions.
*/
public removeAllConditions(): void;
/**
* removes all KeyFields
*/
public removeAllKeyFields(): void;
/**
* remove all operations
* @param {string} sType - defines the type for which all operations should be removed
*/
public removeAllOperations(sType: string): void;
/**
* remove a single condition.
* @param {any} vCondition - is the condition which should be removed. can be either a string with the key of the condition of the condition object itself.
*/
public removeCondition(vCondition: any): void;
/**
* removes all invalid conditions.
*/
public removeInvalidConditions(): void;
/**
* removes all errors/warning states from the value1/2 fields of all conditions.
*/
public removeValidationErrors(): void;
/**
* Sets a new value for property {@link #getAutoAddNewRow autoAddNewRow}.
*
* adds initial a new empty condition row
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bAutoAddNewRow - New value for property autoAddNewRow
* @returns {sap.m.P13nConditionPanel} Reference to this
in order to allow method chaining
*/
public setAutoAddNewRow(bAutoAddNewRow: boolean): sap.m.P13nConditionPanel;
/**
* Sets a new value for property {@link #getAutoReduceKeyFieldItems autoReduceKeyFieldItems}.
*
* KeyField value can only be selected once. When you set the property to true
the ConditionPanel will automatically offers on the
* KeyField drop down only the keyFields which are not used. The default behavior is that in each keyField dropdown all keyfields are
* listed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bAutoReduceKeyFieldItems - New value for property autoReduceKeyFieldItems
* @returns {sap.m.P13nConditionPanel} Reference to this
in order to allow method chaining
*/
public setAutoReduceKeyFieldItems(bAutoReduceKeyFieldItems: boolean): sap.m.P13nConditionPanel;
/**
* This method must be used to assign a list of conditions.
* @param {any[]} aConditions - array of Conditions.
*/
public setConditions(aConditions: any[]): void;
/**
* Sets a new value for property {@link #getDisableFirstRemoveIcon disableFirstRemoveIcon}.
*
* makes the remove icon on the first condition row disabled when only one condition exist.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bDisableFirstRemoveIcon - New value for property disableFirstRemoveIcon
* @returns {sap.m.P13nConditionPanel} Reference to this
in order to allow method chaining
*/
public setDisableFirstRemoveIcon(bDisableFirstRemoveIcon: boolean): sap.m.P13nConditionPanel;
/**
* Sets a new value for property {@link #getDisplayFormat displayFormat}.
*
* This represents the displayFormat of the condition Values. With the value "UpperCase" the entered value of the condition will be
* converted to upperCase.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sDisplayFormat - New value for property displayFormat
* @returns {sap.m.P13nConditionPanel} Reference to this
in order to allow method chaining
*/
public setDisplayFormat(sDisplayFormat: string): sap.m.P13nConditionPanel;
/**
* Sets a new value for property {@link #getExclude exclude}.
*
* exclude options for filter
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bExclude - New value for property exclude
* @returns {sap.m.P13nConditionPanel} Reference to this
in order to allow method chaining
*/
public setExclude(bExclude: boolean): sap.m.P13nConditionPanel;
/**
* This method allows you to specify the KeyFields for the conditions. You can set an array of object with Key and Text properties to define the
* keyfields.
* @param {{ key: string, text: string }[]} aKeyFields - array of KeyFields [{key: "CompanyCode", text: "ID"}, {key:"CompanyName", text : "Name"}]
*/
public setKeyFields(aKeyFields: { key: string, text: string }[]): void;
/**
* Sets a new value for property {@link #getMaxConditions maxConditions}.
*
* defines the max number of conditions on the ConditionPanel
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {string} sMaxConditions - New value for property maxConditions
* @returns {sap.m.P13nConditionPanel} Reference to this
in order to allow method chaining
*/
public setMaxConditions(sMaxConditions: string): sap.m.P13nConditionPanel;
/**
* setter for the supported operations which we show per condition row. This array of "default" operations will only be used when we do not have
* on the keyfield itself some specific operations and a keyfield is of not of type date or numeric.
* @param {sap.m.P13nConditionOperation[]} aOperations - array of operations [sap.m.P13nConditionOperation.BT, sap.m.P13nConditionOperation.EQ]
* @param {string} sType - defines the type for which this operations will be used. is sType
is not defined the operations will be used as default operations.
*/
public setOperations(aOperations: sap.m.P13nConditionOperation[], sType: string): void;
/**
* Sets a new value for property {@link #getShowLabel showLabel}.
*
* show additional labels in the condition
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowLabel - New value for property showLabel
* @returns {sap.m.P13nConditionPanel} Reference to this
in order to allow method chaining
*/
public setShowLabel(bShowLabel: boolean): sap.m.P13nConditionPanel;
/**
* Sets a new value for property {@link #getUsePrevConditionSetting usePrevConditionSetting}.
*
* new added condition use the settings from the previous condition as default.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bUsePrevConditionSetting - New value for property usePrevConditionSetting
* @returns {sap.m.P13nConditionPanel} Reference to this
in order to allow method chaining
*/
public setUsePrevConditionSetting(bUsePrevConditionSetting: boolean): sap.m.P13nConditionPanel;
/**
* Sets a new value for property {@link #getValidationExecutor validationExecutor}.
*
* Calls the validation listener tbd...
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oValidationExecutor - New value for property validationExecutor
* @returns {sap.m.P13nConditionPanel} Reference to this
in order to allow method chaining
*/
public setValidationExecutor(oValidationExecutor: any): sap.m.P13nConditionPanel;
}
/**
* The P13nDialog control provides a dialog that contains one or more panels. On each of the panels, one or more changes with regards to a
* table can be processed. For example, a panel to set a column to invisible, change the order of the columns or a panel to sort or filter
* tables.
*/
export class P13nDialog extends sap.m.Dialog {
/**
* Constructor for a new P13nDialog.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some panel to the aggregation {@link #getPanels panels}.
* @param {sap.m.P13nPanel} oPanel - the panel to add; if empty, nothing is inserted
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public addPanel(oPanel: sap.m.P13nPanel): sap.m.P13nDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.m.P13nDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nDialog
itself.
*
* Event fired if the 'cancel' button in P13nDialog
is clicked.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nDialog
itself
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public attachCancel(fnFunction: Function, oListener?: any): sap.m.P13nDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.m.P13nDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nDialog
itself.
*
* Event fired if the 'cancel' button in P13nDialog
is clicked.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nDialog
itself
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public attachCancel(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:ok ok} event of this sap.m.P13nDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nDialog
itself.
*
* Event fired if the 'ok' button in P13nDialog
is clicked.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nDialog
itself
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public attachOk(fnFunction: Function, oListener?: any): sap.m.P13nDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:ok ok} event of this sap.m.P13nDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nDialog
itself.
*
* Event fired if the 'ok' button in P13nDialog
is clicked.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nDialog
itself
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public attachOk(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:reset reset} event of this sap.m.P13nDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nDialog
itself.
*
* Event fired if the 'reset' button in P13nDialog
is clicked.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nDialog
itself
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public attachReset(fnFunction: Function, oListener?: any): sap.m.P13nDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:reset reset} event of this sap.m.P13nDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nDialog
itself.
*
* Event fired if the 'reset' button in P13nDialog
is clicked.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nDialog
itself
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public attachReset(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nDialog;
/**
* Binds aggregation {@link #getPanels panels} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public bindPanels(oBindingInfo: any): sap.m.P13nDialog;
/**
* Destroys all the panels in the aggregation {@link #getPanels panels}.
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public destroyPanels(): sap.m.P13nDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:cancel cancel} event of this sap.m.P13nDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public detachCancel(fnFunction: Function, oListener: any): sap.m.P13nDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:ok ok} event of this sap.m.P13nDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public detachOk(fnFunction: Function, oListener: any): sap.m.P13nDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:reset reset} event of this sap.m.P13nDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public detachReset(fnFunction: Function, oListener: any): sap.m.P13nDialog;
/**
* Creates a new subclass of class sap.m.P13nDialog with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.Dialog.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:cancel cancel} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
protected fireCancel(mParameters?: any): sap.m.P13nDialog;
/**
* Fires event {@link #event:ok ok} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
protected fireOk(mParameters?: any): sap.m.P13nDialog;
/**
* Fires event {@link #event:reset reset} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
protected fireReset(mParameters?: any): sap.m.P13nDialog;
/**
* Gets current value of property {@link #getInitialVisiblePanelType initialVisiblePanelType}.
*
* This property determines which panel is initially shown when dialog is opened. Due to extensibility reason the type should be
* string
. So it is feasible to add a custom panel without expanding the type.
* @returns {string} Value of property initialVisiblePanelType
*/
public getInitialVisiblePanelType(): string;
/**
* Returns a metadata object for class sap.m.P13nDialog.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getPanels panels}.
*
* The dialog panels displayed in the dialog.
* @returns {sap.m.P13nPanel[]}
*/
public getPanels(): sap.m.P13nPanel[];
/**
* Gets current value of property {@link #getShowReset showReset}.
*
* This property determines whether the 'Restore' button is shown inside the dialog. If this property is set to true, clicking the
* 'Reset' button will trigger the reset
event sending a notification that model data must be reset.
*
* Default value is false
.
* @returns {boolean} Value of property showReset
*/
public getShowReset(): boolean;
/**
* Gets current value of property {@link #getShowResetEnabled showResetEnabled}.
*
* This property determines whether the 'Restore' button is enabled and is taken into account only if showReset
is set
* to true
.
*
* Default value is false
.
* @returns {boolean} Value of property showResetEnabled
*/
public getShowResetEnabled(): boolean;
/**
* Gets current value of property {@link #getValidationExecutor validationExecutor}.
*
* Calls the validation listener once all panel-relevant validation checks have been done. This callback function is called in order
* to perform cross-model validation checks.
* @returns {any} Value of property validationExecutor
*/
public getValidationExecutor(): any;
/**
* Returns visible panel.
* @returns {sap.m.P13nPanel|null} panel
*/
public getVisiblePanel(): sap.m.P13nPanel|null;
/**
* Checks for the provided sap.m.P13nPanel
in the aggregation {@link #getPanels panels}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.P13nPanel} oPanel - The panel whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfPanel(oPanel: sap.m.P13nPanel): number;
/**
* Inserts a panel into the aggregation {@link #getPanels panels}.
* @param {sap.m.P13nPanel} oPanel - the panel to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the panel should be inserted at; for a negative value of iIndex
, the panel is inserted at position 0; for a value greater than the current size of the aggregation, the panel is inserted at the last position
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public insertPanel(oPanel: sap.m.P13nPanel, iIndex: number): sap.m.P13nDialog;
/**
* Removes all the controls from the aggregation {@link #getPanels panels}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.P13nPanel[]} An array of the removed elements (might be empty)
*/
public removeAllPanels(): sap.m.P13nPanel[];
/**
* Removes a panel from the aggregation {@link #getPanels panels}.
* @param {number|string|sap.m.P13nPanel} vPanel - The panel to remove or its index or id
* @returns {sap.m.P13nPanel} The removed panel or null
*/
public removePanel(vPanel: number|string|sap.m.P13nPanel): sap.m.P13nPanel;
/**
* Sets a new value for property {@link #getInitialVisiblePanelType initialVisiblePanelType}.
*
* This property determines which panel is initially shown when dialog is opened. Due to extensibility reason the type should be
* string
. So it is feasible to add a custom panel without expanding the type.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sInitialVisiblePanelType - New value for property initialVisiblePanelType
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public setInitialVisiblePanelType(sInitialVisiblePanelType: string): sap.m.P13nDialog;
/**
* Sets a new value for property {@link #getShowReset showReset}.
*
* This property determines whether the 'Restore' button is shown inside the dialog. If this property is set to true, clicking the
* 'Reset' button will trigger the reset
event sending a notification that model data must be reset.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowReset - New value for property showReset
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public setShowReset(bShowReset: boolean): sap.m.P13nDialog;
/**
* Sets a new value for property {@link #getShowResetEnabled showResetEnabled}.
*
* This property determines whether the 'Restore' button is enabled and is taken into account only if showReset
is set
* to true
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowResetEnabled - New value for property showResetEnabled
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public setShowResetEnabled(bShowResetEnabled: boolean): sap.m.P13nDialog;
/**
* Sets a new value for property {@link #getValidationExecutor validationExecutor}.
*
* Calls the validation listener once all panel-relevant validation checks have been done. This callback function is called in order
* to perform cross-model validation checks.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oValidationExecutor - New value for property validationExecutor
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public setValidationExecutor(oValidationExecutor: any): sap.m.P13nDialog;
/**
* Unbinds aggregation {@link #getPanels panels} from model data.
* @returns {sap.m.P13nDialog} Reference to this
in order to allow method chaining
*/
public unbindPanels(): sap.m.P13nDialog;
}
/**
* Type for columnsItems
aggregation in P13nDimMeasurePanel
control.
*/
export class P13nDimMeasureItem extends sap.ui.core.Item {
/**
* Constructor for a new P13nDimMeasureItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.P13nDimMeasureItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getColumnKey columnKey}.
*
* Specifies the unique chart column key. In this context a column refers to dimensions or measures of a chart.
* @returns {string} Value of property columnKey
*/
public getColumnKey(): string;
/**
* Gets current value of property {@link #getIndex index}.
*
* Specifies the order of visible dimensions or measures of a chart.
*
* Default value is -1
.
* @returns {number} Value of property index
*/
public getIndex(): number;
/**
* Returns a metadata object for class sap.m.P13nDimMeasureItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRole role}.
*
* Specifies the role of dimensions or measures. The role determines how dimensions and measures influence the chart.
* @returns {string} Value of property role
*/
public getRole(): string;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Specifies the visibility of dimensions or measures.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Sets a new value for property {@link #getColumnKey columnKey}.
*
* Specifies the unique chart column key. In this context a column refers to dimensions or measures of a chart.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sColumnKey - New value for property columnKey
* @returns {sap.m.P13nDimMeasureItem} Reference to this
in order to allow method chaining
*/
public setColumnKey(sColumnKey: string): sap.m.P13nDimMeasureItem;
/**
* Sets a new value for property {@link #getIndex index}.
*
* Specifies the order of visible dimensions or measures of a chart.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {number} iIndex - New value for property index
* @returns {sap.m.P13nDimMeasureItem} Reference to this
in order to allow method chaining
*/
public setIndex(iIndex: number): sap.m.P13nDimMeasureItem;
/**
* Sets a new value for property {@link #getRole role}.
*
* Specifies the role of dimensions or measures. The role determines how dimensions and measures influence the chart.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sRole - New value for property role
* @returns {sap.m.P13nDimMeasureItem} Reference to this
in order to allow method chaining
*/
public setRole(sRole: string): sap.m.P13nDimMeasureItem;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Specifies the visibility of dimensions or measures.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.P13nDimMeasureItem} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.P13nDimMeasureItem;
}
/**
* The P13nDimMeasurePanel control is used to define chart-specific settings like chart type, the visibility, the order and roles of
* dimensions and measures for table personalization.
*/
export class P13nDimMeasurePanel extends sap.m.P13nPanel {
/**
* Constructor for a new P13nDimMeasurePanel.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some availableChartType to the aggregation {@link #getAvailableChartTypes availableChartTypes}.
* @param {sap.ui.core.Item} oAvailableChartType - the availableChartType to add; if empty, nothing is inserted
* @returns {sap.m.P13nDimMeasurePanel} Reference to this
in order to allow method chaining
*/
public addAvailableChartType(oAvailableChartType: sap.ui.core.Item): sap.m.P13nDimMeasurePanel;
/**
* Adds some dimMeasureItem to the aggregation {@link #getDimMeasureItems dimMeasureItems}.
* @param {sap.m.P13nDimMeasureItem} oDimMeasureItem - the dimMeasureItem to add; if empty, nothing is inserted
* @returns {sap.m.P13nDimMeasurePanel} Reference to this
in order to allow method chaining
*/
public addDimMeasureItem(oDimMeasureItem: sap.m.P13nDimMeasureItem): sap.m.P13nDimMeasurePanel;
/**
* Binds aggregation {@link #getDimMeasureItems dimMeasureItems} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.P13nDimMeasurePanel} Reference to this
in order to allow method chaining
*/
public bindDimMeasureItems(oBindingInfo: any): sap.m.P13nDimMeasurePanel;
/**
* Destroys all the availableChartTypes in the aggregation {@link #getAvailableChartTypes availableChartTypes}.
* @returns {sap.m.P13nDimMeasurePanel} Reference to this
in order to allow method chaining
*/
public destroyAvailableChartTypes(): sap.m.P13nDimMeasurePanel;
/**
* Destroys all the dimMeasureItems in the aggregation {@link #getDimMeasureItems dimMeasureItems}.
* @returns {sap.m.P13nDimMeasurePanel} Reference to this
in order to allow method chaining
*/
public destroyDimMeasureItems(): sap.m.P13nDimMeasurePanel;
/**
* Creates a new subclass of class sap.m.P13nDimMeasurePanel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.P13nPanel.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getAvailableChartTypes availableChartTypes}.
*
* Specifies available chart types.
* @returns {sap.ui.core.Item[]}
*/
public getAvailableChartTypes(): sap.ui.core.Item[];
/**
* Gets current value of property {@link #getChartTypeKey chartTypeKey}.
*
* Specifies a chart type key.
*
* Default value is
.
* @returns {string} Value of property chartTypeKey
*/
public getChartTypeKey(): string;
/**
* Gets content of aggregation {@link #getDimMeasureItems dimMeasureItems}.
*
* List of columns that has been changed.
* @returns {sap.m.P13nDimMeasureItem[]}
*/
public getDimMeasureItems(): sap.m.P13nDimMeasureItem[];
/**
* Returns a metadata object for class sap.m.P13nDimMeasurePanel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.Item
in the aggregation {@link #getAvailableChartTypes availableChartTypes}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Item} oAvailableChartType - The availableChartType whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAvailableChartType(oAvailableChartType: sap.ui.core.Item): number;
/**
* Checks for the provided sap.m.P13nDimMeasureItem
in the aggregation {@link #getDimMeasureItems dimMeasureItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.P13nDimMeasureItem} oDimMeasureItem - The dimMeasureItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfDimMeasureItem(oDimMeasureItem: sap.m.P13nDimMeasureItem): number;
/**
* Inserts a availableChartType into the aggregation {@link #getAvailableChartTypes availableChartTypes}.
* @param {sap.ui.core.Item} oAvailableChartType - the availableChartType to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the availableChartType should be inserted at; for a negative value of iIndex
, the availableChartType is inserted at position 0; for a value greater than the current size of the aggregation, the availableChartType is inserted at the last position
* @returns {sap.m.P13nDimMeasurePanel} Reference to this
in order to allow method chaining
*/
public insertAvailableChartType(oAvailableChartType: sap.ui.core.Item, iIndex: number): sap.m.P13nDimMeasurePanel;
/**
* Inserts a dimMeasureItem into the aggregation {@link #getDimMeasureItems dimMeasureItems}.
* @param {sap.m.P13nDimMeasureItem} oDimMeasureItem - the dimMeasureItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the dimMeasureItem should be inserted at; for a negative value of iIndex
, the dimMeasureItem is inserted at position 0; for a value greater than the current size of the aggregation, the dimMeasureItem is inserted at the last position
* @returns {sap.m.P13nDimMeasurePanel} Reference to this
in order to allow method chaining
*/
public insertDimMeasureItem(oDimMeasureItem: sap.m.P13nDimMeasureItem, iIndex: number): sap.m.P13nDimMeasurePanel;
/**
* Removes all the controls from the aggregation {@link #getAvailableChartTypes availableChartTypes}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Item[]} An array of the removed elements (might be empty)
*/
public removeAllAvailableChartTypes(): sap.ui.core.Item[];
/**
* Removes all the controls from the aggregation {@link #getDimMeasureItems dimMeasureItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.P13nDimMeasureItem[]} An array of the removed elements (might be empty)
*/
public removeAllDimMeasureItems(): sap.m.P13nDimMeasureItem[];
/**
* Removes a availableChartType from the aggregation {@link #getAvailableChartTypes availableChartTypes}.
* @param {number|string|sap.ui.core.Item} vAvailableChartType - The availableChartType to remove or its index or id
* @returns {sap.ui.core.Item} The removed availableChartType or null
*/
public removeAvailableChartType(vAvailableChartType: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Removes a dimMeasureItem from the aggregation {@link #getDimMeasureItems dimMeasureItems}.
* @param {number|string|sap.m.P13nDimMeasureItem} vDimMeasureItem - The dimMeasureItem to remove or its index or id
* @returns {sap.m.P13nDimMeasureItem} The removed dimMeasureItem or null
*/
public removeDimMeasureItem(vDimMeasureItem: number|string|sap.m.P13nDimMeasureItem): sap.m.P13nDimMeasureItem;
/**
* Sets a new value for property {@link #getChartTypeKey chartTypeKey}.
*
* Specifies a chart type key.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sChartTypeKey - New value for property chartTypeKey
* @returns {sap.m.P13nDimMeasurePanel} Reference to this
in order to allow method chaining
*/
public setChartTypeKey(sChartTypeKey: string): sap.m.P13nDimMeasurePanel;
/**
* Unbinds aggregation {@link #getDimMeasureItems dimMeasureItems} from model data.
* @returns {sap.m.P13nDimMeasurePanel} Reference to this
in order to allow method chaining
*/
public unbindDimMeasureItems(): sap.m.P13nDimMeasurePanel;
}
/**
* Type for filterItems
aggregation in P13nFilterPanel control.
*/
export class P13nFilterItem extends sap.ui.core.Item {
/**
* Constructor for a new P13nFilterItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.P13nFilterItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getColumnKey columnKey}.
*
* key of the column
* @returns {string} Value of property columnKey
*/
public getColumnKey(): string;
/**
* Gets current value of property {@link #getExclude exclude}.
*
* defines if the filter is an include or exclude filter item
*
* Default value is false
.
* @returns {boolean} Value of property exclude
*/
public getExclude(): boolean;
/**
* Returns a metadata object for class sap.m.P13nFilterItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getOperation operation}.
*
* sap.m.P13nConditionOperation
* @returns {string} Value of property operation
*/
public getOperation(): string;
/**
* Gets current value of property {@link #getValue1 value1}.
*
* value of the filter
* @returns {string} Value of property value1
*/
public getValue1(): string;
/**
* Gets current value of property {@link #getValue2 value2}.
*
* to value of the between filter
* @returns {string} Value of property value2
*/
public getValue2(): string;
/**
* Sets a new value for property {@link #getColumnKey columnKey}.
*
* key of the column
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sColumnKey - New value for property columnKey
* @returns {sap.m.P13nFilterItem} Reference to this
in order to allow method chaining
*/
public setColumnKey(sColumnKey: string): sap.m.P13nFilterItem;
/**
* Sets a new value for property {@link #getExclude exclude}.
*
* defines if the filter is an include or exclude filter item
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bExclude - New value for property exclude
* @returns {sap.m.P13nFilterItem} Reference to this
in order to allow method chaining
*/
public setExclude(bExclude: boolean): sap.m.P13nFilterItem;
/**
* Sets a new value for property {@link #getOperation operation}.
*
* sap.m.P13nConditionOperation
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sOperation - New value for property operation
* @returns {sap.m.P13nFilterItem} Reference to this
in order to allow method chaining
*/
public setOperation(sOperation: string): sap.m.P13nFilterItem;
/**
* Sets a new value for property {@link #getValue1 value1}.
*
* value of the filter
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sValue1 - New value for property value1
* @returns {sap.m.P13nFilterItem} Reference to this
in order to allow method chaining
*/
public setValue1(sValue1: string): sap.m.P13nFilterItem;
/**
* Sets a new value for property {@link #getValue2 value2}.
*
* to value of the between filter
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sValue2 - New value for property value2
* @returns {sap.m.P13nFilterItem} Reference to this
in order to allow method chaining
*/
public setValue2(sValue2: string): sap.m.P13nFilterItem;
}
/**
* The P13nFilterPanel control is used to define filter-specific settings for table personalization.
*/
export class P13nFilterPanel extends sap.m.P13nPanel {
/**
* Constructor for a new P13nFilterPanel.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some filterItem to the aggregation {@link #getFilterItems filterItems}.
* @param {sap.m.P13nFilterItem} oFilterItem - the filterItem to add; if empty, nothing is inserted
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public addFilterItem(oFilterItem: sap.m.P13nFilterItem): sap.m.P13nFilterPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:addFilterItem addFilterItem} event of this sap.m.P13nFilterPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nFilterPanel
itself.
*
* Event raised if a filter item has been added.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nFilterPanel
itself
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public attachAddFilterItem(fnFunction: Function, oListener?: any): sap.m.P13nFilterPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:addFilterItem addFilterItem} event of this sap.m.P13nFilterPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nFilterPanel
itself.
*
* Event raised if a filter item has been added.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nFilterPanel
itself
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public attachAddFilterItem(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nFilterPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:removeFilterItem removeFilterItem} event of this sap.m.P13nFilterPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nFilterPanel
itself.
*
* Event raised if a filter item has been removed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nFilterPanel
itself
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public attachRemoveFilterItem(fnFunction: Function, oListener?: any): sap.m.P13nFilterPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:removeFilterItem removeFilterItem} event of this sap.m.P13nFilterPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nFilterPanel
itself.
*
* Event raised if a filter item has been removed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nFilterPanel
itself
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public attachRemoveFilterItem(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nFilterPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:updateFilterItem updateFilterItem} event of this sap.m.P13nFilterPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nFilterPanel
itself.
*
* Event raised if a filter item has been updated.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nFilterPanel
itself
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public attachUpdateFilterItem(fnFunction: Function, oListener?: any): sap.m.P13nFilterPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:updateFilterItem updateFilterItem} event of this sap.m.P13nFilterPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nFilterPanel
itself.
*
* Event raised if a filter item has been updated.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nFilterPanel
itself
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public attachUpdateFilterItem(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nFilterPanel;
/**
* Binds aggregation {@link #getFilterItems filterItems} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public bindFilterItems(oBindingInfo: any): sap.m.P13nFilterPanel;
/**
* Destroys all the filterItems in the aggregation {@link #getFilterItems filterItems}.
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public destroyFilterItems(): sap.m.P13nFilterPanel;
/**
* Detaches event handler fnFunction
from the {@link #event:addFilterItem addFilterItem} event of this sap.m.P13nFilterPanel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public detachAddFilterItem(fnFunction: Function, oListener: any): sap.m.P13nFilterPanel;
/**
* Detaches event handler fnFunction
from the {@link #event:removeFilterItem removeFilterItem} event of this sap.m.P13nFilterPanel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public detachRemoveFilterItem(fnFunction: Function, oListener: any): sap.m.P13nFilterPanel;
/**
* Detaches event handler fnFunction
from the {@link #event:updateFilterItem updateFilterItem} event of this sap.m.P13nFilterPanel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public detachUpdateFilterItem(fnFunction: Function, oListener: any): sap.m.P13nFilterPanel;
/**
* Creates a new subclass of class sap.m.P13nFilterPanel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.P13nPanel.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:addFilterItem addFilterItem} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
protected fireAddFilterItem(mParameters?: any): sap.m.P13nFilterPanel;
/**
* Fires event {@link #event:removeFilterItem removeFilterItem} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
protected fireRemoveFilterItem(mParameters?: any): sap.m.P13nFilterPanel;
/**
* Fires event {@link #event:updateFilterItem updateFilterItem} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
protected fireUpdateFilterItem(mParameters?: any): sap.m.P13nFilterPanel;
/**
* Returns the array of conditions.
* @returns {any}
*/
public getConditions(): any;
/**
* Gets current value of property {@link #getContainerQuery containerQuery}.
*
* Defines if the mediaQuery
or a ContainerResize
is used for layout update. If the
* ConditionPanel
is used in a dialog, the property must be set to true
.
*
* Default value is false
.
* @returns {boolean} Value of property containerQuery
*/
public getContainerQuery(): boolean;
/**
* Getter for the exclude operations.
* @param {string} the - type for which the operations are defined
* @returns {sap.m.P13nConditionOperation[]} array of operations [sap.m.P13nConditionOperation.BT
, sap.m.P13nConditionOperation.EQ
]
*/
public getExcludeOperations(the: string): sap.m.P13nConditionOperation[];
/**
* Gets content of aggregation {@link #getFilterItems filterItems}.
*
* Defines filter items.
* @returns {sap.m.P13nFilterItem[]}
*/
public getFilterItems(): sap.m.P13nFilterItem[];
/**
* Getter for the include operations.
* @param {string} the - type for which the operations are defined
* @returns {sap.m.P13nConditionOperation} array of operations [sap.m.P13nConditionOperation.BT
, sap.m.P13nConditionOperation.EQ
]
*/
public getIncludeOperations(the: string): sap.m.P13nConditionOperation;
/**
* Gets current value of property {@link #getLayoutMode layoutMode}.
*
* Can be used to control the layout behavior. Default is "" which will automatically change the layout. With "Desktop", "Table"
* or"Phone" you can set a fixed layout.
* @returns {string} Value of property layoutMode
*/
public getLayoutMode(): string;
/**
* Gets current value of property {@link #getMaxExcludes maxExcludes}.
*
* Defines the maximum number of exclude filters.
*
* Default value is -1
.
* @returns {string} Value of property maxExcludes
*/
public getMaxExcludes(): string;
/**
* Gets current value of property {@link #getMaxIncludes maxIncludes}.
*
* Defines the maximum number of include filters.
*
* Default value is -1
.
* @returns {string} Value of property maxIncludes
*/
public getMaxIncludes(): string;
/**
* Returns a metadata object for class sap.m.P13nFilterPanel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.m.P13nFilterItem
in the aggregation {@link #getFilterItems filterItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.P13nFilterItem} oFilterItem - The filterItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfFilterItem(oFilterItem: sap.m.P13nFilterItem): number;
/**
* Inserts a filterItem into the aggregation {@link #getFilterItems filterItems}.
* @param {sap.m.P13nFilterItem} oFilterItem - the filterItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the filterItem should be inserted at; for a negative value of iIndex
, the filterItem is inserted at position 0; for a value greater than the current size of the aggregation, the filterItem is inserted at the last position
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public insertFilterItem(oFilterItem: sap.m.P13nFilterItem, iIndex: number): sap.m.P13nFilterPanel;
/**
* Removes all the controls from the aggregation {@link #getFilterItems filterItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.P13nFilterItem[]} An array of the removed elements (might be empty)
*/
public removeAllFilterItems(): sap.m.P13nFilterItem[];
/**
* Removes a filterItem from the aggregation {@link #getFilterItems filterItems}.
* @param {number|string|sap.m.P13nFilterItem} vFilterItem - The filterItem to remove or its index or id
* @returns {sap.m.P13nFilterItem} The removed filterItem or null
*/
public removeFilterItem(vFilterItem: number|string|sap.m.P13nFilterItem): sap.m.P13nFilterItem;
/**
* Removes all invalid conditions.
*/
public removeInvalidConditions(): void;
/**
* Removes all errors and warnings states from of all filter conditions.
*/
public removeValidationErrors(): void;
/**
* Sets the array of conditions.
* @param {any[]} aConditions - the complete list of conditions
* @returns {sap.m.P13nFilterPanel} this for chaining
*/
public setConditions(aConditions: any[]): sap.m.P13nFilterPanel;
/**
* Sets a new value for property {@link #getContainerQuery containerQuery}.
*
* Defines if the mediaQuery
or a ContainerResize
is used for layout update. If the
* ConditionPanel
is used in a dialog, the property must be set to true
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bContainerQuery - New value for property containerQuery
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public setContainerQuery(bContainerQuery: boolean): sap.m.P13nFilterPanel;
/**
* Setter for the supported exclude operations array.
* @param {sap.m.P13nConditionOperation[]} array - of operations [sap.m.P13nConditionOperation.BT
, sap.m.P13nConditionOperation.EQ
]
* @param {string} the - type for which the operations are defined
*/
public setExcludeOperations(array: sap.m.P13nConditionOperation[], the: string): void;
/**
* Setter for the supported Include operations array.
* @param {sap.m.P13nConditionOperation[]} array - of operations [sap.m.P13nConditionOperation.BT
, sap.m.P13nConditionOperation.EQ
]
* @param {string} the - type for which the operations are defined
*/
public setIncludeOperations(array: sap.m.P13nConditionOperation[], the: string): void;
/**
* Sets a new value for property {@link #getLayoutMode layoutMode}.
*
* Can be used to control the layout behavior. Default is "" which will automatically change the layout. With "Desktop", "Table"
* or"Phone" you can set a fixed layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sLayoutMode - New value for property layoutMode
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public setLayoutMode(sLayoutMode: string): sap.m.P13nFilterPanel;
/**
* Sets a new value for property {@link #getMaxExcludes maxExcludes}.
*
* Defines the maximum number of exclude filters.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {string} sMaxExcludes - New value for property maxExcludes
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public setMaxExcludes(sMaxExcludes: string): sap.m.P13nFilterPanel;
/**
* Sets a new value for property {@link #getMaxIncludes maxIncludes}.
*
* Defines the maximum number of include filters.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {string} sMaxIncludes - New value for property maxIncludes
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public setMaxIncludes(sMaxIncludes: string): sap.m.P13nFilterPanel;
/**
* Unbinds aggregation {@link #getFilterItems filterItems} from model data.
* @returns {sap.m.P13nFilterPanel} Reference to this
in order to allow method chaining
*/
public unbindFilterItems(): sap.m.P13nFilterPanel;
/**
* Checks if the entered and modified conditions are correct, marks invalid fields in yellow (warning).
* @returns {boolean} True
if all conditions are valid, false
otherwise.
*/
public validateConditions(): boolean;
}
/**
* Type for groupItems
aggregation in P13nGroupPanel control.
*/
export class P13nGroupItem extends sap.ui.core.Item {
/**
* Constructor for a new P13nGroupItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.P13nGroupItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getColumnKey columnKey}.
*
* key of the column
* @returns {string} Value of property columnKey
*/
public getColumnKey(): string;
/**
* Returns a metadata object for class sap.m.P13nGroupItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getOperation operation}.
*
* sap.m.P13nConditionOperation
* @returns {string} Value of property operation
*/
public getOperation(): string;
/**
* Gets current value of property {@link #getShowIfGrouped showIfGrouped}.
*
* make the grouped column as normalcolumn visible
*
* Default value is false
.
* @returns {boolean} Value of property showIfGrouped
*/
public getShowIfGrouped(): boolean;
/**
* Sets a new value for property {@link #getColumnKey columnKey}.
*
* key of the column
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sColumnKey - New value for property columnKey
* @returns {sap.m.P13nGroupItem} Reference to this
in order to allow method chaining
*/
public setColumnKey(sColumnKey: string): sap.m.P13nGroupItem;
/**
* Sets a new value for property {@link #getOperation operation}.
*
* sap.m.P13nConditionOperation
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sOperation - New value for property operation
* @returns {sap.m.P13nGroupItem} Reference to this
in order to allow method chaining
*/
public setOperation(sOperation: string): sap.m.P13nGroupItem;
/**
* Sets a new value for property {@link #getShowIfGrouped showIfGrouped}.
*
* make the grouped column as normalcolumn visible
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowIfGrouped - New value for property showIfGrouped
* @returns {sap.m.P13nGroupItem} Reference to this
in order to allow method chaining
*/
public setShowIfGrouped(bShowIfGrouped: boolean): sap.m.P13nGroupItem;
}
/**
* The P13nGroupPanel control is used to define group-specific settings for table personalization.
*/
export class P13nGroupPanel extends sap.m.P13nPanel {
/**
* Constructor for a new P13nGroupPanel.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some groupItem to the aggregation {@link #getGroupItems groupItems}.
* @param {sap.m.P13nGroupItem} oGroupItem - the groupItem to add; if empty, nothing is inserted
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public addGroupItem(oGroupItem: sap.m.P13nGroupItem): sap.m.P13nGroupPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:addGroupItem addGroupItem} event of this sap.m.P13nGroupPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nGroupPanel
itself.
*
* Event raised if a GroupItem
has been added.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nGroupPanel
itself
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public attachAddGroupItem(fnFunction: Function, oListener?: any): sap.m.P13nGroupPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:addGroupItem addGroupItem} event of this sap.m.P13nGroupPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nGroupPanel
itself.
*
* Event raised if a GroupItem
has been added.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nGroupPanel
itself
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public attachAddGroupItem(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nGroupPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:removeGroupItem removeGroupItem} event of this sap.m.P13nGroupPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nGroupPanel
itself.
*
* Event raised if a GroupItem
has been removed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nGroupPanel
itself
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public attachRemoveGroupItem(fnFunction: Function, oListener?: any): sap.m.P13nGroupPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:removeGroupItem removeGroupItem} event of this sap.m.P13nGroupPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nGroupPanel
itself.
*
* Event raised if a GroupItem
has been removed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nGroupPanel
itself
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public attachRemoveGroupItem(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nGroupPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:updateGroupItem updateGroupItem} event of this sap.m.P13nGroupPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nGroupPanel
itself.
*
* Event raised if a GroupItem
has been updated.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nGroupPanel
itself
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public attachUpdateGroupItem(fnFunction: Function, oListener?: any): sap.m.P13nGroupPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:updateGroupItem updateGroupItem} event of this sap.m.P13nGroupPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nGroupPanel
itself.
*
* Event raised if a GroupItem
has been updated.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nGroupPanel
itself
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public attachUpdateGroupItem(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nGroupPanel;
/**
* Binds aggregation {@link #getGroupItems groupItems} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public bindGroupItems(oBindingInfo: any): sap.m.P13nGroupPanel;
/**
* Destroys all the groupItems in the aggregation {@link #getGroupItems groupItems}.
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public destroyGroupItems(): sap.m.P13nGroupPanel;
/**
* Detaches event handler fnFunction
from the {@link #event:addGroupItem addGroupItem} event of this sap.m.P13nGroupPanel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public detachAddGroupItem(fnFunction: Function, oListener: any): sap.m.P13nGroupPanel;
/**
* Detaches event handler fnFunction
from the {@link #event:removeGroupItem removeGroupItem} event of this sap.m.P13nGroupPanel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public detachRemoveGroupItem(fnFunction: Function, oListener: any): sap.m.P13nGroupPanel;
/**
* Detaches event handler fnFunction
from the {@link #event:updateGroupItem updateGroupItem} event of this sap.m.P13nGroupPanel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public detachUpdateGroupItem(fnFunction: Function, oListener: any): sap.m.P13nGroupPanel;
/**
* Creates a new subclass of class sap.m.P13nGroupPanel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.P13nPanel.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:addGroupItem addGroupItem} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
protected fireAddGroupItem(mParameters?: any): sap.m.P13nGroupPanel;
/**
* Fires event {@link #event:removeGroupItem removeGroupItem} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
protected fireRemoveGroupItem(mParameters?: any): sap.m.P13nGroupPanel;
/**
* Fires event {@link #event:updateGroupItem updateGroupItem} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
protected fireUpdateGroupItem(mParameters?: any): sap.m.P13nGroupPanel;
/**
* Gets current value of property {@link #getContainerQuery containerQuery}.
*
* Defines if mediaQuery
or ContainerResize
is used for a layout update. If ConditionPanel
* is used in a dialog, the property must be set to true.
*
* Default value is false
.
* @returns {boolean} Value of property containerQuery
*/
public getContainerQuery(): boolean;
/**
* Gets content of aggregation {@link #getGroupItems groupItems}.
*
* Defined group items.
* @returns {sap.m.P13nGroupItem[]}
*/
public getGroupItems(): sap.m.P13nGroupItem[];
/**
* Gets current value of property {@link #getLayoutMode layoutMode}.
*
* Can be used to control the layout behavior. Default is "" which will automatically change the layout. With "Desktop", "Table"
* or "Phone" you can set a fixed layout.
* @returns {string} Value of property layoutMode
*/
public getLayoutMode(): string;
/**
* Gets current value of property {@link #getMaxGroups maxGroups}.
*
* Defines the maximum number of groups.
*
* Default value is -1
.
* @returns {string} Value of property maxGroups
*/
public getMaxGroups(): string;
/**
* Returns a metadata object for class sap.m.P13nGroupPanel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.m.P13nGroupItem
in the aggregation {@link #getGroupItems groupItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.P13nGroupItem} oGroupItem - The groupItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfGroupItem(oGroupItem: sap.m.P13nGroupItem): number;
/**
* Inserts a groupItem into the aggregation {@link #getGroupItems groupItems}.
* @param {sap.m.P13nGroupItem} oGroupItem - the groupItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the groupItem should be inserted at; for a negative value of iIndex
, the groupItem is inserted at position 0; for a value greater than the current size of the aggregation, the groupItem is inserted at the last position
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public insertGroupItem(oGroupItem: sap.m.P13nGroupItem, iIndex: number): sap.m.P13nGroupPanel;
/**
* Removes all the controls from the aggregation {@link #getGroupItems groupItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.P13nGroupItem[]} An array of the removed elements (might be empty)
*/
public removeAllGroupItems(): sap.m.P13nGroupItem[];
/**
* Removes a groupItem from the aggregation {@link #getGroupItems groupItems}.
* @param {number|string|sap.m.P13nGroupItem} vGroupItem - The groupItem to remove or its index or id
* @returns {sap.m.P13nGroupItem} The removed groupItem or null
*/
public removeGroupItem(vGroupItem: number|string|sap.m.P13nGroupItem): sap.m.P13nGroupItem;
/**
* Removes all invalid group conditions.
*/
public removeInvalidConditions(): void;
/**
* Removes all errors/warning states from of all group conditions.
*/
public removeValidationErrors(): void;
/**
* Sets a new value for property {@link #getContainerQuery containerQuery}.
*
* Defines if mediaQuery
or ContainerResize
is used for a layout update. If ConditionPanel
* is used in a dialog, the property must be set to true.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bContainerQuery - New value for property containerQuery
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public setContainerQuery(bContainerQuery: boolean): sap.m.P13nGroupPanel;
/**
* Sets a new value for property {@link #getLayoutMode layoutMode}.
*
* Can be used to control the layout behavior. Default is "" which will automatically change the layout. With "Desktop", "Table"
* or "Phone" you can set a fixed layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sLayoutMode - New value for property layoutMode
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public setLayoutMode(sLayoutMode: string): sap.m.P13nGroupPanel;
/**
* Sets a new value for property {@link #getMaxGroups maxGroups}.
*
* Defines the maximum number of groups.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {string} sMaxGroups - New value for property maxGroups
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public setMaxGroups(sMaxGroups: string): sap.m.P13nGroupPanel;
/**
* Setter for the supported operations array.
* @param {any[]} aOperations - array of operations [sap.m.P13nConditionOperation.BT, sap.m.P13nConditionOperation.EQ]
*/
public setOperations(aOperations: any[]): void;
/**
* Unbinds aggregation {@link #getGroupItems groupItems} from model data.
* @returns {sap.m.P13nGroupPanel} Reference to this
in order to allow method chaining
*/
public unbindGroupItems(): sap.m.P13nGroupPanel;
/**
* Checks if the entered or modified conditions are correct, marks invalid fields yellow (Warning) and opens a popup message dialog to let the
* user know that some values are not correct or missing.
* @returns {boolean} True
if all conditions are valid, false
otherwise.
*/
public validateConditions(): boolean;
}
/**
* Base type for items
aggregation in P13nPanel
control.
*/
export class P13nItem extends sap.ui.core.Item {
/**
* Constructor for a new P13nItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.P13nItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAggregationRole aggregationRole}.
*
* Defines aggregation role
* @returns {string} Value of property aggregationRole
*/
public getAggregationRole(): string;
/**
* Gets current value of property {@link #getColumnKey columnKey}.
*
* Can be used as input for subsequent actions.
* @returns {string} Value of property columnKey
*/
public getColumnKey(): string;
/**
* Gets current value of property {@link #getHref href}.
*
* Defines href of a link.
* @returns {string} Value of property href
*/
public getHref(): string;
/**
* Gets current value of property {@link #getIsDefault isDefault}.
*
* the column with isDefault==true will be used as the selected column item on the conditionPanel
*
* Default value is false
.
* @returns {boolean} Value of property isDefault
*/
public getIsDefault(): boolean;
/**
* Gets current value of property {@link #getMaxLength maxLength}.
*
* specifies the number of characters which can be entered in the value fields of the condition panel
* @returns {string} Value of property maxLength
*/
public getMaxLength(): string;
/**
* Returns a metadata object for class sap.m.P13nItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPrecision precision}.
*
* if type==numeric the precision will be used to format the entered value (maxIntegerDigits of the used Formatter)
* @returns {string} Value of property precision
*/
public getPrecision(): string;
/**
* Gets current value of property {@link #getPress press}.
*
* Defines press handler of a link.
* @returns {any} Value of property press
*/
public getPress(): any;
/**
* Gets current value of property {@link #getRole role}.
*
* Defines role. The role is reflected in the manner how the dimension will influence the chart layout.
* @returns {string} Value of property role
*/
public getRole(): string;
/**
* Gets current value of property {@link #getScale scale}.
*
* if type==numeric the scale will be used to format the entered value (maxFractionDigits of the used Formatter)
* @returns {string} Value of property scale
*/
public getScale(): string;
/**
* Gets current value of property {@link #getTarget target}.
*
* Defines target of a link.
* @returns {string} Value of property target
*/
public getTarget(): string;
/**
* Gets current value of property {@link #getText text}.
*
* The text to be displayed for the item.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getType type}.
*
* data type of the column (text, numeric or date is supported)
*
* Default value is text
.
* @returns {string} Value of property type
*/
public getType(): string;
/**
* Gets current value of property {@link #getValues values}.
*
* the array of values for type bool. e.g. ["", "Off", "On"]. The first entry can be empty (used to blank the value field). Next value
* represent the false value, last entry the true value.
* @returns {string[]} Value of property values
*/
public getValues(): string[];
/**
* Gets current value of property {@link #getVisible visible}.
*
* Defines visibility of column
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines column width
* @returns {string} Value of property width
*/
public getWidth(): string;
/**
* Sets a new value for property {@link #getAggregationRole aggregationRole}.
*
* Defines aggregation role
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAggregationRole - New value for property aggregationRole
* @returns {sap.m.P13nItem} Reference to this
in order to allow method chaining
*/
public setAggregationRole(sAggregationRole: string): sap.m.P13nItem;
/**
* Sets a new value for property {@link #getColumnKey columnKey}.
*
* Can be used as input for subsequent actions.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sColumnKey - New value for property columnKey
* @returns {sap.m.P13nItem} Reference to this
in order to allow method chaining
*/
public setColumnKey(sColumnKey: string): sap.m.P13nItem;
/**
* Sets a new value for property {@link #getHref href}.
*
* Defines href of a link.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sHref - New value for property href
* @returns {sap.m.P13nItem} Reference to this
in order to allow method chaining
*/
public setHref(sHref: string): sap.m.P13nItem;
/**
* Sets a new value for property {@link #getIsDefault isDefault}.
*
* the column with isDefault==true will be used as the selected column item on the conditionPanel
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bIsDefault - New value for property isDefault
* @returns {sap.m.P13nItem} Reference to this
in order to allow method chaining
*/
public setIsDefault(bIsDefault: boolean): sap.m.P13nItem;
/**
* Sets a new value for property {@link #getMaxLength maxLength}.
*
* specifies the number of characters which can be entered in the value fields of the condition panel
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sMaxLength - New value for property maxLength
* @returns {sap.m.P13nItem} Reference to this
in order to allow method chaining
*/
public setMaxLength(sMaxLength: string): sap.m.P13nItem;
/**
* Sets a new value for property {@link #getPrecision precision}.
*
* if type==numeric the precision will be used to format the entered value (maxIntegerDigits of the used Formatter)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sPrecision - New value for property precision
* @returns {sap.m.P13nItem} Reference to this
in order to allow method chaining
*/
public setPrecision(sPrecision: string): sap.m.P13nItem;
/**
* Sets a new value for property {@link #getPress press}.
*
* Defines press handler of a link.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oPress - New value for property press
* @returns {sap.m.P13nItem} Reference to this
in order to allow method chaining
*/
public setPress(oPress: any): sap.m.P13nItem;
/**
* Sets a new value for property {@link #getRole role}.
*
* Defines role. The role is reflected in the manner how the dimension will influence the chart layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sRole - New value for property role
* @returns {sap.m.P13nItem} Reference to this
in order to allow method chaining
*/
public setRole(sRole: string): sap.m.P13nItem;
/**
* Sets a new value for property {@link #getScale scale}.
*
* if type==numeric the scale will be used to format the entered value (maxFractionDigits of the used Formatter)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sScale - New value for property scale
* @returns {sap.m.P13nItem} Reference to this
in order to allow method chaining
*/
public setScale(sScale: string): sap.m.P13nItem;
/**
* Sets a new value for property {@link #getTarget target}.
*
* Defines target of a link.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTarget - New value for property target
* @returns {sap.m.P13nItem} Reference to this
in order to allow method chaining
*/
public setTarget(sTarget: string): sap.m.P13nItem;
/**
* Sets a new value for property {@link #getText text}.
*
* The text to be displayed for the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sText - New value for property text
* @returns {sap.m.P13nItem} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.P13nItem;
/**
* Sets a new value for property {@link #getType type}.
*
* data type of the column (text, numeric or date is supported)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is text
.
* @param {string} sType - New value for property type
* @returns {sap.m.P13nItem} Reference to this
in order to allow method chaining
*/
public setType(sType: string): sap.m.P13nItem;
/**
* Sets a new value for property {@link #getValues values}.
*
* the array of values for type bool. e.g. ["", "Off", "On"]. The first entry can be empty (used to blank the value field). Next value
* represent the false value, last entry the true value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string[]} sValues - New value for property values
* @returns {sap.m.P13nItem} Reference to this
in order to allow method chaining
*/
public setValues(sValues: string[]): sap.m.P13nItem;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Defines visibility of column
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.P13nItem} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.P13nItem;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines column width
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sWidth - New value for property width
* @returns {sap.m.P13nItem} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: string): sap.m.P13nItem;
}
/**
* Base type for panels
aggregation in P13nDialog
control.
*/
export class P13nPanel extends sap.ui.core.Control {
/**
* Constructor for a new P13nPanel.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.m.P13nItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.m.P13nItem): sap.m.P13nPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeNavigationTo beforeNavigationTo} event of this sap.m.P13nPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nPanel
itself.
*
* Due to performance the data of the panel can be requested in lazy mode e.g. when the panel is displayed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nPanel
itself
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
public attachBeforeNavigationTo(fnFunction: Function, oListener?: any): sap.m.P13nPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeNavigationTo beforeNavigationTo} event of this sap.m.P13nPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nPanel
itself.
*
* Due to performance the data of the panel can be requested in lazy mode e.g. when the panel is displayed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nPanel
itself
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
public attachBeforeNavigationTo(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nPanel;
/**
* This method defines the point in time before the panel becomes active.
*/
public beforeNavigationTo(): void;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.m.P13nPanel;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.P13nPanel;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeNavigationTo beforeNavigationTo} event of this sap.m.P13nPanel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
public detachBeforeNavigationTo(fnFunction: Function, oListener: any): sap.m.P13nPanel;
/**
* Creates a new subclass of class sap.m.P13nPanel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:beforeNavigationTo beforeNavigationTo} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
protected fireBeforeNavigationTo(mParameters?: any): sap.m.P13nPanel;
/**
* Gets current value of property {@link #getChangeNotifier changeNotifier}.
*
* Callback which notifies a change on this panel.
* @returns {any} Value of property changeNotifier
*/
public getChangeNotifier(): any;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Defines personalization items (e.g. columns in the P13nColumnsPanel
).
* @returns {sap.m.P13nItem[]}
*/
public getItems(): sap.m.P13nItem[];
/**
* Returns a metadata object for class sap.m.P13nPanel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* This method can be overwritten by subclass in order to return a payload for Ok action
* @returns {any} Object which describes the state after Ok has been pressed
*/
public getOkPayload(): any;
/**
* This method can be overwritten by subclass in order to return a payload for Reset action
* @returns {any}
*/
public getResetPayload(): any;
/**
* Gets current value of property {@link #getTitle title}.
*
* Title text appears in the panel.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getTitleLarge titleLarge}.
*
* Large title text appears e.g. in dialog header in case that only one panel is shown.
* @returns {string} Value of property titleLarge
*/
public getTitleLarge(): string;
/**
* Gets current value of property {@link #getType type}.
*
* Panel type for generic use. Due to extensibility reason the type of type
property should be string
.
* So it is feasible to add a custom panel without expanding the type.
* @returns {string} Value of property type
*/
public getType(): string;
/**
* Gets current value of property {@link #getValidationExecutor validationExecutor}.
*
* Callback method which is called in order to validate end user entry.
* @returns {any} Value of property validationExecutor
*/
public getValidationExecutor(): any;
/**
* Gets current value of property {@link #getValidationListener validationListener}.
*
* Callback method which is called in order to register for validation result.
* @returns {any} Value of property validationListener
*/
public getValidationListener(): any;
/**
* Gets current value of property {@link #getVerticalScrolling verticalScrolling}.
*
* Enables the vertical Scrolling on the P13nDialog
when the panel is shown.
*
* Default value is true
.
* @returns {boolean} Value of property verticalScrolling
*/
public getVerticalScrolling(): boolean;
/**
* Checks for the provided sap.m.P13nItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.P13nItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.m.P13nItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.m.P13nItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.m.P13nItem, iIndex: number): sap.m.P13nPanel;
/**
* This method can be overwritten by subclass in order to cleanup after navigation, e.g. to remove invalid content on the panel.
*/
public onAfterNavigationFrom(): void;
/**
* This method can be overwritten by subclass in order to prevent navigation to another panel. This could be the case if some content on the panel
* is considered 'invalid'.
* @returns {boolean} true if it is allowed to navigate away from this panel, false if it is not allowed
*/
public onBeforeNavigationFrom(): boolean;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.P13nItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.m.P13nItem[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.m.P13nItem} vItem - The item to remove or its index or id
* @returns {sap.m.P13nItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.m.P13nItem): sap.m.P13nItem;
/**
* Sets a new value for property {@link #getChangeNotifier changeNotifier}.
*
* Callback which notifies a change on this panel.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oChangeNotifier - New value for property changeNotifier
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
public setChangeNotifier(oChangeNotifier: any): sap.m.P13nPanel;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Title text appears in the panel.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.P13nPanel;
/**
* Sets a new value for property {@link #getTitleLarge titleLarge}.
*
* Large title text appears e.g. in dialog header in case that only one panel is shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitleLarge - New value for property titleLarge
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
public setTitleLarge(sTitleLarge: string): sap.m.P13nPanel;
/**
* Sets a new value for property {@link #getType type}.
*
* Panel type for generic use. Due to extensibility reason the type of type
property should be string
.
* So it is feasible to add a custom panel without expanding the type.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sType - New value for property type
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
public setType(sType: string): sap.m.P13nPanel;
/**
* Sets a new value for property {@link #getValidationExecutor validationExecutor}.
*
* Callback method which is called in order to validate end user entry.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oValidationExecutor - New value for property validationExecutor
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
public setValidationExecutor(oValidationExecutor: any): sap.m.P13nPanel;
/**
* Sets a new value for property {@link #getValidationListener validationListener}.
*
* Callback method which is called in order to register for validation result.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oValidationListener - New value for property validationListener
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
public setValidationListener(oValidationListener: any): sap.m.P13nPanel;
/**
* Sets a new value for property {@link #getVerticalScrolling verticalScrolling}.
*
* Enables the vertical Scrolling on the P13nDialog
when the panel is shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVerticalScrolling - New value for property verticalScrolling
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
public setVerticalScrolling(bVerticalScrolling: boolean): sap.m.P13nPanel;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.m.P13nPanel} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.m.P13nPanel;
}
/**
* Type of panels used in the personalization dialog.
*/
export enum P13nPanelType {
/**
* Panel type for column settings.
*/
columns = "columns",
/**
* Panel type for dimension and measure settings.
*/
dimeasure = "dimeasure",
/**
* Panel type for filtering.
*/
filter = "filter",
/**
* Panel type for grouping.
*/
group = "group",
/**
* Panel type for sorting.
*/
sort = "sort",
}
/**
* Type for sortItems
aggregation in P13nSortPanel control.
*/
export class P13nSortItem extends sap.ui.core.Item {
/**
* Constructor for a new P13nSortItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.P13nSortItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getColumnKey columnKey}.
*
* key of the column
* @returns {string} Value of property columnKey
*/
public getColumnKey(): string;
/**
* Returns a metadata object for class sap.m.P13nSortItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getOperation operation}.
*
* sap.m.P13nConditionOperation
* @returns {string} Value of property operation
*/
public getOperation(): string;
/**
* Sets a new value for property {@link #getColumnKey columnKey}.
*
* key of the column
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sColumnKey - New value for property columnKey
* @returns {sap.m.P13nSortItem} Reference to this
in order to allow method chaining
*/
public setColumnKey(sColumnKey: string): sap.m.P13nSortItem;
/**
* Sets a new value for property {@link #getOperation operation}.
*
* sap.m.P13nConditionOperation
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sOperation - New value for property operation
* @returns {sap.m.P13nSortItem} Reference to this
in order to allow method chaining
*/
public setOperation(sOperation: string): sap.m.P13nSortItem;
}
/**
* The P13nSortPanel control is used to define settings for sorting in table personalization.
*/
export class P13nSortPanel extends sap.m.P13nPanel {
/**
* Constructor for a new P13nSortPanel.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some sortItem to the aggregation {@link #getSortItems sortItems}.
* @param {sap.m.P13nSortItem} oSortItem - the sortItem to add; if empty, nothing is inserted
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public addSortItem(oSortItem: sap.m.P13nSortItem): sap.m.P13nSortPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:addSortItem addSortItem} event of this sap.m.P13nSortPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nSortPanel
itself.
*
* event raised when a SortItem was added
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nSortPanel
itself
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public attachAddSortItem(fnFunction: Function, oListener?: any): sap.m.P13nSortPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:addSortItem addSortItem} event of this sap.m.P13nSortPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nSortPanel
itself.
*
* event raised when a SortItem was added
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nSortPanel
itself
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public attachAddSortItem(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nSortPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:removeSortItem removeSortItem} event of this sap.m.P13nSortPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nSortPanel
itself.
*
* event raised when a SortItem was removed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nSortPanel
itself
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public attachRemoveSortItem(fnFunction: Function, oListener?: any): sap.m.P13nSortPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:removeSortItem removeSortItem} event of this sap.m.P13nSortPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nSortPanel
itself.
*
* event raised when a SortItem was removed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nSortPanel
itself
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public attachRemoveSortItem(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nSortPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:updateSortItem updateSortItem} event of this sap.m.P13nSortPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nSortPanel
itself.
*
* event raised when a SortItem was updated
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nSortPanel
itself
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public attachUpdateSortItem(fnFunction: Function, oListener?: any): sap.m.P13nSortPanel;
/**
* Attaches event handler fnFunction
to the {@link #event:updateSortItem updateSortItem} event of this sap.m.P13nSortPanel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.P13nSortPanel
itself.
*
* event raised when a SortItem was updated
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.P13nSortPanel
itself
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public attachUpdateSortItem(oData: any, fnFunction: Function, oListener?: any): sap.m.P13nSortPanel;
/**
* Binds aggregation {@link #getSortItems sortItems} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public bindSortItems(oBindingInfo: any): sap.m.P13nSortPanel;
/**
* Destroys all the sortItems in the aggregation {@link #getSortItems sortItems}.
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public destroySortItems(): sap.m.P13nSortPanel;
/**
* Detaches event handler fnFunction
from the {@link #event:addSortItem addSortItem} event of this sap.m.P13nSortPanel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public detachAddSortItem(fnFunction: Function, oListener: any): sap.m.P13nSortPanel;
/**
* Detaches event handler fnFunction
from the {@link #event:removeSortItem removeSortItem} event of this sap.m.P13nSortPanel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public detachRemoveSortItem(fnFunction: Function, oListener: any): sap.m.P13nSortPanel;
/**
* Detaches event handler fnFunction
from the {@link #event:updateSortItem updateSortItem} event of this sap.m.P13nSortPanel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public detachUpdateSortItem(fnFunction: Function, oListener: any): sap.m.P13nSortPanel;
/**
* Creates a new subclass of class sap.m.P13nSortPanel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.P13nPanel.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:addSortItem addSortItem} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
protected fireAddSortItem(mParameters?: any): sap.m.P13nSortPanel;
/**
* Fires event {@link #event:removeSortItem removeSortItem} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
protected fireRemoveSortItem(mParameters?: any): sap.m.P13nSortPanel;
/**
* Fires event {@link #event:updateSortItem updateSortItem} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
protected fireUpdateSortItem(mParameters?: any): sap.m.P13nSortPanel;
/**
* Gets current value of property {@link #getContainerQuery containerQuery}.
*
* defines if the mediaQuery or a ContainerResize will be used for layout update. When the ConditionPanel is used on a dialog the
* property should be set to true!
*
* Default value is false
.
* @returns {boolean} Value of property containerQuery
*/
public getContainerQuery(): boolean;
/**
* Gets current value of property {@link #getLayoutMode layoutMode}.
*
* can be used to control the layout behavior. Default is "" which will automatically change the layout. With "Desktop", "Table"
* or "Phone" you can set a fixed layout.
* @returns {string} Value of property layoutMode
*/
public getLayoutMode(): string;
/**
* Returns a metadata object for class sap.m.P13nSortPanel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getSortItems sortItems}.
*
* defined Sort Items
* @returns {sap.m.P13nSortItem[]}
*/
public getSortItems(): sap.m.P13nSortItem[];
/**
* Checks for the provided sap.m.P13nSortItem
in the aggregation {@link #getSortItems sortItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.P13nSortItem} oSortItem - The sortItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSortItem(oSortItem: sap.m.P13nSortItem): number;
/**
* Inserts a sortItem into the aggregation {@link #getSortItems sortItems}.
* @param {sap.m.P13nSortItem} oSortItem - the sortItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the sortItem should be inserted at; for a negative value of iIndex
, the sortItem is inserted at position 0; for a value greater than the current size of the aggregation, the sortItem is inserted at the last position
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public insertSortItem(oSortItem: sap.m.P13nSortItem, iIndex: number): sap.m.P13nSortPanel;
/**
* Removes all the controls from the aggregation {@link #getSortItems sortItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.P13nSortItem[]} An array of the removed elements (might be empty)
*/
public removeAllSortItems(): sap.m.P13nSortItem[];
/**
* removes all invalid sort conditions.
*/
public removeInvalidConditions(): void;
/**
* Removes a sortItem from the aggregation {@link #getSortItems sortItems}.
* @param {number|string|sap.m.P13nSortItem} vSortItem - The sortItem to remove or its index or id
* @returns {sap.m.P13nSortItem} The removed sortItem or null
*/
public removeSortItem(vSortItem: number|string|sap.m.P13nSortItem): sap.m.P13nSortItem;
/**
* removes all errors/warning states from of all sort conditions.
*/
public removeValidationErrors(): void;
/**
* Sets a new value for property {@link #getContainerQuery containerQuery}.
*
* defines if the mediaQuery or a ContainerResize will be used for layout update. When the ConditionPanel is used on a dialog the
* property should be set to true!
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bContainerQuery - New value for property containerQuery
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public setContainerQuery(bContainerQuery: boolean): sap.m.P13nSortPanel;
/**
* Sets a new value for property {@link #getLayoutMode layoutMode}.
*
* can be used to control the layout behavior. Default is "" which will automatically change the layout. With "Desktop", "Table"
* or "Phone" you can set a fixed layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sLayoutMode - New value for property layoutMode
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public setLayoutMode(sLayoutMode: string): sap.m.P13nSortPanel;
/**
* setter for the supported operations array
* @param {any[]} array - of operations [sap.m.P13nConditionOperation.BT, sap.m.P13nConditionOperation.EQ]
* @returns {sap.m.P13nSortPanel} this for chaining
*/
public setOperations(array: any[]): sap.m.P13nSortPanel;
/**
* Unbinds aggregation {@link #getSortItems sortItems} from model data.
* @returns {sap.m.P13nSortPanel} Reference to this
in order to allow method chaining
*/
public unbindSortItems(): sap.m.P13nSortPanel;
/**
* check if the entered/modified conditions are correct, marks invalid fields yellow (Warning state) and opens a popup message dialog to give the
* user the feedback that some values are wrong or missing.
* @returns {boolean} True
if all conditions are valid, false
otherwise.
*/
public validateConditions(): boolean;
}
/**
* A container control that holds one whole screen of an application.
*
* Overview
* The sap.m.Page is a container control that holds one whole screen of an application.
* The page has three distinct areas that can hold content - a header, content area and a footer.
* Structure
* Header
* The top most area of the page is occupied by the header. The standard header includes a navigation button and a title.
* Alternatively, you can create your own custom header, which is defined in the customHeader
aggregation.
* Content
* The content occupies the main part of the page. Only the content area is scrollable by default.
* This can be prevented by setting enableScrolling
to false
.
* Footer
* The footer is optional and occupies the fixed bottom part of the page. Alternatively, the footer can be floating above the bottom part of the content.
* This is enabled with the floatingFooter
property.
*
* Note: All accessibility information for the different areas and their corresponding ARIA roles is set in the aggregation landmarkInfo
of type {@link sap.m.PageAccessibleLandmarkInfo}
*/
export class Page extends sap.ui.core.Control {
/**
* Constructor for a new Page.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.Page;
/**
* Adds some headerContent to the aggregation {@link #getHeaderContent headerContent}.
* @param {sap.ui.core.Control} oHeaderContent - the headerContent to add; if empty, nothing is inserted
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public addHeaderContent(oHeaderContent: sap.ui.core.Control): sap.m.Page;
/**
* Attaches event handler fnFunction
to the {@link #event:navButtonPress navButtonPress} event of this sap.m.Page
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Page
itself.
*
* this event is fired when Nav Button is pressed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Page
itself
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public attachNavButtonPress(fnFunction: Function, oListener?: any): sap.m.Page;
/**
* Attaches event handler fnFunction
to the {@link #event:navButtonPress navButtonPress} event of this sap.m.Page
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Page
itself.
*
* this event is fired when Nav Button is pressed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Page
itself
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public attachNavButtonPress(oData: any, fnFunction: Function, oListener?: any): sap.m.Page;
/**
* Attaches event handler fnFunction
to the {@link #event:navButtonTap navButtonTap} event of this sap.m.Page
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Page
itself.
*
* this event is fired when Nav Button is tapped
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Page
itself
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public attachNavButtonTap(fnFunction: Function, oListener?: any): sap.m.Page;
/**
* Attaches event handler fnFunction
to the {@link #event:navButtonTap navButtonTap} event of this sap.m.Page
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Page
itself.
*
* this event is fired when Nav Button is tapped
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Page
itself
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public attachNavButtonTap(oData: any, fnFunction: Function, oListener?: any): sap.m.Page;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.Page;
/**
* Destroys the customHeader in the aggregation {@link #getCustomHeader customHeader}.
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public destroyCustomHeader(): sap.m.Page;
/**
* Destroys the footer in the aggregation {@link #getFooter footer}.
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public destroyFooter(): sap.m.Page;
/**
* Destroys all the headerContent in the aggregation {@link #getHeaderContent headerContent}.
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public destroyHeaderContent(): sap.m.Page;
/**
* Destroys the landmarkInfo in the aggregation {@link #getLandmarkInfo landmarkInfo}.
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public destroyLandmarkInfo(): sap.m.Page;
/**
* Destroys the subHeader in the aggregation {@link #getSubHeader subHeader}.
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public destroySubHeader(): sap.m.Page;
/**
* Detaches event handler fnFunction
from the {@link #event:navButtonPress navButtonPress} event of this sap.m.Page
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public detachNavButtonPress(fnFunction: Function, oListener: any): sap.m.Page;
/**
* Detaches event handler fnFunction
from the {@link #event:navButtonTap navButtonTap} event of this sap.m.Page
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public detachNavButtonTap(fnFunction: Function, oListener: any): sap.m.Page;
/**
* Creates a new subclass of class sap.m.Page with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:navButtonPress navButtonPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
protected fireNavButtonPress(mParameters?: any): sap.m.Page;
/**
* Fires event {@link #event:navButtonTap navButtonTap} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
protected fireNavButtonTap(mParameters?: any): sap.m.Page;
/**
* Gets current value of property {@link #getBackgroundDesign backgroundDesign}.
*
* This property is used to set the background color of a page. When a list is placed inside a page, the value "List" should be used to display a gray background. "Standard", with the value white, is used as default if not specified.
*
* Default value is Standard
.
* @returns {sap.m.PageBackgroundDesign} Value of property backgroundDesign
*/
public getBackgroundDesign(): sap.m.PageBackgroundDesign;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content of this page
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getContentOnlyBusy contentOnlyBusy}.
*
* Decides which area is covered by the local BusyIndicator when page.setBusy()
is called. By default the entire page is covered, including headers and footer. When this property is set to "true", only the content area is covered (not header/sub header and footer), which is useful e.g. when there is a SearchField in the sub header and live search continuously updates the content area while the user is still able to type.
*
* Default value is false
.
* @returns {boolean} Value of property contentOnlyBusy
*/
public getContentOnlyBusy(): boolean;
/**
* Gets content of aggregation {@link #getCustomHeader customHeader}.
*
* The (optional) custom header of this page.
* Use this aggregation only when a custom header is constructed where the default header consisting of title text + nav button is not sufficient.
* If this aggregation is set, the simple properties "title", "showNavButton", "NavButtonText" and "icon" are not used.
* @returns {sap.m.IBar}
*/
public getCustomHeader(): sap.m.IBar;
/**
* Gets current value of property {@link #getEnableScrolling enableScrolling}.
*
* Enable vertical scrolling of page contents. Page headers and footers are fixed and do not scroll.
* If set to false, there will be no scrolling at all.
*
* The Page only allows vertical scrolling because horizontal scrolling is discouraged in general for full-page content. If it still needs to be achieved, disable the Page scrolling and use a ScrollContainer as full-page content of the Page. This allows you to freely configure scrolling. It can also be used to create horizontally-scrolling sub-areas of (vertically-scrolling) Pages.
*
* Default value is true
.
* @returns {boolean} Value of property enableScrolling
*/
public getEnableScrolling(): boolean;
/**
* Gets current value of property {@link #getFloatingFooter floatingFooter}.
*
* Decides whether the floating footer behavior should be enabled.
* When the floating footer behavior is used, the content is visible when it's underneath the footer.
*
* Default value is false
.
* @returns {boolean} Value of property floatingFooter
*/
public getFloatingFooter(): boolean;
/**
* Gets content of aggregation {@link #getFooter footer}.
*
* The (optional) footer of this page. It is always located at the bottom of the page
* @returns {sap.m.IBar}
*/
public getFooter(): sap.m.IBar;
/**
* Gets content of aggregation {@link #getHeaderContent headerContent}.
*
* Controls to be added to the right side of the page header. Usually an application would use Button controls and limit the number to one when the application needs to run on smartphones. There is no automatic overflow handling when the space is insufficient.
* When a customHeader is used, this aggregation will be ignored.
* @returns {sap.ui.core.Control[]}
*/
public getHeaderContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getIcon icon}.
*
* the icon that is rendered in the page header bar in non-iOS phone/tablet platforms. This property is theme-dependent and only has an effect in the MVI theme.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets content of aggregation {@link #getLandmarkInfo landmarkInfo}.
*
* Accessible landmark settings to be applied on the containers of the sap.m.Page
control.
*
* If not set, no landmarks will be written.
* @returns {sap.m.PageAccessibleLandmarkInfo}
*/
public getLandmarkInfo(): sap.m.PageAccessibleLandmarkInfo;
/**
* Returns a metadata object for class sap.m.Page.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getNavButtonText navButtonText}.
*
* The text of the nav button when running in iOS (if shown) in case it deviates from the default, which is "Back". This property is mvi-theme-dependent and will not have any effect in other themes.
* @returns {string} Value of property navButtonText
*/
public getNavButtonText(): string;
/**
* Gets current value of property {@link #getNavButtonTooltip navButtonTooltip}.
*
* The tooltip of the nav button
*
* Since version 1.34
* @returns {string} Value of property navButtonTooltip
*/
public getNavButtonTooltip(): string;
/**
* Gets current value of property {@link #getNavButtonType navButtonType}.
*
* This property is used to set the appearance of the NavButton. By default when showNavButton is set to true, a back button will be shown in iOS and an up button in other platforms. In case you want to show a normal button in the left header area, you can set the value to "Default".
*
* Default value is Back
.
* @returns {sap.m.ButtonType} Value of property navButtonType
*/
public getNavButtonType(): sap.m.ButtonType;
/**
* Gets current value of property {@link #getShowFooter showFooter}.
*
* Whether this page shall have a footer
*
* Default value is true
.
* @returns {boolean} Value of property showFooter
*/
public getShowFooter(): boolean;
/**
* Gets current value of property {@link #getShowHeader showHeader}.
*
* Whether this page shall have a header.
* If set to true, either the control under the "customHeader" aggregation is used, or if there is no such control, a Header control is constructed from the properties "title", "showNavButton", "navButtonText" and "icon" depending on the platform.
*
* Default value is true
.
* @returns {boolean} Value of property showHeader
*/
public getShowHeader(): boolean;
/**
* Gets current value of property {@link #getShowNavButton showNavButton}.
*
* A nav button will be rendered on the left area of header bar if this property is set to true.
*
* Default value is false
.
* @returns {boolean} Value of property showNavButton
*/
public getShowNavButton(): boolean;
/**
* Gets current value of property {@link #getShowSubHeader showSubHeader}.
*
* Whether this page shall show the subheader.
*
* Default value is true
.
* @returns {boolean} Value of property showSubHeader
*/
public getShowSubHeader(): boolean;
/**
* Gets content of aggregation {@link #getSubHeader subHeader}.
*
* a subHeader will be rendered directly under the header
* @returns {sap.m.IBar}
*/
public getSubHeader(): sap.m.IBar;
/**
* Gets current value of property {@link #getTitle title}.
*
* The title text appearing in the page header bar.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getTitleLevel titleLevel}.
*
* Defines the semantic level of the title. Using "Auto" no explicit level information is written.
* Used for accessibility purposes only.
*
* Default value is Auto
.
* @returns {sap.ui.core.TitleLevel} Value of property titleLevel
*/
public getTitleLevel(): sap.ui.core.TitleLevel;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getHeaderContent headerContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oHeaderContent - The headerContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfHeaderContent(oHeaderContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.Page;
/**
* Inserts a headerContent into the aggregation {@link #getHeaderContent headerContent}.
* @param {sap.ui.core.Control} oHeaderContent - the headerContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the headerContent should be inserted at; for a negative value of iIndex
, the headerContent is inserted at position 0; for a value greater than the current size of the aggregation, the headerContent is inserted at the last position
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public insertHeaderContent(oHeaderContent: sap.ui.core.Control, iIndex: number): sap.m.Page;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getHeaderContent headerContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllHeaderContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a headerContent from the aggregation {@link #getHeaderContent headerContent}.
* @param {number|string|sap.ui.core.Control} vHeaderContent - The headerContent to remove or its index or id
* @returns {sap.ui.core.Control} The removed headerContent or null
*/
public removeHeaderContent(vHeaderContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Scrolls to the given position. Only available if enableScrolling is set to "true".
* @param {number} y - The vertical pixel position to scroll to. Scrolling down happens with positive values.
* @param {number} time - The duration of animated scrolling. To scroll immediately without animation, give 0 as value. 0 is also the default value, when this optional parameter is omitted.
* @returns {sap.m.Page}
*/
public scrollTo(y: number, time: number): sap.m.Page;
/**
* Scrolls to an element(DOM or sap.ui.core.Element) within the page if the element is rendered.
* @param {HTMLElement|sap.ui.core.Element} oElement - The element to which should be scrolled.
* @param {number} iTime - The duration of animated scrolling. To scroll immediately without animation, give 0 as value or leave it default.
* @returns {sap.m.Page} this
to facilitate method chaining.
*/
public scrollToElement(oElement: HTMLElement|sap.ui.core.Element, iTime?: number): sap.m.Page;
/**
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
*
* This property is used to set the background color of a page. When a list is placed inside a page, the value "List" should be used to display a gray background. "Standard", with the value white, is used as default if not specified.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.m.PageBackgroundDesign} sBackgroundDesign - New value for property backgroundDesign
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setBackgroundDesign(sBackgroundDesign: sap.m.PageBackgroundDesign): sap.m.Page;
/**
* Sets a new value for property {@link #getContentOnlyBusy contentOnlyBusy}.
*
* Decides which area is covered by the local BusyIndicator when page.setBusy()
is called. By default the entire page is covered, including headers and footer. When this property is set to "true", only the content area is covered (not header/sub header and footer), which is useful e.g. when there is a SearchField in the sub header and live search continuously updates the content area while the user is still able to type.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bContentOnlyBusy - New value for property contentOnlyBusy
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setContentOnlyBusy(bContentOnlyBusy: boolean): sap.m.Page;
/**
* Sets a new value for property {@link #getEnableScrolling enableScrolling}.
*
* Enable vertical scrolling of page contents. Page headers and footers are fixed and do not scroll.
* If set to false, there will be no scrolling at all.
*
* The Page only allows vertical scrolling because horizontal scrolling is discouraged in general for full-page content. If it still needs to be achieved, disable the Page scrolling and use a ScrollContainer as full-page content of the Page. This allows you to freely configure scrolling. It can also be used to create horizontally-scrolling sub-areas of (vertically-scrolling) Pages.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableScrolling - New value for property enableScrolling
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setEnableScrolling(bEnableScrolling: boolean): sap.m.Page;
/**
* Sets a new value for property {@link #getFloatingFooter floatingFooter}.
*
* Decides whether the floating footer behavior should be enabled.
* When the floating footer behavior is used, the content is visible when it's underneath the footer.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bFloatingFooter - New value for property floatingFooter
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setFloatingFooter(bFloatingFooter: boolean): sap.m.Page;
/**
* Sets the aggregated {@link #getFooter footer}.
* @param {sap.m.IBar} oFooter - The footer to set
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setFooter(oFooter: sap.m.IBar): sap.m.Page;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* the icon that is rendered in the page header bar in non-iOS phone/tablet platforms. This property is theme-dependent and only has an effect in the MVI theme.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.Page;
/**
* Sets the aggregated {@link #getLandmarkInfo landmarkInfo}.
* @param {sap.m.PageAccessibleLandmarkInfo} oLandmarkInfo - The landmarkInfo to set
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setLandmarkInfo(oLandmarkInfo: sap.m.PageAccessibleLandmarkInfo): sap.m.Page;
/**
* Sets a new value for property {@link #getNavButtonText navButtonText}.
*
* The text of the nav button when running in iOS (if shown) in case it deviates from the default, which is "Back". This property is mvi-theme-dependent and will not have any effect in other themes.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sNavButtonText - New value for property navButtonText
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setNavButtonText(sNavButtonText: string): sap.m.Page;
/**
* Sets a new value for property {@link #getNavButtonTooltip navButtonTooltip}.
*
* The tooltip of the nav button
*
* Since version 1.34
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sNavButtonTooltip - New value for property navButtonTooltip
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setNavButtonTooltip(sNavButtonTooltip: string): sap.m.Page;
/**
* Sets a new value for property {@link #getNavButtonType navButtonType}.
*
* This property is used to set the appearance of the NavButton. By default when showNavButton is set to true, a back button will be shown in iOS and an up button in other platforms. In case you want to show a normal button in the left header area, you can set the value to "Default".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Back
.
* @param {sap.m.ButtonType} sNavButtonType - New value for property navButtonType
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setNavButtonType(sNavButtonType: sap.m.ButtonType): sap.m.Page;
/**
* Sets a new value for property {@link #getShowFooter showFooter}.
*
* Whether this page shall have a footer
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowFooter - New value for property showFooter
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setShowFooter(bShowFooter: boolean): sap.m.Page;
/**
* Sets a new value for property {@link #getShowHeader showHeader}.
*
* Whether this page shall have a header.
* If set to true, either the control under the "customHeader" aggregation is used, or if there is no such control, a Header control is constructed from the properties "title", "showNavButton", "navButtonText" and "icon" depending on the platform.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowHeader - New value for property showHeader
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setShowHeader(bShowHeader: boolean): sap.m.Page;
/**
* Sets a new value for property {@link #getShowNavButton showNavButton}.
*
* A nav button will be rendered on the left area of header bar if this property is set to true.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowNavButton - New value for property showNavButton
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setShowNavButton(bShowNavButton: boolean): sap.m.Page;
/**
* Sets a new value for property {@link #getShowSubHeader showSubHeader}.
*
* Whether this page shall show the subheader.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowSubHeader - New value for property showSubHeader
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setShowSubHeader(bShowSubHeader: boolean): sap.m.Page;
/**
* Sets the aggregated {@link #getSubHeader subHeader}.
* @param {sap.m.IBar} oSubHeader - The subHeader to set
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setSubHeader(oSubHeader: sap.m.IBar): sap.m.Page;
/**
* Sets a new value for property {@link #getTitle title}.
*
* The title text appearing in the page header bar.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.Page;
/**
* Sets a new value for property {@link #getTitleLevel titleLevel}.
*
* Defines the semantic level of the title. Using "Auto" no explicit level information is written.
* Used for accessibility purposes only.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.ui.core.TitleLevel} sTitleLevel - New value for property titleLevel
* @returns {sap.m.Page} Reference to this
in order to allow method chaining
*/
public setTitleLevel(sTitleLevel: sap.ui.core.TitleLevel): sap.m.Page;
}
/**
* Settings for accessible landmarks which can be applied to the container elements of a sap.m.Page
control.
* These landmarks are e.g. used by assistive technologies (like screenreaders) to provide a meaningful page overview.
*/
export class PageAccessibleLandmarkInfo extends sap.ui.core.Element {
/**
* Constructor for a new sap.m.PageAccessibleLandmarkInfo
element.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new element, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new element
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.PageAccessibleLandmarkInfo with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getContentLabel contentLabel}.
*
* Texts which describes the landmark of the content container of the corresponding sap.m.Page
control.
*
* If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text
* is used.
* @returns {string} Value of property contentLabel
*/
public getContentLabel(): string;
/**
* Gets current value of property {@link #getContentRole contentRole}.
*
* Landmark role of the content container of the corresponding sap.m.Page
control.
*
* If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
*
* Default value is Main
.
* @returns {sap.ui.core.AccessibleLandmarkRole} Value of property contentRole
*/
public getContentRole(): sap.ui.core.AccessibleLandmarkRole;
/**
* Gets current value of property {@link #getFooterLabel footerLabel}.
*
* Texts which describes the landmark of the header container of the corresponding sap.m.Page
control.
*
* If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text
* is used.
* @returns {string} Value of property footerLabel
*/
public getFooterLabel(): string;
/**
* Gets current value of property {@link #getFooterRole footerRole}.
*
* Landmark role of the footer container of the corresponding sap.m.Page
control.
*
* If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
*
* Default value is Region
.
* @returns {sap.ui.core.AccessibleLandmarkRole} Value of property footerRole
*/
public getFooterRole(): sap.ui.core.AccessibleLandmarkRole;
/**
* Gets current value of property {@link #getHeaderLabel headerLabel}.
*
* Texts which describes the landmark of the header container of the corresponding sap.m.Page
control.
*
* If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text
* is used.
* @returns {string} Value of property headerLabel
*/
public getHeaderLabel(): string;
/**
* Gets current value of property {@link #getHeaderRole headerRole}.
*
* Landmark role of the header container of the corresponding sap.m.Page
control.
*
* If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
*
* Default value is Region
.
* @returns {sap.ui.core.AccessibleLandmarkRole} Value of property headerRole
*/
public getHeaderRole(): sap.ui.core.AccessibleLandmarkRole;
/**
* Returns a metadata object for class sap.m.PageAccessibleLandmarkInfo.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRootLabel rootLabel}.
*
* Texts which describes the landmark of the root container of the corresponding sap.m.Page
control.
*
* If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text
* is used.
* @returns {string} Value of property rootLabel
*/
public getRootLabel(): string;
/**
* Gets current value of property {@link #getRootRole rootRole}.
*
* Landmark role of the root container of the corresponding sap.m.Page
control.
*
* If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
*
* Default value is Region
.
* @returns {sap.ui.core.AccessibleLandmarkRole} Value of property rootRole
*/
public getRootRole(): sap.ui.core.AccessibleLandmarkRole;
/**
* Gets current value of property {@link #getSubHeaderLabel subHeaderLabel}.
*
* Texts which describes the landmark of the subheader container of the corresponding sap.m.Page
control.
*
* If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text
* is used.
* @returns {string} Value of property subHeaderLabel
*/
public getSubHeaderLabel(): string;
/**
* Gets current value of property {@link #getSubHeaderRole subHeaderRole}.
*
* Landmark role of the subheader container of the corresponding sap.m.Page
control.
*
* If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
* @returns {sap.ui.core.AccessibleLandmarkRole} Value of property subHeaderRole
*/
public getSubHeaderRole(): sap.ui.core.AccessibleLandmarkRole;
/**
* Sets a new value for property {@link #getContentLabel contentLabel}.
*
* Texts which describes the landmark of the content container of the corresponding sap.m.Page
control.
*
* If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text
* is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sContentLabel - New value for property contentLabel
* @returns {sap.m.PageAccessibleLandmarkInfo} Reference to this
in order to allow method chaining
*/
public setContentLabel(sContentLabel: string): sap.m.PageAccessibleLandmarkInfo;
/**
* Sets a new value for property {@link #getContentRole contentRole}.
*
* Landmark role of the content container of the corresponding sap.m.Page
control.
*
* If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Main
.
* @param {sap.ui.core.AccessibleLandmarkRole} sContentRole - New value for property contentRole
* @returns {sap.m.PageAccessibleLandmarkInfo} Reference to this
in order to allow method chaining
*/
public setContentRole(sContentRole: sap.ui.core.AccessibleLandmarkRole): sap.m.PageAccessibleLandmarkInfo;
/**
* Sets a new value for property {@link #getFooterLabel footerLabel}.
*
* Texts which describes the landmark of the header container of the corresponding sap.m.Page
control.
*
* If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text
* is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sFooterLabel - New value for property footerLabel
* @returns {sap.m.PageAccessibleLandmarkInfo} Reference to this
in order to allow method chaining
*/
public setFooterLabel(sFooterLabel: string): sap.m.PageAccessibleLandmarkInfo;
/**
* Sets a new value for property {@link #getFooterRole footerRole}.
*
* Landmark role of the footer container of the corresponding sap.m.Page
control.
*
* If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Region
.
* @param {sap.ui.core.AccessibleLandmarkRole} sFooterRole - New value for property footerRole
* @returns {sap.m.PageAccessibleLandmarkInfo} Reference to this
in order to allow method chaining
*/
public setFooterRole(sFooterRole: sap.ui.core.AccessibleLandmarkRole): sap.m.PageAccessibleLandmarkInfo;
/**
* Sets a new value for property {@link #getHeaderLabel headerLabel}.
*
* Texts which describes the landmark of the header container of the corresponding sap.m.Page
control.
*
* If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text
* is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sHeaderLabel - New value for property headerLabel
* @returns {sap.m.PageAccessibleLandmarkInfo} Reference to this
in order to allow method chaining
*/
public setHeaderLabel(sHeaderLabel: string): sap.m.PageAccessibleLandmarkInfo;
/**
* Sets a new value for property {@link #getHeaderRole headerRole}.
*
* Landmark role of the header container of the corresponding sap.m.Page
control.
*
* If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Region
.
* @param {sap.ui.core.AccessibleLandmarkRole} sHeaderRole - New value for property headerRole
* @returns {sap.m.PageAccessibleLandmarkInfo} Reference to this
in order to allow method chaining
*/
public setHeaderRole(sHeaderRole: sap.ui.core.AccessibleLandmarkRole): sap.m.PageAccessibleLandmarkInfo;
/**
* Sets a new value for property {@link #getRootLabel rootLabel}.
*
* Texts which describes the landmark of the root container of the corresponding sap.m.Page
control.
*
* If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text
* is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sRootLabel - New value for property rootLabel
* @returns {sap.m.PageAccessibleLandmarkInfo} Reference to this
in order to allow method chaining
*/
public setRootLabel(sRootLabel: string): sap.m.PageAccessibleLandmarkInfo;
/**
* Sets a new value for property {@link #getRootRole rootRole}.
*
* Landmark role of the root container of the corresponding sap.m.Page
control.
*
* If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Region
.
* @param {sap.ui.core.AccessibleLandmarkRole} sRootRole - New value for property rootRole
* @returns {sap.m.PageAccessibleLandmarkInfo} Reference to this
in order to allow method chaining
*/
public setRootRole(sRootRole: sap.ui.core.AccessibleLandmarkRole): sap.m.PageAccessibleLandmarkInfo;
/**
* Sets a new value for property {@link #getSubHeaderLabel subHeaderLabel}.
*
* Texts which describes the landmark of the subheader container of the corresponding sap.m.Page
control.
*
* If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text
* is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sSubHeaderLabel - New value for property subHeaderLabel
* @returns {sap.m.PageAccessibleLandmarkInfo} Reference to this
in order to allow method chaining
*/
public setSubHeaderLabel(sSubHeaderLabel: string): sap.m.PageAccessibleLandmarkInfo;
/**
* Sets a new value for property {@link #getSubHeaderRole subHeaderRole}.
*
* Landmark role of the subheader container of the corresponding sap.m.Page
control.
*
* If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.AccessibleLandmarkRole} sSubHeaderRole - New value for property subHeaderRole
* @returns {sap.m.PageAccessibleLandmarkInfo} Reference to this
in order to allow method chaining
*/
public setSubHeaderRole(sSubHeaderRole: sap.ui.core.AccessibleLandmarkRole): sap.m.PageAccessibleLandmarkInfo;
}
/**
* Available Page Background Design.
*/
export enum PageBackgroundDesign {
/**
* Page background color when a List is set as the Page content.
*/
List = "List",
/**
* A solid background color dependent on the theme.
*/
Solid = "Solid",
/**
* Standard Page background color.
*/
Standard = "Standard",
/**
* Transparent background for the page.
*/
Transparent = "Transparent",
}
/**
* Enables users to navigate between items/entities.
*/
export class PagingButton extends sap.ui.core.Control {
/**
* Constructor for a new PagingButton.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:positionChange positionChange} event of this sap.m.PagingButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PagingButton
itself.
*
* Fired when the current position is changed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PagingButton
itself
* @returns {sap.m.PagingButton} Reference to this
in order to allow method chaining
*/
public attachPositionChange(fnFunction: Function, oListener?: any): sap.m.PagingButton;
/**
* Attaches event handler fnFunction
to the {@link #event:positionChange positionChange} event of this sap.m.PagingButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PagingButton
itself.
*
* Fired when the current position is changed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PagingButton
itself
* @returns {sap.m.PagingButton} Reference to this
in order to allow method chaining
*/
public attachPositionChange(oData: any, fnFunction: Function, oListener?: any): sap.m.PagingButton;
/**
* Detaches event handler fnFunction
from the {@link #event:positionChange positionChange} event of this sap.m.PagingButton
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.PagingButton} Reference to this
in order to allow method chaining
*/
public detachPositionChange(fnFunction: Function, oListener: any): sap.m.PagingButton;
/**
* Creates a new subclass of class sap.m.PagingButton with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:positionChange positionChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.PagingButton} Reference to this
in order to allow method chaining
*/
protected firePositionChange(mParameters?: any): sap.m.PagingButton;
/**
* Gets current value of property {@link #getCount count}.
*
* Determines the total count of items/entities that the control navigates through.
* The minimum number of items/entities is 1.
*
* Default value is 1
.
* @returns {number} Value of property count
*/
public getCount(): number;
/**
* Returns a metadata object for class sap.m.PagingButton.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getNextButtonTooltip nextButtonTooltip}.
*
* Determines the tooltip of the next button.
*
* Default value is
.
* @returns {string} Value of property nextButtonTooltip
*/
public getNextButtonTooltip(): string;
/**
* Gets current value of property {@link #getPosition position}.
*
* Determines the current position in the items/entities that the control navigates through.
* Starting (minimum) number is 1.
*
* Default value is 1
.
* @returns {number} Value of property position
*/
public getPosition(): number;
/**
* Gets current value of property {@link #getPreviousButtonTooltip previousButtonTooltip}.
*
* Determines the tooltip of the previous button.
*
* Default value is
.
* @returns {string} Value of property previousButtonTooltip
*/
public getPreviousButtonTooltip(): string;
}
/**
* A container control which has a header and content.
* Overview
* The panel is a container for grouping and displaying information. It can be collapsed to save space on the screen.
* Guidelines:
*
* - Nesting two or more panels is not recommended.
* - Do not stack too many panels on one page.
*
* Structure
* A panel consists of a title bar with a header text or header toolbar, an info toolbar (optional), and a content area.
* Using the headerToolbar
aggregation, you can add a toolbar with any toolbar content (i.e. custom buttons, spacers, titles) inside the title bar.
*
* There are two types of panels: fixed and expandable. Expendable panels are enabled by the expandable
property.
* Furthermore you can define an expand animation with the property expandAnimation
.
* Usage
* When to use:
*
* - You need to group or display information and want to give users the option of hiding this information.
* - You want to show additional information on demand (for example, a panel could show optional input fields for an advanced search).
* - You want to create a panel with controls that do not require user interaction and are not part of a form. Depending on the usage, change the
accessibleRole
property from the default {@link sap.m.PanelAccessibleRole Form}
to {@link sap.m.PanelAccessibleRole Region}
or {@link sap.m.PanelAccessibleRole Complementary}
.
*
* Responsive Behavior
*
* - If the width of the panel is set to 100% (default), the panel and its children are resized responsively, depending on its parent container.
* - If the panel has a fixed defined height, it will take up the space, even if the panel is collapsed.
* - When the panel is expandable, an arrow icon (pointing to the right) appears in front of the header.
* - When the animation is activated, expand/collapse uses a smooth animation to open or close the content area.
* - When the panel expands/collapses, the arrow icon rotates 90 degrees clockwise/counter-clockwise.
* - When the height uses the default property
auto
, the height of the content area is automatically adjusted to match the height of its content.
* - When the height of the panel is set to a fixed size, the content area can be scrolled through.
*
*/
export class Panel extends sap.ui.core.Control {
/**
* Constructor for a new Panel.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.Panel} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.Panel;
/**
* Attaches event handler fnFunction
to the {@link #event:expand expand} event of this sap.m.Panel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Panel
itself.
*
* Indicates that the panel will expand or collapse.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Panel
itself
* @returns {sap.m.Panel} Reference to this
in order to allow method chaining
*/
public attachExpand(fnFunction: Function, oListener?: any): sap.m.Panel;
/**
* Attaches event handler fnFunction
to the {@link #event:expand expand} event of this sap.m.Panel
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Panel
itself.
*
* Indicates that the panel will expand or collapse.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Panel
itself
* @returns {sap.m.Panel} Reference to this
in order to allow method chaining
*/
public attachExpand(oData: any, fnFunction: Function, oListener?: any): sap.m.Panel;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.Panel} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.Panel;
/**
* Destroys the headerToolbar in the aggregation {@link #getHeaderToolbar headerToolbar}.
* @returns {sap.m.Panel} Reference to this
in order to allow method chaining
*/
public destroyHeaderToolbar(): sap.m.Panel;
/**
* Destroys the infoToolbar in the aggregation {@link #getInfoToolbar infoToolbar}.
* @returns {sap.m.Panel} Reference to this
in order to allow method chaining
*/
public destroyInfoToolbar(): sap.m.Panel;
/**
* Detaches event handler fnFunction
from the {@link #event:expand expand} event of this sap.m.Panel
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Panel} Reference to this
in order to allow method chaining
*/
public detachExpand(fnFunction: Function, oListener: any): sap.m.Panel;
/**
* Creates a new subclass of class sap.m.Panel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:expand expand} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Panel} Reference to this
in order to allow method chaining
*/
protected fireExpand(mParameters?: any): sap.m.Panel;
/**
* Gets current value of property {@link #getAccessibleRole accessibleRole}.
*
* This property is used to set the accessible aria role of the Panel.
* Depending on the usage you can change the role from the default Form
to Region
or Complementary
.
*
* Default value is Form
.
* @returns {sap.m.PanelAccessibleRole} Value of property accessibleRole
*/
public getAccessibleRole(): sap.m.PanelAccessibleRole;
/**
* Gets current value of property {@link #getBackgroundDesign backgroundDesign}.
*
* This property is used to set the background color of the Panel.
* Depending on the theme you can change the state of the background from "Solid" over "Translucent" to "Transparent".
*
* Default value is Translucent
.
* @returns {sap.m.BackgroundDesign} Value of property backgroundDesign
*/
public getBackgroundDesign(): sap.m.BackgroundDesign;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Determines the content of the Panel.
* The content will be visible only when the Panel is expanded.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getExpandable expandable}.
*
* Specifies whether the control is expandable.
* This allows for collapsing or expanding the infoToolbar (if available) and content of the Panel.
* Note: If expandable is set to false, the Panel will always be rendered expanded.
*
* Default value is false
.
* @returns {boolean} Value of property expandable
*/
public getExpandable(): boolean;
/**
* Gets current value of property {@link #getExpandAnimation expandAnimation}.
*
* Indicates whether the transition between the expanded and the collapsed state of the control is animated.
* By default the animation is enabled.
*
* Default value is true
.
* @returns {boolean} Value of property expandAnimation
*/
public getExpandAnimation(): boolean;
/**
* Gets current value of property {@link #getExpanded expanded}.
*
* Indicates whether the Panel is expanded or not.
* If expanded is set to true, then both the infoToolbar (if available) and the content are rendered.
* If expanded is set to false, then only the headerText or headerToolbar is rendered.
*
* Default value is false
.
* @returns {boolean} Value of property expanded
*/
public getExpanded(): boolean;
/**
* Gets current value of property {@link #getHeaderText headerText}.
*
* This property is used to set the header text of the Panel.
* The "headerText" is visible in both expanded and collapsed state.
* Note: This property is overwritten by the "headerToolbar" aggregation.
*
* Default value is
.
* @returns {string} Value of property headerText
*/
public getHeaderText(): string;
/**
* Gets content of aggregation {@link #getHeaderToolbar headerToolbar}.
*
* This aggregation allows the use of a custom Toolbar as header for the Panel.
* The "headerToolbar" is visible in both expanded and collapsed state.
* Use it when you want to add extra controls for user interactions in the header.
* Note: This aggregation overwrites "headerText" property.
* @returns {sap.m.Toolbar}
*/
public getHeaderToolbar(): sap.m.Toolbar;
/**
* Gets current value of property {@link #getHeight height}.
*
* Determines the Panel height.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets content of aggregation {@link #getInfoToolbar infoToolbar}.
*
* This aggregation allows the use of a custom Toolbar as information bar for the Panel.
* The "infoToolbar" is placed below the header and is visible only in expanded state.
* Use it when you want to show extra information to the user.
* @returns {sap.m.Toolbar}
*/
public getInfoToolbar(): sap.m.Toolbar;
/**
* Returns a metadata object for class sap.m.Panel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getWidth width}.
*
* Determines the Panel width.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.Panel} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.Panel;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets the accessibleRole property of the control.
* @param {sap.m.PanelAccessibleRole} sRole - Defines the aria role of the control.
* @returns {sap.m.Panel} Pointer to the control instance to allow method chaining.
*/
public setAccessibleRole(sRole: sap.m.PanelAccessibleRole): sap.m.Panel;
/**
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
*
* This property is used to set the background color of the Panel.
* Depending on the theme you can change the state of the background from "Solid" over "Translucent" to "Transparent".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Translucent
.
* @param {sap.m.BackgroundDesign} sBackgroundDesign - New value for property backgroundDesign
* @returns {sap.m.Panel} Reference to this
in order to allow method chaining
*/
public setBackgroundDesign(sBackgroundDesign: sap.m.BackgroundDesign): sap.m.Panel;
/**
* Sets the expandable property of the control.
* @param {boolean} bExpandable - Defines whether the control is expandable or not.
* @returns {sap.m.Panel} Pointer to the control instance to allow method chaining.
*/
public setExpandable(bExpandable: boolean): sap.m.Panel;
/**
* Sets a new value for property {@link #getExpandAnimation expandAnimation}.
*
* Indicates whether the transition between the expanded and the collapsed state of the control is animated.
* By default the animation is enabled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bExpandAnimation - New value for property expandAnimation
* @returns {sap.m.Panel} Reference to this
in order to allow method chaining
*/
public setExpandAnimation(bExpandAnimation: boolean): sap.m.Panel;
/**
* Sets the expanded property of the control.
* @param {boolean} bExpanded - Defines whether control is expanded or not.
* @returns {sap.m.Panel} Pointer to the control instance to allow method chaining.
*/
public setExpanded(bExpanded: boolean): sap.m.Panel;
/**
* Sets a new value for property {@link #getHeaderText headerText}.
*
* This property is used to set the header text of the Panel.
* The "headerText" is visible in both expanded and collapsed state.
* Note: This property is overwritten by the "headerToolbar" aggregation.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sHeaderText - New value for property headerText
* @returns {sap.m.Panel} Reference to this
in order to allow method chaining
*/
public setHeaderText(sHeaderText: string): sap.m.Panel;
/**
* Sets the aggregated {@link #getHeaderToolbar headerToolbar}.
* @param {sap.m.Toolbar} oHeaderToolbar - The headerToolbar to set
* @returns {sap.m.Panel} Reference to this
in order to allow method chaining
*/
public setHeaderToolbar(oHeaderToolbar: sap.m.Toolbar): sap.m.Panel;
/**
* Sets the height of the panel.
* @param {sap.ui.core.CSSSize} sHeight - The height of the panel as CSS size.
* @returns {sap.m.Panel} Pointer to the control instance to allow method chaining.
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.m.Panel;
/**
* Sets the aggregated {@link #getInfoToolbar infoToolbar}.
* @param {sap.m.Toolbar} oInfoToolbar - The infoToolbar to set
* @returns {sap.m.Panel} Reference to this
in order to allow method chaining
*/
public setInfoToolbar(oInfoToolbar: sap.m.Toolbar): sap.m.Panel;
/**
* Sets the width of the panel.
* @param {sap.ui.core.CSSSize} sWidth - The width of the Panel as CSS size.
* @returns {sap.m.Panel} Pointer to the control instance to allow method chaining.
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.Panel;
}
/**
* Available Panel Accessible Landmark Roles.
*/
export enum PanelAccessibleRole {
/**
* Represents the ARIA role complementary
.
* A section of the page, designed to be complementary to the main content at a similar level in the DOM hierarchy.
*/
Complementary = "Complementary",
/**
* Represents the ARIA role Form
.
* A landmark region that contains a collection of items and objects that, as a whole, create a form.
*/
Form = "Form",
/**
* Represents the ARIA role Region
.
* A section of a page, that is important enough to be included in a page summary or table of contents.
*/
Region = "Region",
}
/**
* This control enables you to display PDF documents within your app.
* It can be embedded in your user interface layout, or you can set it to open in a popup dialog.
*/
export class PDFViewer extends sap.ui.core.Control {
/**
* Definition of PDFViewer control
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some popupButton to the aggregation {@link #getPopupButtons popupButtons}.
* @param {sap.m.Button} oPopupButton - the popupButton to add; if empty, nothing is inserted
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public addPopupButton(oPopupButton: sap.m.Button): sap.m.PDFViewer;
/**
* Attaches event handler fnFunction
to the {@link #event:error error} event of this sap.m.PDFViewer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PDFViewer
itself.
*
* This event is fired when there is an error loading the PDF file.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PDFViewer
itself
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public attachError(fnFunction: Function, oListener?: any): sap.m.PDFViewer;
/**
* Attaches event handler fnFunction
to the {@link #event:error error} event of this sap.m.PDFViewer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PDFViewer
itself.
*
* This event is fired when there is an error loading the PDF file.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PDFViewer
itself
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public attachError(oData: any, fnFunction: Function, oListener?: any): sap.m.PDFViewer;
/**
* Attaches event handler fnFunction
to the {@link #event:loaded loaded} event of this sap.m.PDFViewer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PDFViewer
itself.
*
* This event is fired when a PDF file is loaded. If the PDF is loaded in smaller chunks,
* this event is fired as often as defined by the browser's plugin. This may happen after
* a couple chunks are processed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PDFViewer
itself
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public attachLoaded(fnFunction: Function, oListener?: any): sap.m.PDFViewer;
/**
* Attaches event handler fnFunction
to the {@link #event:loaded loaded} event of this sap.m.PDFViewer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PDFViewer
itself.
*
* This event is fired when a PDF file is loaded. If the PDF is loaded in smaller chunks,
* this event is fired as often as defined by the browser's plugin. This may happen after
* a couple chunks are processed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PDFViewer
itself
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public attachLoaded(oData: any, fnFunction: Function, oListener?: any): sap.m.PDFViewer;
/**
* Attaches event handler fnFunction
to the {@link #event:sourceValidationFailed sourceValidationFailed} event of this sap.m.PDFViewer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PDFViewer
itself.
*
* This event is fired when the PDF viewer control cannot check the loaded content. For
* example, the default configuration of the Mozilla Firefox browser may not allow checking
* the loaded content. This may also happen when the source PDF file is stored in a different
* domain.
* If you want no error message to be displayed when this event is fired, call the
* preventDefault() method inside the event handler.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PDFViewer
itself
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public attachSourceValidationFailed(fnFunction: Function, oListener?: any): sap.m.PDFViewer;
/**
* Attaches event handler fnFunction
to the {@link #event:sourceValidationFailed sourceValidationFailed} event of this sap.m.PDFViewer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PDFViewer
itself.
*
* This event is fired when the PDF viewer control cannot check the loaded content. For
* example, the default configuration of the Mozilla Firefox browser may not allow checking
* the loaded content. This may also happen when the source PDF file is stored in a different
* domain.
* If you want no error message to be displayed when this event is fired, call the
* preventDefault() method inside the event handler.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PDFViewer
itself
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public attachSourceValidationFailed(oData: any, fnFunction: Function, oListener?: any): sap.m.PDFViewer;
/**
* Destroys the errorPlaceholder in the aggregation {@link #getErrorPlaceholder errorPlaceholder}.
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public destroyErrorPlaceholder(): sap.m.PDFViewer;
/**
* Destroys all the popupButtons in the aggregation {@link #getPopupButtons popupButtons}.
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public destroyPopupButtons(): sap.m.PDFViewer;
/**
* Detaches event handler fnFunction
from the {@link #event:error error} event of this sap.m.PDFViewer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public detachError(fnFunction: Function, oListener: any): sap.m.PDFViewer;
/**
* Detaches event handler fnFunction
from the {@link #event:loaded loaded} event of this sap.m.PDFViewer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public detachLoaded(fnFunction: Function, oListener: any): sap.m.PDFViewer;
/**
* Detaches event handler fnFunction
from the {@link #event:sourceValidationFailed sourceValidationFailed} event of this sap.m.PDFViewer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public detachSourceValidationFailed(fnFunction: Function, oListener: any): sap.m.PDFViewer;
/**
* Downloads the PDF file.
*/
public downloadPDF(): void;
/**
* Creates a new subclass of class sap.m.PDFViewer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:error error} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
protected fireError(mParameters?: any): sap.m.PDFViewer;
/**
* Fires event {@link #event:loaded loaded} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
protected fireLoaded(mParameters?: any): sap.m.PDFViewer;
/**
* Fires event {@link #event:sourceValidationFailed sourceValidationFailed} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
protected fireSourceValidationFailed(mParameters?: any): sap.m.PDFViewer;
/**
* Gets current value of property {@link #getErrorMessage errorMessage}.
*
* A custom error message that is displayed when the PDF file cannot be loaded.
* @returns {string} Value of property errorMessage
*/
public getErrorMessage(): string;
/**
* Gets content of aggregation {@link #getErrorPlaceholder errorPlaceholder}.
*
* A custom control that can be used instead of the error message specified by the
* errorPlaceholderMessage property.
* @returns {sap.ui.core.Control}
*/
public getErrorPlaceholder(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getErrorPlaceholderMessage errorPlaceholderMessage}.
*
* A custom text that is displayed instead of the PDF file content when the PDF
* file cannot be loaded.
* @returns {string} Value of property errorPlaceholderMessage
*/
public getErrorPlaceholderMessage(): string;
/**
* Gets current value of property {@link #getHeight height}.
*
* Defines the height of the PDF viewer control, respective to the height of
* the parent container. Can be set to a percent, pixel, or em value.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.m.PDFViewer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getPopupButtons popupButtons}.
*
* A multiple aggregation for buttons that can be added to the footer of the popup
* dialog. Works only if the PDF viewer is set to open in a popup dialog.
* @returns {sap.m.Button[]}
*/
public getPopupButtons(): sap.m.Button[];
/**
* Gets current value of property {@link #getPopupHeaderTitle popupHeaderTitle}.
*
* A custom title for the PDF viewer popup dialog. Works only if the PDF viewer
* is set to open in a popup dialog.
* @returns {string} Value of property popupHeaderTitle
*/
public getPopupHeaderTitle(): string;
/**
* Gets current value of property {@link #getShowDownloadButton showDownloadButton}.
*
* Shows or hides the download button.
*
* Default value is true
.
* @returns {boolean} Value of property showDownloadButton
*/
public getShowDownloadButton(): boolean;
/**
* Gets current value of property {@link #getSource source}.
*
* Specifies the path to the PDF file to display. Can be set to a relative or
* an absolute path.
* @returns {sap.ui.core.URI} Value of property source
*/
public getSource(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getTitle title}.
*
* A custom title for the PDF viewer.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the PDF viewer control, respective to the width of the
* parent container. Can be set to a percent, pixel, or em value.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.m.Button
in the aggregation {@link #getPopupButtons popupButtons}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Button} oPopupButton - The popupButton whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfPopupButton(oPopupButton: sap.m.Button): number;
/**
* Inserts a popupButton into the aggregation {@link #getPopupButtons popupButtons}.
* @param {sap.m.Button} oPopupButton - the popupButton to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the popupButton should be inserted at; for a negative value of iIndex
, the popupButton is inserted at position 0; for a value greater than the current size of the aggregation, the popupButton is inserted at the last position
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public insertPopupButton(oPopupButton: sap.m.Button, iIndex: number): sap.m.PDFViewer;
/**
* Triggers rerendering of this element and its children.
* @param {sap.ui.base.ManagedObject} oOrigin - Child control for which the method was called
*/
public invalidate(oOrigin?: sap.ui.base.ManagedObject): void;
/**
* Opens the PDF viewer in a popup dialog.
*/
public open(): void;
/**
* Removes all the controls from the aggregation {@link #getPopupButtons popupButtons}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Button[]} An array of the removed elements (might be empty)
*/
public removeAllPopupButtons(): sap.m.Button[];
/**
* Removes a popupButton from the aggregation {@link #getPopupButtons popupButtons}.
* @param {number|string|sap.m.Button} vPopupButton - The popupButton to remove or its index or id
* @returns {sap.m.Button} The removed popupButton or null
*/
public removePopupButton(vPopupButton: number|string|sap.m.Button): sap.m.Button;
/**
* Sets a new value for property {@link #getErrorMessage errorMessage}.
*
* A custom error message that is displayed when the PDF file cannot be loaded.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sErrorMessage - New value for property errorMessage
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public setErrorMessage(sErrorMessage: string): sap.m.PDFViewer;
/**
* Sets the aggregated {@link #getErrorPlaceholder errorPlaceholder}.
* @param {sap.ui.core.Control} oErrorPlaceholder - The errorPlaceholder to set
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public setErrorPlaceholder(oErrorPlaceholder: sap.ui.core.Control): sap.m.PDFViewer;
/**
* Sets a new value for property {@link #getErrorPlaceholderMessage errorPlaceholderMessage}.
*
* A custom text that is displayed instead of the PDF file content when the PDF
* file cannot be loaded.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sErrorPlaceholderMessage - New value for property errorPlaceholderMessage
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public setErrorPlaceholderMessage(sErrorPlaceholderMessage: string): sap.m.PDFViewer;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Defines the height of the PDF viewer control, respective to the height of
* the parent container. Can be set to a percent, pixel, or em value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.m.PDFViewer;
/**
* Sets a new value for property {@link #getPopupHeaderTitle popupHeaderTitle}.
*
* A custom title for the PDF viewer popup dialog. Works only if the PDF viewer
* is set to open in a popup dialog.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sPopupHeaderTitle - New value for property popupHeaderTitle
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public setPopupHeaderTitle(sPopupHeaderTitle: string): sap.m.PDFViewer;
/**
* Sets a new value for property {@link #getShowDownloadButton showDownloadButton}.
*
* Shows or hides the download button.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowDownloadButton - New value for property showDownloadButton
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public setShowDownloadButton(bShowDownloadButton: boolean): sap.m.PDFViewer;
/**
* Sets a new value for property {@link #getSource source}.
*
* Specifies the path to the PDF file to display. Can be set to a relative or
* an absolute path.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sSource - New value for property source
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public setSource(sSource: sap.ui.core.URI): sap.m.PDFViewer;
/**
* Sets a new value for property {@link #getTitle title}.
*
* A custom title for the PDF viewer.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.PDFViewer;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the PDF viewer control, respective to the width of the
* parent container. Can be set to a percent, pixel, or em value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.PDFViewer} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.PDFViewer;
}
/**
* Types for the placement of popover control.
*/
export enum PlacementType {
/**
* Popover will be placed automatically at the reference control.
*/
Auto = "Auto",
/**
* Popover will be placed at the bottom of the reference control.
*/
Bottom = "Bottom",
/**
* Popover will be placed at the right or left side of the reference control.
*/
Horizontal = "Horizontal",
/**
* Deprecated - use sap.m.PlacementType.HorizontalPreferredLeft
type.
*/
HorizontalPreferedLeft = "HorizontalPreferedLeft",
/**
* Deprecated - use sap.m.PlacementType.HorizontalPreferredRight
type.
*/
HorizontalPreferedRight = "HorizontalPreferedRight",
/**
* Popover will be placed at the right or left side of the reference control but will try to position on the
* left side if the space is greater than the Popover's width.
*/
HorizontalPreferredLeft = "HorizontalPreferredLeft",
/**
* Popover will be placed at the right or left side of the reference control but will try to position on the
* right side if the space is greater than the Popover's width.
*/
HorizontalPreferredRight = "HorizontalPreferredRight",
/**
* Popover will be placed at the left side of the reference control.
*/
Left = "Left",
/**
* Popover will be placed to the bottom of the reference control. If the available space is less than the Popover's height,
* it will appear to the top of the same reference control bottom border.
*/
PreferredBottomOrFlip = "PreferredBottomOrFlip",
/**
* Popover will be placed to the left of the reference control. If the available space is less than the Popover's width,
* it will appear to the right of the same reference control left border.
*/
PreferredLeftOrFlip = "PreferredLeftOrFlip",
/**
* Popover will be placed to the right of the reference control. If the available space is less than the Popover's width,
* it will appear to the left of the same reference control right border.
*/
PreferredRightOrFlip = "PreferredRightOrFlip",
/**
* Popover will be placed to the top of the reference control. If the available space is less than the Popover's height,
* it will appear to the bottom of the same reference control top border.
*/
PreferredTopOrFlip = "PreferredTopOrFlip",
/**
* Popover will be placed at the right side of the reference control.
*/
Right = "Right",
/**
* Popover will be placed at the top of the reference control.
*/
Top = "Top",
/**
* Popover will be placed at the top or bottom of the reference control.
*/
Vertical = "Vertical",
/**
* Deprecated - use sap.m.PlacementType.VerticalPreferredBottom
type.
*/
VerticalPreferedBottom = "VerticalPreferedBottom",
/**
* Deprecated - use sap.m.PlacementType.VerticalPreferredTop
type.
*/
VerticalPreferedTop = "VerticalPreferedTop",
/**
* Popover will be placed at the top or bottom of the reference control but will try to position on the
* bottom side if the space is greater than the Popover's height.
*/
VerticalPreferredBottom = "VerticalPreferredBottom",
/**
* Popover will be placed at the top or bottom of the reference control but will try to position on the
* top side if the space is greater than the Popover's height.
*/
VerticalPreferredTop = "VerticalPreferredTop",
}
/**
* Displays rows with appointments for different entities (such as persons or teams) for the selected time interval.
*
* Overview
*
* You can use the PlanningCalendar
to represent a calendar containing multiple rows with
* appointments, where each row represents a different person.
*
* You can configure different time-interval views that the user can switch between, such as hours or days, and even
* a whole week/month. The available navigation allows the user to select a specific interval using a picker, or
* move to the previous/next interval using arrows.
*
* Note: The PlanningCalendar
uses parts of the sap.ui.unified
library.
* This library will be loaded after the PlanningCalendar
, if it wasn't loaded first.
* This could lead to a waiting time when a PlanningCalendar
is used for the first time.
* To prevent this, apps that use the PlanningCalendar
should also load the
* sap.ui.unified
library.
*
* Usage
*
* The PlanningCalendar
has the following structure from top to bottom:
*
*
* - A toolbar where you can add your own buttons or other controls using the
toolbarContent
aggregation.
* - A header containing a drop-down menu for selecting the {@link sap.m.PlanningCalendarView PlanningCalendarViews},
* and navigation for moving through the intervals using arrows or selecting a specific interval with a picker.
* Custom views can be configured using the
views
aggregation. If not configured, the following set of default
* built-in views is available - Hours, Days, 1 Week, 1 Month, and Months. Setting a custom view(s) replaces the built-in ones.
* - The rows of the
PlanningCalendar
that contain the the assigned appointments.
* They can be configured with the rows
aggregation, which is of type
* {@link sap.m.PlanningCalendarRow PlanningCalendarRow}.
*
*
* Since 1.48 the empty space in the cell that is below an appointment can be removed by adding
* the sapUiCalendarAppFitVertically
CSS class to the PlanningCalendar
.
* Please note that it should be used only for a PlanningCalendar
with one appointment per day
* for a row that doesn't have interval headers set.
*
* Since 1.44 alternating row colors can be suppressed by adding the sapMPlanCalSuppressAlternatingRowColors
* CSS class to the PlanningCalendar
.
*
* Responsive behavior
*
* You can define the number of displayed intervals based on the size of the PlanningCalendar
using the
* {@link sap.m.PlanningCalendarView PlanningCalendarView}'s properties.
*/
export class PlanningCalendar extends sap.ui.core.Control {
/**
* Constructor for a new PlanningCalendar
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sID - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sID?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.PlanningCalendar;
/**
* Adds some row to the aggregation {@link #getRows rows}.
* @param {sap.m.PlanningCalendarRow} oRow - the row to add; if empty, nothing is inserted
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public addRow(oRow: sap.m.PlanningCalendarRow): sap.m.PlanningCalendar;
/**
* Adds some specialDate to the aggregation {@link #getSpecialDates specialDates}.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to add; if empty, nothing is inserted
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public addSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): sap.m.PlanningCalendar;
/**
* Adds some toolbarContent to the aggregation {@link #getToolbarContent toolbarContent}.
* @param {sap.ui.core.Control} oToolbarContent - the toolbarContent to add; if empty, nothing is inserted
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public addToolbarContent(oToolbarContent: sap.ui.core.Control): sap.m.PlanningCalendar;
/**
* Adds some view to the aggregation {@link #getViews views}.
* @param {sap.m.PlanningCalendarView} oView - the view to add; if empty, nothing is inserted
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public addView(oView: sap.m.PlanningCalendarView): sap.m.PlanningCalendar;
/**
* Attaches event handler fnFunction
to the {@link #event:appointmentSelect appointmentSelect} event of this sap.m.PlanningCalendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PlanningCalendar
itself.
*
* Fired if an appointment is selected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PlanningCalendar
itself
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public attachAppointmentSelect(fnFunction: Function, oListener?: any): sap.m.PlanningCalendar;
/**
* Attaches event handler fnFunction
to the {@link #event:appointmentSelect appointmentSelect} event of this sap.m.PlanningCalendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PlanningCalendar
itself.
*
* Fired if an appointment is selected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PlanningCalendar
itself
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public attachAppointmentSelect(oData: any, fnFunction: Function, oListener?: any): sap.m.PlanningCalendar;
/**
* Attaches event handler fnFunction
to the {@link #event:intervalSelect intervalSelect} event of this sap.m.PlanningCalendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PlanningCalendar
itself.
*
* Fired if an interval was selected in the calendar header or in the row.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PlanningCalendar
itself
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public attachIntervalSelect(fnFunction: Function, oListener?: any): sap.m.PlanningCalendar;
/**
* Attaches event handler fnFunction
to the {@link #event:intervalSelect intervalSelect} event of this sap.m.PlanningCalendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PlanningCalendar
itself.
*
* Fired if an interval was selected in the calendar header or in the row.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PlanningCalendar
itself
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public attachIntervalSelect(oData: any, fnFunction: Function, oListener?: any): sap.m.PlanningCalendar;
/**
* Attaches event handler fnFunction
to the {@link #event:rowHeaderClick rowHeaderClick} event of this sap.m.PlanningCalendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PlanningCalendar
itself.
*
* Fires when a row header is clicked.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PlanningCalendar
itself
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public attachRowHeaderClick(fnFunction: Function, oListener?: any): sap.m.PlanningCalendar;
/**
* Attaches event handler fnFunction
to the {@link #event:rowHeaderClick rowHeaderClick} event of this sap.m.PlanningCalendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PlanningCalendar
itself.
*
* Fires when a row header is clicked.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PlanningCalendar
itself
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public attachRowHeaderClick(oData: any, fnFunction: Function, oListener?: any): sap.m.PlanningCalendar;
/**
* Attaches event handler fnFunction
to the {@link #event:rowSelectionChange rowSelectionChange} event of this sap.m.PlanningCalendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PlanningCalendar
itself.
*
* Fires when row selection is changed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PlanningCalendar
itself
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public attachRowSelectionChange(fnFunction: Function, oListener?: any): sap.m.PlanningCalendar;
/**
* Attaches event handler fnFunction
to the {@link #event:rowSelectionChange rowSelectionChange} event of this sap.m.PlanningCalendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PlanningCalendar
itself.
*
* Fires when row selection is changed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PlanningCalendar
itself
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public attachRowSelectionChange(oData: any, fnFunction: Function, oListener?: any): sap.m.PlanningCalendar;
/**
* Attaches event handler fnFunction
to the {@link #event:startDateChange startDateChange} event of this sap.m.PlanningCalendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PlanningCalendar
itself.
*
* startDate
was changed while navigating in the PlanningCalendar
.
* The new value can be obtained using the sap.m.PlanningCalendar#getStartDate()
method.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PlanningCalendar
itself
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public attachStartDateChange(fnFunction: Function, oListener?: any): sap.m.PlanningCalendar;
/**
* Attaches event handler fnFunction
to the {@link #event:startDateChange startDateChange} event of this sap.m.PlanningCalendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PlanningCalendar
itself.
*
* startDate
was changed while navigating in the PlanningCalendar
.
* The new value can be obtained using the sap.m.PlanningCalendar#getStartDate()
method.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PlanningCalendar
itself
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public attachStartDateChange(oData: any, fnFunction: Function, oListener?: any): sap.m.PlanningCalendar;
/**
* Attaches event handler fnFunction
to the {@link #event:viewChange viewChange} event of this sap.m.PlanningCalendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PlanningCalendar
itself.
*
* viewKey
was changed by user interaction.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PlanningCalendar
itself
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public attachViewChange(fnFunction: Function, oListener?: any): sap.m.PlanningCalendar;
/**
* Attaches event handler fnFunction
to the {@link #event:viewChange viewChange} event of this sap.m.PlanningCalendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PlanningCalendar
itself.
*
* viewKey
was changed by user interaction.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PlanningCalendar
itself
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public attachViewChange(oData: any, fnFunction: Function, oListener?: any): sap.m.PlanningCalendar;
/**
* Destroys all the rows in the aggregation {@link #getRows rows}.
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public destroyRows(): sap.m.PlanningCalendar;
/**
* Destroys all the specialDates in the aggregation {@link #getSpecialDates specialDates}.
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public destroySpecialDates(): sap.m.PlanningCalendar;
/**
* Destroys all the toolbarContent in the aggregation {@link #getToolbarContent toolbarContent}.
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public destroyToolbarContent(): sap.m.PlanningCalendar;
/**
* Destroys all the views in the aggregation {@link #getViews views}.
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public destroyViews(): sap.m.PlanningCalendar;
/**
* Detaches event handler fnFunction
from the {@link #event:appointmentSelect appointmentSelect} event of this sap.m.PlanningCalendar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public detachAppointmentSelect(fnFunction: Function, oListener: any): sap.m.PlanningCalendar;
/**
* Detaches event handler fnFunction
from the {@link #event:intervalSelect intervalSelect} event of this sap.m.PlanningCalendar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public detachIntervalSelect(fnFunction: Function, oListener: any): sap.m.PlanningCalendar;
/**
* Detaches event handler fnFunction
from the {@link #event:rowHeaderClick rowHeaderClick} event of this sap.m.PlanningCalendar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public detachRowHeaderClick(fnFunction: Function, oListener: any): sap.m.PlanningCalendar;
/**
* Detaches event handler fnFunction
from the {@link #event:rowSelectionChange rowSelectionChange} event of this sap.m.PlanningCalendar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public detachRowSelectionChange(fnFunction: Function, oListener: any): sap.m.PlanningCalendar;
/**
* Detaches event handler fnFunction
from the {@link #event:startDateChange startDateChange} event of this sap.m.PlanningCalendar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public detachStartDateChange(fnFunction: Function, oListener: any): sap.m.PlanningCalendar;
/**
* Detaches event handler fnFunction
from the {@link #event:viewChange viewChange} event of this sap.m.PlanningCalendar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public detachViewChange(fnFunction: Function, oListener: any): sap.m.PlanningCalendar;
/**
* Creates a new subclass of class sap.m.PlanningCalendar with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:appointmentSelect appointmentSelect} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
protected fireAppointmentSelect(mParameters?: any): sap.m.PlanningCalendar;
/**
* Fires event {@link #event:intervalSelect intervalSelect} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
protected fireIntervalSelect(mParameters?: any): sap.m.PlanningCalendar;
/**
* Fires event {@link #event:rowHeaderClick rowHeaderClick} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
protected fireRowHeaderClick(mParameters?: any): sap.m.PlanningCalendar;
/**
* Fires event {@link #event:rowSelectionChange rowSelectionChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
protected fireRowSelectionChange(mParameters?: any): sap.m.PlanningCalendar;
/**
* Fires event {@link #event:startDateChange startDateChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
protected fireStartDateChange(mParameters?: any): sap.m.PlanningCalendar;
/**
* Fires event {@link #event:viewChange viewChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
protected fireViewChange(mParameters?: any): sap.m.PlanningCalendar;
/**
* Gets current value of property {@link #getAppointmentsReducedHeight appointmentsReducedHeight}.
*
* Determines whether the appointments that have only title without text are rendered with smaller height.
*
* Note: On phone devices this property is ignored, appointments are always rendered in full height
* to facilitate touching.
*
* Default value is false
.
* @returns {boolean} Value of property appointmentsReducedHeight
*/
public getAppointmentsReducedHeight(): boolean;
/**
* Gets current value of property {@link #getAppointmentsVisualization appointmentsVisualization}.
*
* Determines how the appointments are visualized depending on the used theme.
*
* Default value is Standard
.
* @returns {sap.ui.unified.CalendarAppointmentVisualization} Value of property appointmentsVisualization
*/
public getAppointmentsVisualization(): sap.ui.unified.CalendarAppointmentVisualization;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getGroupAppointmentsMode groupAppointmentsMode}.
*
* Defines the mode in which the overlapping appointments are displayed.
*
* Note: This property takes effect, only if the intervalType
of the current calendar view
* is set to sap.ui.unified.CalendarIntervalType.Month
. On phone devices this property is ignored,
* and the default value is applied.
*
* Default value is Collapsed
.
* @returns {sap.ui.unified.GroupAppointmentsMode} Value of property groupAppointmentsMode
*/
public getGroupAppointmentsMode(): sap.ui.unified.GroupAppointmentsMode;
/**
* Gets current value of property {@link #getHeight height}.
*
* Specifies the height of the PlanningCalendar
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* ID of the element which is the current target of the association {@link #getLegend legend}, or null
.
* @returns {sap.ui.core.ID}
*/
public getLegend(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getMaxDate maxDate}.
*
* Defines the maximum date that can be displayed and selected in the PlanningCalendar
.
* This must be a JavaScript date object.
*
* Note: If the maxDate
is set to be before the current minDate
,
* the minDate
is set to the first date of the month in which the maxDate
belongs.
* @returns {any} Value of property maxDate
*/
public getMaxDate(): any;
/**
* Returns a metadata object for class sap.m.PlanningCalendar.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinDate minDate}.
*
* Defines the minimum date that can be displayed and selected in the PlanningCalendar
.
* This must be a JavaScript date object.
*
* Note: If the minDate
is set to be after the current maxDate
,
* the maxDate
is set to the last date of the month in which the minDate
belongs.
* @returns {any} Value of property minDate
*/
public getMinDate(): any;
/**
* Gets current value of property {@link #getNoDataText noDataText}.
*
* Defines the text that is displayed when no {@link sap.m.PlanningCalendarRow PlanningCalendarRows} are assigned.
* @returns {string} Value of property noDataText
*/
public getNoDataText(): string;
/**
* Gets content of aggregation {@link #getRows rows}.
*
* Rows of the PlanningCalendar
.
* @returns {sap.m.PlanningCalendarRow[]}
*/
public getRows(): sap.m.PlanningCalendarRow[];
/**
* Returns an array containing the selected rows. If no row is selected, an empty array is returned.
* @returns {sap.m.PlanningCalendarRow[]} selected rows
*/
public getSelectedRows(): sap.m.PlanningCalendarRow[];
/**
* Gets current value of property {@link #getShowEmptyIntervalHeaders showEmptyIntervalHeaders}.
*
* Determines whether the space (at the top of the intervals), where the assigned interval headers appear, should remain
* visible even when no interval headers are present in the visible time frame. If set to false
, this
* space would collapse/disappear when no interval headers are assigned.
*
* Note: This property takes effect, only if showIntervalHeaders
is also set to true
.
*
* Default value is true
.
* @returns {boolean} Value of property showEmptyIntervalHeaders
*/
public getShowEmptyIntervalHeaders(): boolean;
/**
* Gets current value of property {@link #getShowIntervalHeaders showIntervalHeaders}.
*
* Determines whether the assigned interval headers are displayed. You can assign them using the
* intervalHeaders
aggregation of the {@link sap.m.PlanningCalendarRow PlanningCalendarRow}.
*
* Note: If you set both showIntervalHeaders
and showEmptyIntervalHeaders
* properties to true
, the space (at the top of the intervals) where the assigned interval
* headers appear, will remain visible even if no interval headers are assigned.
*
* Default value is true
.
* @returns {boolean} Value of property showIntervalHeaders
*/
public getShowIntervalHeaders(): boolean;
/**
* Gets current value of property {@link #getShowRowHeaders showRowHeaders}.
*
* Determines whether the column containing the headers of the {@link sap.m.PlanningCalendarRow PlanningCalendarRows}
* is displayed.
*
* Default value is true
.
* @returns {boolean} Value of property showRowHeaders
*/
public getShowRowHeaders(): boolean;
/**
* Gets current value of property {@link #getSingleSelection singleSelection}.
*
* Determines whether only a single row can be selected.
*
* Default value is true
.
* @returns {boolean} Value of property singleSelection
*/
public getSingleSelection(): boolean;
/**
* Gets content of aggregation {@link #getSpecialDates specialDates}.
*
* Special days in the header calendar visualized as date range with a type.
*
* Note: If one day is assigned to more than one type, only the first type will be used.
* @returns {sap.ui.unified.DateTypeRange[]}
*/
public getSpecialDates(): sap.ui.unified.DateTypeRange[];
/**
* Gets current value of property {@link #getStartDate startDate}.
*
* Determines the start date of the row, as a JavaScript date object. The current date is used as default.
* @returns {any} Value of property startDate
*/
public getStartDate(): any;
/**
* Gets content of aggregation {@link #getToolbarContent toolbarContent}.
*
* The content of the toolbar.
* @returns {sap.ui.core.Control[]}
*/
public getToolbarContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getViewKey viewKey}.
*
* Defines the key of the PlanningCalendarView
used for the output.
*
* Note: The default value is set Hour
. If you are using your own views, the keys of these
* views should be used instead.
*
* Default value is sap.ui.unified.CalendarIntervalType.Hour
.
* @returns {string} Value of property viewKey
*/
public getViewKey(): string;
/**
* Gets content of aggregation {@link #getViews views}.
*
* Views of the PlanningCalendar
.
*
* Note: If not set, all the default views are available. Their keys are defined in
* {@link sap.ui.unified.CalendarIntervalType}.
* @returns {sap.m.PlanningCalendarView[]}
*/
public getViews(): sap.m.PlanningCalendarView[];
/**
* Gets current value of property {@link #getWidth width}.
*
* Specifies the width of the PlanningCalendar
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.m.PlanningCalendarRow
in the aggregation {@link #getRows rows}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.PlanningCalendarRow} oRow - The row whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfRow(oRow: sap.m.PlanningCalendarRow): number;
/**
* Checks for the provided sap.ui.unified.DateTypeRange
in the aggregation {@link #getSpecialDates specialDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - The specialDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getToolbarContent toolbarContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oToolbarContent - The toolbarContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfToolbarContent(oToolbarContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.m.PlanningCalendarView
in the aggregation {@link #getViews views}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.PlanningCalendarView} oView - The view whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfView(oView: sap.m.PlanningCalendarView): number;
/**
* Inserts a row into the aggregation {@link #getRows rows}.
* @param {sap.m.PlanningCalendarRow} oRow - the row to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the row should be inserted at; for a negative value of iIndex
, the row is inserted at position 0; for a value greater than the current size of the aggregation, the row is inserted at the last position
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public insertRow(oRow: sap.m.PlanningCalendarRow, iIndex: number): sap.m.PlanningCalendar;
/**
* Inserts a specialDate into the aggregation {@link #getSpecialDates specialDates}.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the specialDate should be inserted at; for a negative value of iIndex
, the specialDate is inserted at position 0; for a value greater than the current size of the aggregation, the specialDate is inserted at the last position
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public insertSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange, iIndex: number): sap.m.PlanningCalendar;
/**
* Inserts a toolbarContent into the aggregation {@link #getToolbarContent toolbarContent}.
* @param {sap.ui.core.Control} oToolbarContent - the toolbarContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the toolbarContent should be inserted at; for a negative value of iIndex
, the toolbarContent is inserted at position 0; for a value greater than the current size of the aggregation, the toolbarContent is inserted at the last position
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public insertToolbarContent(oToolbarContent: sap.ui.core.Control, iIndex: number): sap.m.PlanningCalendar;
/**
* Inserts a view into the aggregation {@link #getViews views}.
* @param {sap.m.PlanningCalendarView} oView - the view to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the view should be inserted at; for a negative value of iIndex
, the view is inserted at position 0; for a value greater than the current size of the aggregation, the view is inserted at the last position
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public insertView(oView: sap.m.PlanningCalendarView, iIndex: number): sap.m.PlanningCalendar;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getRows rows}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.PlanningCalendarRow[]} An array of the removed elements (might be empty)
*/
public removeAllRows(): sap.m.PlanningCalendarRow[];
/**
* Removes all the controls from the aggregation {@link #getSpecialDates specialDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.DateTypeRange[]} An array of the removed elements (might be empty)
*/
public removeAllSpecialDates(): sap.ui.unified.DateTypeRange[];
/**
* Removes all the controls from the aggregation {@link #getToolbarContent toolbarContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllToolbarContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getViews views}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.PlanningCalendarView[]} An array of the removed elements (might be empty)
*/
public removeAllViews(): sap.m.PlanningCalendarView[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a row from the aggregation {@link #getRows rows}.
* @param {number|string|sap.m.PlanningCalendarRow} vRow - The row to remove or its index or id
* @returns {sap.m.PlanningCalendarRow} The removed row or null
*/
public removeRow(vRow: number|string|sap.m.PlanningCalendarRow): sap.m.PlanningCalendarRow;
/**
* Removes a specialDate from the aggregation {@link #getSpecialDates specialDates}.
* @param {number|string|sap.ui.unified.DateTypeRange} vSpecialDate - The specialDate to remove or its index or id
* @returns {sap.ui.unified.DateTypeRange} The removed specialDate or null
*/
public removeSpecialDate(vSpecialDate: number|string|sap.ui.unified.DateTypeRange): sap.ui.unified.DateTypeRange;
/**
* Removes a toolbarContent from the aggregation {@link #getToolbarContent toolbarContent}.
* @param {number|string|sap.ui.core.Control} vToolbarContent - The toolbarContent to remove or its index or id
* @returns {sap.ui.core.Control} The removed toolbarContent or null
*/
public removeToolbarContent(vToolbarContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a view from the aggregation {@link #getViews views}.
* @param {number|string|sap.m.PlanningCalendarView} vView - The view to remove or its index or id
* @returns {sap.m.PlanningCalendarView} The removed view or null
*/
public removeView(vView: number|string|sap.m.PlanningCalendarView): sap.m.PlanningCalendarView;
/**
* Selects or deselects all PlanningCalendarRows
.
*
* Note: Selection only works if singleSelection
is set to false
.
* @param {boolean} bSelect - Indicator showing whether PlanningCalendarRows
should be selected or deselected
* @returns {sap.m.PlanningCalendar} this
to allow method chaining
*/
public selectAllRows(bSelect: boolean): sap.m.PlanningCalendar;
/**
* Sets a new value for property {@link #getAppointmentsReducedHeight appointmentsReducedHeight}.
*
* Determines whether the appointments that have only title without text are rendered with smaller height.
*
* Note: On phone devices this property is ignored, appointments are always rendered in full height
* to facilitate touching.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bAppointmentsReducedHeight - New value for property appointmentsReducedHeight
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public setAppointmentsReducedHeight(bAppointmentsReducedHeight: boolean): sap.m.PlanningCalendar;
/**
* Sets a new value for property {@link #getAppointmentsVisualization appointmentsVisualization}.
*
* Determines how the appointments are visualized depending on the used theme.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.ui.unified.CalendarAppointmentVisualization} sAppointmentsVisualization - New value for property appointmentsVisualization
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public setAppointmentsVisualization(sAppointmentsVisualization: sap.ui.unified.CalendarAppointmentVisualization): sap.m.PlanningCalendar;
/**
* Sets a new value for property {@link #getGroupAppointmentsMode groupAppointmentsMode}.
*
* Defines the mode in which the overlapping appointments are displayed.
*
* Note: This property takes effect, only if the intervalType
of the current calendar view
* is set to sap.ui.unified.CalendarIntervalType.Month
. On phone devices this property is ignored,
* and the default value is applied.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Collapsed
.
* @param {sap.ui.unified.GroupAppointmentsMode} sGroupAppointmentsMode - New value for property groupAppointmentsMode
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public setGroupAppointmentsMode(sGroupAppointmentsMode: sap.ui.unified.GroupAppointmentsMode): sap.m.PlanningCalendar;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Specifies the height of the PlanningCalendar
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.m.PlanningCalendar;
/**
* Sets the associated {@link #getLegend legend}.
* @param {sap.ui.core.ID|sap.ui.unified.CalendarLegend} oLegend - ID of an element which becomes the new target of this legend association; alternatively, an element instance may be given
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public setLegend(oLegend: sap.ui.core.ID|sap.ui.unified.CalendarLegend): sap.m.PlanningCalendar;
/**
* Sets a new value for property {@link #getMaxDate maxDate}.
*
* Defines the maximum date that can be displayed and selected in the PlanningCalendar
.
* This must be a JavaScript date object.
*
* Note: If the maxDate
is set to be before the current minDate
,
* the minDate
is set to the first date of the month in which the maxDate
belongs.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oMaxDate - New value for property maxDate
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public setMaxDate(oMaxDate: any): sap.m.PlanningCalendar;
/**
* Sets a new value for property {@link #getMinDate minDate}.
*
* Defines the minimum date that can be displayed and selected in the PlanningCalendar
.
* This must be a JavaScript date object.
*
* Note: If the minDate
is set to be after the current maxDate
,
* the maxDate
is set to the last date of the month in which the minDate
belongs.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oMinDate - New value for property minDate
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public setMinDate(oMinDate: any): sap.m.PlanningCalendar;
/**
* Sets a new value for property {@link #getNoDataText noDataText}.
*
* Defines the text that is displayed when no {@link sap.m.PlanningCalendarRow PlanningCalendarRows} are assigned.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sNoDataText - New value for property noDataText
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public setNoDataText(sNoDataText: string): sap.m.PlanningCalendar;
/**
* Sets a new value for property {@link #getShowEmptyIntervalHeaders showEmptyIntervalHeaders}.
*
* Determines whether the space (at the top of the intervals), where the assigned interval headers appear, should remain
* visible even when no interval headers are present in the visible time frame. If set to false
, this
* space would collapse/disappear when no interval headers are assigned.
*
* Note: This property takes effect, only if showIntervalHeaders
is also set to true
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowEmptyIntervalHeaders - New value for property showEmptyIntervalHeaders
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public setShowEmptyIntervalHeaders(bShowEmptyIntervalHeaders: boolean): sap.m.PlanningCalendar;
/**
* Sets a new value for property {@link #getShowIntervalHeaders showIntervalHeaders}.
*
* Determines whether the assigned interval headers are displayed. You can assign them using the
* intervalHeaders
aggregation of the {@link sap.m.PlanningCalendarRow PlanningCalendarRow}.
*
* Note: If you set both showIntervalHeaders
and showEmptyIntervalHeaders
* properties to true
, the space (at the top of the intervals) where the assigned interval
* headers appear, will remain visible even if no interval headers are assigned.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowIntervalHeaders - New value for property showIntervalHeaders
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public setShowIntervalHeaders(bShowIntervalHeaders: boolean): sap.m.PlanningCalendar;
/**
* Sets a new value for property {@link #getShowRowHeaders showRowHeaders}.
*
* Determines whether the column containing the headers of the {@link sap.m.PlanningCalendarRow PlanningCalendarRows}
* is displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowRowHeaders - New value for property showRowHeaders
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public setShowRowHeaders(bShowRowHeaders: boolean): sap.m.PlanningCalendar;
/**
* Sets a new value for property {@link #getSingleSelection singleSelection}.
*
* Determines whether only a single row can be selected.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bSingleSelection - New value for property singleSelection
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public setSingleSelection(bSingleSelection: boolean): sap.m.PlanningCalendar;
/**
* Sets the given date as start date. The current date is used as default.
* Depending on the current view the start date may be adjusted (for example, the week view shows always the first weekday
* of the same week as the given date).
* @param {Date} oStartDate - the date to set as sap.m.PlanningCalendar
startDate
. May be changed(adjusted) if property startDate
is adjusted. See remark about week view above.
* @returns {sap.m.PlanningCalendar}
*/
public setStartDate(oStartDate: Date): sap.m.PlanningCalendar;
/**
* Sets a new value for property {@link #getViewKey viewKey}.
*
* Defines the key of the PlanningCalendarView
used for the output.
*
* Note: The default value is set Hour
. If you are using your own views, the keys of these
* views should be used instead.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is sap.ui.unified.CalendarIntervalType.Hour
.
* @param {string} sViewKey - New value for property viewKey
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public setViewKey(sViewKey: string): sap.m.PlanningCalendar;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Specifies the width of the PlanningCalendar
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.PlanningCalendar} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.PlanningCalendar;
}
/**
* Row in the @link sap.m.PlanningCalendar}.
*
* This element holds the data of one row in the @link sap.m.PlanningCalendar}. Once the header information (e.g. person information)
* is assigned, the appointments are assigned.
*/
export class PlanningCalendarRow extends sap.ui.core.Element {
/**
* Constructor for a new PlanningCalendarRow
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some appointment to the aggregation {@link #getAppointments appointments}.
* @param {sap.ui.unified.CalendarAppointment} oAppointment - the appointment to add; if empty, nothing is inserted
* @returns {sap.m.PlanningCalendarRow} Reference to this
in order to allow method chaining
*/
public addAppointment(oAppointment: sap.ui.unified.CalendarAppointment): sap.m.PlanningCalendarRow;
/**
* Adds some intervalHeader to the aggregation {@link #getIntervalHeaders intervalHeaders}.
* @param {sap.ui.unified.CalendarAppointment} oIntervalHeader - the intervalHeader to add; if empty, nothing is inserted
* @returns {sap.m.PlanningCalendarRow} Reference to this
in order to allow method chaining
*/
public addIntervalHeader(oIntervalHeader: sap.ui.unified.CalendarAppointment): sap.m.PlanningCalendarRow;
/**
* Destroys all the appointments in the aggregation {@link #getAppointments appointments}.
* @returns {sap.m.PlanningCalendarRow} Reference to this
in order to allow method chaining
*/
public destroyAppointments(): sap.m.PlanningCalendarRow;
/**
* Destroys all the intervalHeaders in the aggregation {@link #getIntervalHeaders intervalHeaders}.
* @returns {sap.m.PlanningCalendarRow} Reference to this
in order to allow method chaining
*/
public destroyIntervalHeaders(): sap.m.PlanningCalendarRow;
/**
* Creates a new subclass of class sap.m.PlanningCalendarRow with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getAppointments appointments}.
*
* The appointments to be displayed in the row. Appointments that outside the visible time frame are not rendered.
*
* Note: For performance reasons, only appointments in the visible time range or nearby should be assigned.
* @returns {sap.ui.unified.CalendarAppointment[]}
*/
public getAppointments(): sap.ui.unified.CalendarAppointment[];
/**
* Gets current value of property {@link #getIcon icon}.
*
* Specifies the URI of an image or an icon registered in sap.ui.core.IconPool
.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets content of aggregation {@link #getIntervalHeaders intervalHeaders}.
*
* The appointments to be displayed at the top of the intervals (for example, for public holidays).
* Appointments outside the visible time frame are not rendered.
*
* Keep in mind that the intervalHeaders
should always fill whole intervals. If they are shorter or longer
* than one interval, they are not displayed.
*
* Note: For performance reasons, only appointments in the visible time range or nearby should be assigned.
* @returns {sap.ui.unified.CalendarAppointment[]}
*/
public getIntervalHeaders(): sap.ui.unified.CalendarAppointment[];
/**
* Gets current value of property {@link #getKey key}.
*
* Defines the identifier of the row.
* @returns {string} Value of property key
*/
public getKey(): string;
/**
* Returns a metadata object for class sap.m.PlanningCalendarRow.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getNonWorkingDays nonWorkingDays}.
*
* Determines whether the provided weekdays are displayed as non-working days.
* Valid values inside the array are from 0 to 6 (other values are ignored).
* If not set, the weekend defined in the locale settings is displayed as non-working days.
*
* Note: The non-working days are visualized if the intervalType
* property of the {@link sap.m.PlanningCalendarView} is set to Day
.
* @returns {number[]} Value of property nonWorkingDays
*/
public getNonWorkingDays(): number[];
/**
* Gets current value of property {@link #getNonWorkingHours nonWorkingHours}.
*
* Determines whether the provided hours are displayed as non-working hours.
* Valid values inside the array are from 0 to 23 (other values are ignored).
*
* Note: The non-working hours are visualized if intervalType
* property of the {@link sap.m.PlanningCalendarView} is set to Hour
.
* @returns {number[]} Value of property nonWorkingHours
*/
public getNonWorkingHours(): number[];
/**
* Gets current value of property {@link #getSelected selected}.
*
* Defines the selected state of the PlanningCalendarRow
.
*
* Note: Binding the selected
property in single selection modes may
* cause unwanted results if you have more than one selected row in your binding.
*
* Default value is false
.
* @returns {boolean} Value of property selected
*/
public getSelected(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* Defines the text of the header (for example, the department of the person).
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTitle title}.
*
* Defines the title of the header (for example, the name of the person).
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Checks for the provided sap.ui.unified.CalendarAppointment
in the aggregation {@link #getAppointments appointments}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.CalendarAppointment} oAppointment - The appointment whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAppointment(oAppointment: sap.ui.unified.CalendarAppointment): number;
/**
* Checks for the provided sap.ui.unified.CalendarAppointment
in the aggregation {@link #getIntervalHeaders intervalHeaders}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.CalendarAppointment} oIntervalHeader - The intervalHeader whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfIntervalHeader(oIntervalHeader: sap.ui.unified.CalendarAppointment): number;
/**
* Inserts a appointment into the aggregation {@link #getAppointments appointments}.
* @param {sap.ui.unified.CalendarAppointment} oAppointment - the appointment to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the appointment should be inserted at; for a negative value of iIndex
, the appointment is inserted at position 0; for a value greater than the current size of the aggregation, the appointment is inserted at the last position
* @returns {sap.m.PlanningCalendarRow} Reference to this
in order to allow method chaining
*/
public insertAppointment(oAppointment: sap.ui.unified.CalendarAppointment, iIndex: number): sap.m.PlanningCalendarRow;
/**
* Inserts a intervalHeader into the aggregation {@link #getIntervalHeaders intervalHeaders}.
* @param {sap.ui.unified.CalendarAppointment} oIntervalHeader - the intervalHeader to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the intervalHeader should be inserted at; for a negative value of iIndex
, the intervalHeader is inserted at position 0; for a value greater than the current size of the aggregation, the intervalHeader is inserted at the last position
* @returns {sap.m.PlanningCalendarRow} Reference to this
in order to allow method chaining
*/
public insertIntervalHeader(oIntervalHeader: sap.ui.unified.CalendarAppointment, iIndex: number): sap.m.PlanningCalendarRow;
/**
* Removes all the controls from the aggregation {@link #getAppointments appointments}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.CalendarAppointment[]} An array of the removed elements (might be empty)
*/
public removeAllAppointments(): sap.ui.unified.CalendarAppointment[];
/**
* Removes all the controls from the aggregation {@link #getIntervalHeaders intervalHeaders}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.CalendarAppointment[]} An array of the removed elements (might be empty)
*/
public removeAllIntervalHeaders(): sap.ui.unified.CalendarAppointment[];
/**
* Removes a appointment from the aggregation {@link #getAppointments appointments}.
* @param {number|string|sap.ui.unified.CalendarAppointment} vAppointment - The appointment to remove or its index or id
* @returns {sap.ui.unified.CalendarAppointment} The removed appointment or null
*/
public removeAppointment(vAppointment: number|string|sap.ui.unified.CalendarAppointment): sap.ui.unified.CalendarAppointment;
/**
* Removes a intervalHeader from the aggregation {@link #getIntervalHeaders intervalHeaders}.
* @param {number|string|sap.ui.unified.CalendarAppointment} vIntervalHeader - The intervalHeader to remove or its index or id
* @returns {sap.ui.unified.CalendarAppointment} The removed intervalHeader or null
*/
public removeIntervalHeader(vIntervalHeader: number|string|sap.ui.unified.CalendarAppointment): sap.ui.unified.CalendarAppointment;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Specifies the URI of an image or an icon registered in sap.ui.core.IconPool
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.PlanningCalendarRow} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.PlanningCalendarRow;
/**
* Sets a new value for property {@link #getKey key}.
*
* Defines the identifier of the row.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sKey - New value for property key
* @returns {sap.m.PlanningCalendarRow} Reference to this
in order to allow method chaining
*/
public setKey(sKey: string): sap.m.PlanningCalendarRow;
/**
* Sets a new value for property {@link #getNonWorkingDays nonWorkingDays}.
*
* Determines whether the provided weekdays are displayed as non-working days.
* Valid values inside the array are from 0 to 6 (other values are ignored).
* If not set, the weekend defined in the locale settings is displayed as non-working days.
*
* Note: The non-working days are visualized if the intervalType
* property of the {@link sap.m.PlanningCalendarView} is set to Day
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number[]} sNonWorkingDays - New value for property nonWorkingDays
* @returns {sap.m.PlanningCalendarRow} Reference to this
in order to allow method chaining
*/
public setNonWorkingDays(sNonWorkingDays: number[]): sap.m.PlanningCalendarRow;
/**
* Sets a new value for property {@link #getNonWorkingHours nonWorkingHours}.
*
* Determines whether the provided hours are displayed as non-working hours.
* Valid values inside the array are from 0 to 23 (other values are ignored).
*
* Note: The non-working hours are visualized if intervalType
* property of the {@link sap.m.PlanningCalendarView} is set to Hour
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number[]} sNonWorkingHours - New value for property nonWorkingHours
* @returns {sap.m.PlanningCalendarRow} Reference to this
in order to allow method chaining
*/
public setNonWorkingHours(sNonWorkingHours: number[]): sap.m.PlanningCalendarRow;
/**
* Sets a new value for property {@link #getSelected selected}.
*
* Defines the selected state of the PlanningCalendarRow
.
*
* Note: Binding the selected
property in single selection modes may
* cause unwanted results if you have more than one selected row in your binding.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSelected - New value for property selected
* @returns {sap.m.PlanningCalendarRow} Reference to this
in order to allow method chaining
*/
public setSelected(bSelected: boolean): sap.m.PlanningCalendarRow;
/**
* Sets a new value for property {@link #getText text}.
*
* Defines the text of the header (for example, the department of the person).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.m.PlanningCalendarRow} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.PlanningCalendarRow;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Defines the title of the header (for example, the name of the person).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.PlanningCalendarRow} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.PlanningCalendarRow;
}
/**
* View of the {@link sap.m.PlanningCalendar}.
*
* The PlanningCalendarView
defines the type of the intervals (hours, days, months)
* and how many intervals are displayed.
*/
export class PlanningCalendarView extends sap.ui.core.Element {
/**
* Constructor for a new PlanningCalendarView
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.PlanningCalendarView with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getDescription description}.
*
* Defines the description of the PlanningCalendarView
.
* @returns {string} Value of property description
*/
public getDescription(): string;
/**
* Gets current value of property {@link #getIntervalsL intervalsL}.
*
* Defines the number of intervals that are displayed for a {@link sap.m.PlanningCalendar} that is more than 1024 pixels wide.
*
* Default value is 12
.
* @returns {number} Value of property intervalsL
*/
public getIntervalsL(): number;
/**
* Gets current value of property {@link #getIntervalsM intervalsM}.
*
* Defines the number of intervals that are displayed for a {@link sap.m.PlanningCalendar} that is between 600 and 1024 pixels wide.
*
* Default value is 8
.
* @returns {number} Value of property intervalsM
*/
public getIntervalsM(): number;
/**
* Gets current value of property {@link #getIntervalsS intervalsS}.
*
* Defines the number of intervals that are displayed for a {@link sap.m.PlanningCalendar} that is less than 600 pixels wide.
*
* Default value is 6
.
* @returns {number} Value of property intervalsS
*/
public getIntervalsS(): number;
/**
* Gets current value of property {@link #getIntervalType intervalType}.
*
* Determines the type of the intervals of the row.
*
* Note: Not all predefined interval types are supported for this property. For more information, see the
* descriptions in the {@link sap.ui.unified.CalendarIntervalType CalendarIntervalType} enumeration.
*
* Default value is Hour
.
* @returns {sap.ui.unified.CalendarIntervalType} Value of property intervalType
*/
public getIntervalType(): sap.ui.unified.CalendarIntervalType;
/**
* Gets current value of property {@link #getKey key}.
*
* Defines the key of the view. This must be set to identify the used view in the
* {@link sap.m.PlanningCalendar}.
* @returns {string} Value of property key
*/
public getKey(): string;
/**
* Returns a metadata object for class sap.m.PlanningCalendarView.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowSubIntervals showSubIntervals}.
*
* If set, subintervals are displayed as lines in the rows.
*
*
* - Quarter hour subintervals for interval type
Hour
.
* - Hour subintervals for interval types
Day
, Week
and OneMonth
.
* - Day subintervals for interval type
Month
.
*
*
* Default value is false
.
* @returns {boolean} Value of property showSubIntervals
*/
public getShowSubIntervals(): boolean;
/**
* Sets a new value for property {@link #getDescription description}.
*
* Defines the description of the PlanningCalendarView
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sDescription - New value for property description
* @returns {sap.m.PlanningCalendarView} Reference to this
in order to allow method chaining
*/
public setDescription(sDescription: string): sap.m.PlanningCalendarView;
/**
* Sets a new value for property {@link #getIntervalsL intervalsL}.
*
* Defines the number of intervals that are displayed for a {@link sap.m.PlanningCalendar} that is more than 1024 pixels wide.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 12
.
* @param {number} iIntervalsL - New value for property intervalsL
* @returns {sap.m.PlanningCalendarView} Reference to this
in order to allow method chaining
*/
public setIntervalsL(iIntervalsL: number): sap.m.PlanningCalendarView;
/**
* Sets a new value for property {@link #getIntervalsM intervalsM}.
*
* Defines the number of intervals that are displayed for a {@link sap.m.PlanningCalendar} that is between 600 and 1024 pixels wide.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 8
.
* @param {number} iIntervalsM - New value for property intervalsM
* @returns {sap.m.PlanningCalendarView} Reference to this
in order to allow method chaining
*/
public setIntervalsM(iIntervalsM: number): sap.m.PlanningCalendarView;
/**
* Sets a new value for property {@link #getIntervalsS intervalsS}.
*
* Defines the number of intervals that are displayed for a {@link sap.m.PlanningCalendar} that is less than 600 pixels wide.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 6
.
* @param {number} iIntervalsS - New value for property intervalsS
* @returns {sap.m.PlanningCalendarView} Reference to this
in order to allow method chaining
*/
public setIntervalsS(iIntervalsS: number): sap.m.PlanningCalendarView;
/**
* Sets a new value for property {@link #getIntervalType intervalType}.
*
* Determines the type of the intervals of the row.
*
* Note: Not all predefined interval types are supported for this property. For more information, see the
* descriptions in the {@link sap.ui.unified.CalendarIntervalType CalendarIntervalType} enumeration.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Hour
.
* @param {sap.ui.unified.CalendarIntervalType} sIntervalType - New value for property intervalType
* @returns {sap.m.PlanningCalendarView} Reference to this
in order to allow method chaining
*/
public setIntervalType(sIntervalType: sap.ui.unified.CalendarIntervalType): sap.m.PlanningCalendarView;
/**
* Sets a new value for property {@link #getKey key}.
*
* Defines the key of the view. This must be set to identify the used view in the
* {@link sap.m.PlanningCalendar}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sKey - New value for property key
* @returns {sap.m.PlanningCalendarView} Reference to this
in order to allow method chaining
*/
public setKey(sKey: string): sap.m.PlanningCalendarView;
/**
* Sets a new value for property {@link #getShowSubIntervals showSubIntervals}.
*
* If set, subintervals are displayed as lines in the rows.
*
*
* - Quarter hour subintervals for interval type
Hour
.
* - Hour subintervals for interval types
Day
, Week
and OneMonth
.
* - Day subintervals for interval type
Month
.
*
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowSubIntervals - New value for property showSubIntervals
* @returns {sap.m.PlanningCalendarView} Reference to this
in order to allow method chaining
*/
public setShowSubIntervals(bShowSubIntervals: boolean): sap.m.PlanningCalendarView;
}
/**
* Defines the display of table pop-ins
*/
export enum PopinDisplay {
/**
* Inside the table popin, header is displayed at the first line and cell content is displayed at the next line.
*/
Block = "Block",
/**
* Inside the table popin, cell content is displayed next to the header in the same line. Note: If there is not enough space for the cell content then it jumps to the next line.
*/
Inline = "Inline",
/**
* Inside the table popin, only the cell content will be visible.
*/
WithoutHeader = "WithoutHeader",
}
/**
* Displays additional information for an object in a compact way.
*
* Overview
* The popover displays additional information for an object in a compact way and without leaving the page. The popover can contain various UI elements such as fields, tables, images, and charts. It can also include actions in the footer.
* Structure
* The popover has three main areas:
*
* - Header (optional) - with a back button and a title
* - Content - holds all the controls
* - Footer (optional) - with additional action buttons
*
* Guidelines
*
* - Do not overlap popovers.
* - You can determine the {@link sap.m.PlacementType placement} of the popover relative to the control that opens it.
* - Ensure that the content has a basic design and shows only the most important information.
*
* Usage
* When to use:
*
* - You need to define your own structure of controls within the popover.
*
* When not to use:
*
* - The {@link sap.m.QuickView QuickView} is more appropriate for your use case.
*
* Responsive Behavior
* The popover is closed when the user clicks or taps outside the popover or selects an action within the popover. You can prevent this with the modal
property.
* The popover can be resized when the resizable
property is enabled.
*
*
* - {@link sap.m.Popover} is not responsive on mobile devices - it will always be rendered as a popover and you have to take care of its size and position.
* - {@link sap.m.ResponsivePopover} is adaptive and responsive. It renders as a dialog with a close button in the header on phones, and as a popover on tablets.
*
*/
export class Popover extends sap.ui.core.Control {
/**
* Constructor for a new Popover.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Hook called after adjusment of the Popover position.
*/
protected _afterAdjustPositionAndArrowHook(): void;
/**
* If customHeader is set, this will return the customHeaer. Otherwise it creates a header and put the
* title and buttons if needed inside, and finally return this newly create header.
*/
protected _getAnyHeader(): void;
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Popover;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Popover;
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.Popover;
/**
* Attaches event handler fnFunction
to the {@link #event:afterClose afterClose} event of this sap.m.Popover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Popover
itself.
*
* This event will be fired after the popover is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Popover
itself
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public attachAfterClose(fnFunction: Function, oListener?: any): sap.m.Popover;
/**
* Attaches event handler fnFunction
to the {@link #event:afterClose afterClose} event of this sap.m.Popover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Popover
itself.
*
* This event will be fired after the popover is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Popover
itself
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public attachAfterClose(oData: any, fnFunction: Function, oListener?: any): sap.m.Popover;
/**
* Attaches event handler fnFunction
to the {@link #event:afterOpen afterOpen} event of this sap.m.Popover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Popover
itself.
*
* This event will be fired after the popover is opened.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Popover
itself
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public attachAfterOpen(fnFunction: Function, oListener?: any): sap.m.Popover;
/**
* Attaches event handler fnFunction
to the {@link #event:afterOpen afterOpen} event of this sap.m.Popover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Popover
itself.
*
* This event will be fired after the popover is opened.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Popover
itself
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public attachAfterOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.Popover;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.Popover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Popover
itself.
*
* This event will be fired before the popover is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Popover
itself
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public attachBeforeClose(fnFunction: Function, oListener?: any): sap.m.Popover;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.Popover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Popover
itself.
*
* This event will be fired before the popover is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Popover
itself
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public attachBeforeClose(oData: any, fnFunction: Function, oListener?: any): sap.m.Popover;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.Popover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Popover
itself.
*
* This event will be fired before the popover is opened.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Popover
itself
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(fnFunction: Function, oListener?: any): sap.m.Popover;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.Popover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Popover
itself.
*
* This event will be fired before the popover is opened.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Popover
itself
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.Popover;
/**
* Closes the popover when it's already opened.
* @returns {sap.m.Popover} Reference to the control instance for chaining
*/
public close(): sap.m.Popover;
/**
* Destroys the beginButton in the aggregation {@link #getBeginButton beginButton}.
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public destroyBeginButton(): sap.m.Popover;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.Popover;
/**
* Destroys the customHeader in the aggregation {@link #getCustomHeader customHeader}.
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public destroyCustomHeader(): sap.m.Popover;
/**
* Destroys the endButton in the aggregation {@link #getEndButton endButton}.
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public destroyEndButton(): sap.m.Popover;
/**
* Destroys the footer in the aggregation {@link #getFooter footer}.
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public destroyFooter(): sap.m.Popover;
/**
* Destroys the subHeader in the aggregation {@link #getSubHeader subHeader}.
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public destroySubHeader(): sap.m.Popover;
/**
* Detaches event handler fnFunction
from the {@link #event:afterClose afterClose} event of this sap.m.Popover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public detachAfterClose(fnFunction: Function, oListener: any): sap.m.Popover;
/**
* Detaches event handler fnFunction
from the {@link #event:afterOpen afterOpen} event of this sap.m.Popover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public detachAfterOpen(fnFunction: Function, oListener: any): sap.m.Popover;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeClose beforeClose} event of this sap.m.Popover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public detachBeforeClose(fnFunction: Function, oListener: any): sap.m.Popover;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeOpen beforeOpen} event of this sap.m.Popover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public detachBeforeOpen(fnFunction: Function, oListener: any): sap.m.Popover;
/**
* Creates a new subclass of class sap.m.Popover with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:afterClose afterClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
protected fireAfterClose(mParameters?: any): sap.m.Popover;
/**
* Fires event {@link #event:afterOpen afterOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
protected fireAfterOpen(mParameters?: any): sap.m.Popover;
/**
* Fires event {@link #event:beforeClose beforeClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
protected fireBeforeClose(mParameters?: any): sap.m.Popover;
/**
* Fires event {@link #event:beforeOpen beforeOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
protected fireBeforeOpen(mParameters?: any): sap.m.Popover;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets content of aggregation {@link #getBeginButton beginButton}.
*
* BeginButton is shown at the left side (right side in RTL mode) inside the header. When showHeader is set to false, the property is ignored.
* @returns {sap.ui.core.Control}
*/
public getBeginButton(): sap.ui.core.Control;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content inside the popover.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getContentHeight contentHeight}.
*
* Set the height of the content area inside Popover. When controls which adapt their size to the parent control are added directly into Popover, for example sap.m.Page control, a size needs to be specified to the content area of the Popover. Otherwise, Popover control isn't able to display the content in the right way. This values isn't necessary for controls added to Popover directly which can decide their size by themselves, for exmaple sap.m.List, sap.m.Image etc., only needed for controls that adapt their size to the parent control.
* @returns {sap.ui.core.CSSSize} Value of property contentHeight
*/
public getContentHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getContentMinWidth contentMinWidth}.
*
* Sets the minimum width of the content area inside popover.
*
* Default value is
.
* @returns {sap.ui.core.CSSSize} Value of property contentMinWidth
*/
public getContentMinWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getContentWidth contentWidth}.
*
* Set the width of the content area inside Popover. When controls which adapt their size to the parent control are added directly into Popover, for example sap.m.Page control, a size needs to be specified to the content area of the Popover. Otherwise, Popover control isn't able to display the content in the right way. This values isn't necessary for controls added to Popover directly which can decide their size by themselves, for exmaple sap.m.List, sap.m.Image etc., only needed for controls that adapt their size to the parent control.
* @returns {sap.ui.core.CSSSize} Value of property contentWidth
*/
public getContentWidth(): sap.ui.core.CSSSize;
/**
* Gets content of aggregation {@link #getCustomHeader customHeader}.
*
* Any control that needed to be displayed in the header area. When this is set, the showHeader property is ignored, and only this customHeader is shown on the top of popover.
* @returns {sap.ui.core.Control}
*/
public getCustomHeader(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getEnableScrolling enableScrolling}.
*
* This property is deprecated. Please use properties verticalScrolling and horizontalScrolling instead. If you still use this property it will be mapped on the new properties verticalScrolling and horizontalScrolling.
*
* Default value is true
.
* @returns {boolean} Value of property enableScrolling
*/
public getEnableScrolling(): boolean;
/**
* Gets content of aggregation {@link #getEndButton endButton}.
*
* EndButton is always shown at the right side (left side in RTL mode) inside the header. When showHeader is set to false, the property is ignored.
* @returns {sap.ui.core.Control}
*/
public getEndButton(): sap.ui.core.Control;
/**
* Gets content of aggregation {@link #getFooter footer}.
*
* This is optional footer which is shown on the bottom of the popover.
* @returns {sap.ui.core.Control}
*/
public getFooter(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getHorizontalScrolling horizontalScrolling}.
*
* This property indicates if user can scroll horizontally inside popover when the content is bigger than the content area. However, when scrollable control (sap.m.ScrollContainer, sap.m.Page) is in the popover, this property needs to be set to false to disable the scrolling in popover in order to make the scrolling in the child control work properly.
* Popover detects if there's sap.m.NavContainer, sap.m.Page, or sap.m.ScrollContainer as direct child added to Popover. If there is, Popover will turn off scrolling by setting this property to false automatically ignoring the existing value of this property.
*
* Default value is true
.
* @returns {boolean} Value of property horizontalScrolling
*/
public getHorizontalScrolling(): boolean;
/**
* ID of the element which is the current target of the association {@link #getInitialFocus initialFocus}, or null
.
* @returns {sap.ui.core.ID}
*/
public getInitialFocus(): sap.ui.core.ID;
/**
* ID of the element which is the current target of the association {@link #getLeftButton leftButton}, or null
.
* @returns {sap.ui.core.ID}
*/
public getLeftButton(): sap.ui.core.ID;
/**
* Returns a metadata object for class sap.m.Popover.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getModal modal}.
*
* If the popover will not be closed when tapping outside the popover. It also blocks any interaction with the background. The default value is false.
*
* Default value is false
.
* @returns {boolean} Value of property modal
*/
public getModal(): boolean;
/**
* Gets current value of property {@link #getOffsetX offsetX}.
*
* The offset for the popover placement in the x axis. It's with unit pixel.
*
* Default value is 0
.
* @returns {number} Value of property offsetX
*/
public getOffsetX(): number;
/**
* Gets current value of property {@link #getOffsetY offsetY}.
*
* The offset for the popover placement in the y axis. It's with unit pixel.
*
* Default value is 0
.
* @returns {number} Value of property offsetY
*/
public getOffsetY(): number;
/**
* Gets current value of property {@link #getPlacement placement}.
*
* This is the information about on which side will the popover be placed at. Possible values are sap.m.PlacementType.Left, sap.m.PlacementType.Right, sap.m.PlacementType.Top, sap.m.PlacementType.Bottom, sap.m.PlacementType.Horizontal, sap.m.PlacementType.HorizontalPreferredLeft, sap.m.PlacementType.HorizontalPreferredRight, sap.m.PlacementType.Vertical, sap.m.PlacementType.VerticalPreferredTop, sap.m.PlacementType.VerticalPreferredBottom, sap.m.PlacementType.Auto. The default value is sap.m.PlacementType.Right. Setting this property while popover is open won't cause any rerendering of the popover, but it will take effect when it's opened again.
*
* Default value is Right
.
* @returns {sap.m.PlacementType} Value of property placement
*/
public getPlacement(): sap.m.PlacementType;
/**
* Gets current value of property {@link #getResizable resizable}.
*
* Whether resize option is enabled.
*
* Default value is false
.
* @returns {boolean} Value of property resizable
*/
public getResizable(): boolean;
/**
* ID of the element which is the current target of the association {@link #getRightButton rightButton}, or null
.
* @returns {sap.ui.core.ID}
*/
public getRightButton(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getShowArrow showArrow}.
*
* Whether Popover arrow should be visible
*
* Default value is true
.
* @returns {boolean} Value of property showArrow
*/
public getShowArrow(): boolean;
/**
* Gets current value of property {@link #getShowHeader showHeader}.
*
* If a header should be shown at the top of the popover.
*
* Default value is true
.
* @returns {boolean} Value of property showHeader
*/
public getShowHeader(): boolean;
/**
* Gets content of aggregation {@link #getSubHeader subHeader}.
*
* When subHeader is assigned to Popover, it's rendered directly after the main header if there is, or at the beginning of Popover when there's no main header. SubHeader is out of the content area and won't be scrolled when content's size is bigger than the content area's size.
* @returns {sap.ui.core.Control}
*/
public getSubHeader(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getTitle title}.
*
* Title text appears in the header. This property will be ignored when showHeader is set to false.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getVerticalScrolling verticalScrolling}.
*
* This property indicates if user can scroll vertically inside popover when the content is bigger than the content area. However, when scrollable control (sap.m.ScrollContainer, sap.m.Page) is in the popover, this property needs to be set to false to disable the scrolling in popover in order to make the scrolling in the child control work properly.
* Popover detects if there's sap.m.NavContainer, sap.m.Page, or sap.m.ScrollContainer as direct child added to Popover. If there is, Popover will turn off scrolling by setting this property to false automatically ignoring the existing value of this property.
*
* Default value is true
.
* @returns {boolean} Value of property verticalScrolling
*/
public getVerticalScrolling(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.Popover;
/**
* The method checks if the Popover is open. It returns true when the Popover is currently open (this includes opening and closing animations), otherwise it returns false.
* @returns {boolean} whether the Popover is currently opened
*/
public isOpen(): boolean;
/**
* Opens the Popover and set the Popover position according to the {@link #getPlacement() placement} property around the oControl
parameter.
* @param {any} oControl - This is the control to which the Popover will be placed. It can be not only a UI5 control, but also an existing DOM reference. The side of the placement depends on the placement property set in the Popover.
* @param {boolean} bSkipInstanceManager
* @returns {sap.m.Popover} Reference to the control instance for chaining
*/
public openBy(oControl: any, bSkipInstanceManager: boolean): sap.m.Popover;
/**
* Calculate outerHeight of the element; used as hook for SVG elements
* @param {HTMLElement} oElement - An Element for which outerHeight will be calculated.
* @param {boolean} bIncludeMargin - Determines if the margins should be included in the calculated outerHeight. Default value is false.
*/
protected static outerHeight(oElement: HTMLElement, bIncludeMargin: boolean): void;
/**
* Calculate outerWidth of the element; used as hook for SVG elements
* @param {HTMLElement} oElement - An Element for which outerWidth will be calculated.
* @param {boolean} bIncludeMargin - Determines if the margins should be included in the calculated outerWidth. Default value is false.
*/
protected static outerWidth(oElement: HTMLElement, bIncludeMargin: boolean): void;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets the aggregated {@link #getBeginButton beginButton}.
* @param {sap.ui.core.Control} oBeginButton - The beginButton to set
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setBeginButton(oBeginButton: sap.ui.core.Control): sap.m.Popover;
/**
* Setter for property bounce
.
*
* Default value is empty
* @param {boolean} bBounce - New value for property bounce
* @returns {sap.m.Popover} Reference to the control instance for chaining
*/
protected setBounce(bBounce: boolean): sap.m.Popover;
/**
* Sets a new value for property {@link #getContentHeight contentHeight}.
*
* Set the height of the content area inside Popover. When controls which adapt their size to the parent control are added directly into Popover, for example sap.m.Page control, a size needs to be specified to the content area of the Popover. Otherwise, Popover control isn't able to display the content in the right way. This values isn't necessary for controls added to Popover directly which can decide their size by themselves, for exmaple sap.m.List, sap.m.Image etc., only needed for controls that adapt their size to the parent control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sContentHeight - New value for property contentHeight
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setContentHeight(sContentHeight: sap.ui.core.CSSSize): sap.m.Popover;
/**
* Sets a new value for property {@link #getContentMinWidth contentMinWidth}.
*
* Sets the minimum width of the content area inside popover.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.CSSSize} sContentMinWidth - New value for property contentMinWidth
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setContentMinWidth(sContentMinWidth: sap.ui.core.CSSSize): sap.m.Popover;
/**
* Sets a new value for property {@link #getContentWidth contentWidth}.
*
* Set the width of the content area inside Popover. When controls which adapt their size to the parent control are added directly into Popover, for example sap.m.Page control, a size needs to be specified to the content area of the Popover. Otherwise, Popover control isn't able to display the content in the right way. This values isn't necessary for controls added to Popover directly which can decide their size by themselves, for exmaple sap.m.List, sap.m.Image etc., only needed for controls that adapt their size to the parent control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sContentWidth - New value for property contentWidth
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setContentWidth(sContentWidth: sap.ui.core.CSSSize): sap.m.Popover;
/**
* Sets the aggregated {@link #getCustomHeader customHeader}.
* @param {sap.ui.core.Control} oCustomHeader - The customHeader to set
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setCustomHeader(oCustomHeader: sap.ui.core.Control): sap.m.Popover;
/**
* Sets a new value for property {@link #getEnableScrolling enableScrolling}.
*
* This property is deprecated. Please use properties verticalScrolling and horizontalScrolling instead. If you still use this property it will be mapped on the new properties verticalScrolling and horizontalScrolling.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableScrolling - New value for property enableScrolling
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setEnableScrolling(bEnableScrolling: boolean): sap.m.Popover;
/**
* Sets the aggregated {@link #getEndButton endButton}.
* @param {sap.ui.core.Control} oEndButton - The endButton to set
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setEndButton(oEndButton: sap.ui.core.Control): sap.m.Popover;
/**
* The followOf feature closes the Popover when the position of the control that opened the Popover changes by at least 32 pixels (on desktop browsers). This may lead to unwanted closing of the Popover.
*
* This function is for enabling/disabling the followOf feature.
* @param {boolean} bValue - Enables the followOf feature
* @returns {sap.m.Popover} Reference to the control instance for chaining
*/
protected setFollowOf(bValue: boolean): sap.m.Popover;
/**
* Sets the aggregated {@link #getFooter footer}.
* @param {sap.ui.core.Control} oFooter - The footer to set
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setFooter(oFooter: sap.ui.core.Control): sap.m.Popover;
/**
* Sets a new value for property {@link #getHorizontalScrolling horizontalScrolling}.
*
* This property indicates if user can scroll horizontally inside popover when the content is bigger than the content area. However, when scrollable control (sap.m.ScrollContainer, sap.m.Page) is in the popover, this property needs to be set to false to disable the scrolling in popover in order to make the scrolling in the child control work properly.
* Popover detects if there's sap.m.NavContainer, sap.m.Page, or sap.m.ScrollContainer as direct child added to Popover. If there is, Popover will turn off scrolling by setting this property to false automatically ignoring the existing value of this property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bHorizontalScrolling - New value for property horizontalScrolling
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setHorizontalScrolling(bHorizontalScrolling: boolean): sap.m.Popover;
/**
* Sets the associated {@link #getInitialFocus initialFocus}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oInitialFocus - ID of an element which becomes the new target of this initialFocus association; alternatively, an element instance may be given
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setInitialFocus(oInitialFocus: sap.ui.core.ID|sap.ui.core.Control): sap.m.Popover;
/**
* Sets the associated {@link #getLeftButton leftButton}.
* @param {sap.ui.core.ID|sap.m.Button} oLeftButton - ID of an element which becomes the new target of this leftButton association; alternatively, an element instance may be given
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setLeftButton(oLeftButton: sap.ui.core.ID|sap.m.Button): sap.m.Popover;
/**
* Setter for property modal
.
* This overwrites the default setter of the property modal
to avoid rerendering the whole popover control.
*
* Default value is false
* @param {boolean} bModal - New value for property modal
.
* @param {string} sModalCSSClass - A CSS class (or space-separated list of classes) that should be added to the block layer.
* @returns {sap.m.Popover} Reference to the control instance for chaining
*/
public setModal(bModal: boolean, sModalCSSClass?: string): sap.m.Popover;
/**
* Sets a new value for property {@link #getOffsetX offsetX}.
*
* The offset for the popover placement in the x axis. It's with unit pixel.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iOffsetX - New value for property offsetX
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setOffsetX(iOffsetX: number): sap.m.Popover;
/**
* Sets a new value for property {@link #getOffsetY offsetY}.
*
* The offset for the popover placement in the y axis. It's with unit pixel.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iOffsetY - New value for property offsetY
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setOffsetY(iOffsetY: number): sap.m.Popover;
/**
* Set the placement of the Popover.
* @param {sap.m.PlacementType} sPlacement - The position of the Popover
* @returns {sap.m.Popover} Reference to the control instance for chaining
*/
public setPlacement(sPlacement: sap.m.PlacementType): sap.m.Popover;
/**
* Sets a new value for property {@link #getResizable resizable}.
*
* Whether resize option is enabled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bResizable - New value for property resizable
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setResizable(bResizable: boolean): sap.m.Popover;
/**
* Sets the associated {@link #getRightButton rightButton}.
* @param {sap.ui.core.ID|sap.m.Button} oRightButton - ID of an element which becomes the new target of this rightButton association; alternatively, an element instance may be given
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setRightButton(oRightButton: sap.ui.core.ID|sap.m.Button): sap.m.Popover;
/**
* Sets a new value for property {@link #getShowArrow showArrow}.
*
* Whether Popover arrow should be visible
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowArrow - New value for property showArrow
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setShowArrow(bShowArrow: boolean): sap.m.Popover;
/**
* Sets a new value for property {@link #getShowHeader showHeader}.
*
* If a header should be shown at the top of the popover.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowHeader - New value for property showHeader
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setShowHeader(bShowHeader: boolean): sap.m.Popover;
/**
* Sets the aggregated {@link #getSubHeader subHeader}.
* @param {sap.ui.core.Control} oSubHeader - The subHeader to set
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setSubHeader(oSubHeader: sap.ui.core.Control): sap.m.Popover;
/**
* The setter of the title property.
*
* If you want to show a header in the popover, don't forget to set the
* {@link #setShowHeader showHeader} property to true.
* @param {string} sTitle - The title to be set
* @returns {sap.m.Popover} Reference to the control instance for chaining
*/
public setTitle(sTitle: string): sap.m.Popover;
/**
* Sets a new value for property {@link #getVerticalScrolling verticalScrolling}.
*
* This property indicates if user can scroll vertically inside popover when the content is bigger than the content area. However, when scrollable control (sap.m.ScrollContainer, sap.m.Page) is in the popover, this property needs to be set to false to disable the scrolling in popover in order to make the scrolling in the child control work properly.
* Popover detects if there's sap.m.NavContainer, sap.m.Page, or sap.m.ScrollContainer as direct child added to Popover. If there is, Popover will turn off scrolling by setting this property to false automatically ignoring the existing value of this property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVerticalScrolling - New value for property verticalScrolling
* @returns {sap.m.Popover} Reference to this
in order to allow method chaining
*/
public setVerticalScrolling(bVerticalScrolling: boolean): sap.m.Popover;
}
/**
* Helper for Popups.
*/
namespace PopupHelper {
/**
* This methods converts the percentage value to an absolute number based on the given base number.
* @param {string} sPercentage - A percentage value in string format, for example "25%"
* @param {number} fBaseSize - A float number which the calculation is based on.
* @returns {any} The calculated size string with "px" as unit or null when the format of given parameter is wrong.
*/
function calcPercentageSize(sPercentage: string, fBaseSize: number): any;
}
/**
* Shows the progress of a process in a graphical way. To indicate the progress, the inside of the ProgressIndicator is filled with a color.
* Additionally, a user-defined string can be displayed on the ProgressIndicator.
*/
export class ProgressIndicator extends sap.ui.core.Control {
/**
* Constructor for a new ProgressIndicator.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.ProgressIndicator with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getDisplayValue displayValue}.
*
* Specifies the text value to be displayed in the bar.
* @returns {string} Value of property displayValue
*/
public getDisplayValue(): string;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Switches enabled state of the control. Disabled fields have different colors, and cannot be focused.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* Specifies the height of the control. The default value depends on the theme. Suggested size for normal use is 2.5rem (40px). Suggested size for small size (like for use in ObjectHeader) is 1.375rem (22px).
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.m.ProgressIndicator.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPercentValue percentValue}.
*
* Specifies the numerical value in percent for the length of the progress bar.
*
* Default value is 0
.
* @returns {number} Value of property percentValue
*/
public getPercentValue(): number;
/**
* Gets current value of property {@link #getShowValue showValue}.
*
* Indicates whether the displayValue should be shown in the ProgressIndicator.
*
* Default value is true
.
* @returns {boolean} Value of property showValue
*/
public getShowValue(): boolean;
/**
* Gets current value of property {@link #getState state}.
*
* Specifies the state of the bar. Enumeration sap.ui.core.ValueState provides Error (red), Warning (yellow), Success (green), None (blue) (default value).
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property state
*/
public getState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Specifies the element's text directionality with enumerated options (RTL or LTR). By default, the control inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getWidth width}.
*
* Specifies the width of the control.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getDisplayValue displayValue}.
*
* Specifies the text value to be displayed in the bar.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sDisplayValue - New value for property displayValue
* @returns {sap.m.ProgressIndicator} Reference to this
in order to allow method chaining
*/
public setDisplayValue(sDisplayValue: string): sap.m.ProgressIndicator;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Switches enabled state of the control. Disabled fields have different colors, and cannot be focused.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.ProgressIndicator} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.ProgressIndicator;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Specifies the height of the control. The default value depends on the theme. Suggested size for normal use is 2.5rem (40px). Suggested size for small size (like for use in ObjectHeader) is 1.375rem (22px).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.m.ProgressIndicator} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.m.ProgressIndicator;
/**
* Sets a new value for property {@link #getPercentValue percentValue}.
*
* Specifies the numerical value in percent for the length of the progress bar.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} fPercentValue - New value for property percentValue
* @returns {sap.m.ProgressIndicator} Reference to this
in order to allow method chaining
*/
public setPercentValue(fPercentValue: number): sap.m.ProgressIndicator;
/**
* Sets a new value for property {@link #getShowValue showValue}.
*
* Indicates whether the displayValue should be shown in the ProgressIndicator.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowValue - New value for property showValue
* @returns {sap.m.ProgressIndicator} Reference to this
in order to allow method chaining
*/
public setShowValue(bShowValue: boolean): sap.m.ProgressIndicator;
/**
* Sets a new value for property {@link #getState state}.
*
* Specifies the state of the bar. Enumeration sap.ui.core.ValueState provides Error (red), Warning (yellow), Success (green), None (blue) (default value).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sState - New value for property state
* @returns {sap.m.ProgressIndicator} Reference to this
in order to allow method chaining
*/
public setState(sState: sap.ui.core.ValueState): sap.m.ProgressIndicator;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Specifies the element's text directionality with enumerated options (RTL or LTR). By default, the control inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.ProgressIndicator} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.ProgressIndicator;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Specifies the width of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.ProgressIndicator} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.ProgressIndicator;
}
/**
* PullToRefresh control. Put it as the first control in contents of a scroll container or a scrollable page. Do not place it into a page with disabled scrolling.
* On touch devices it gets hidden by default and when the user pulls down the page far enough, it gets visible and triggers the "refresh" event.
* In non-touch browsers where scrollbars are used for scrolling, it is always visible and triggers the "refresh" event when clicked.
*/
export class PullToRefresh extends sap.ui.core.Control {
/**
* Constructor for a new PullToRefresh.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:refresh refresh} event of this sap.m.PullToRefresh
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PullToRefresh
itself.
*
* Event indicates that the user has requested new data
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PullToRefresh
itself
* @returns {sap.m.PullToRefresh} Reference to this
in order to allow method chaining
*/
public attachRefresh(fnFunction: Function, oListener?: any): sap.m.PullToRefresh;
/**
* Attaches event handler fnFunction
to the {@link #event:refresh refresh} event of this sap.m.PullToRefresh
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.PullToRefresh
itself.
*
* Event indicates that the user has requested new data
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.PullToRefresh
itself
* @returns {sap.m.PullToRefresh} Reference to this
in order to allow method chaining
*/
public attachRefresh(oData: any, fnFunction: Function, oListener?: any): sap.m.PullToRefresh;
/**
* Detaches event handler fnFunction
from the {@link #event:refresh refresh} event of this sap.m.PullToRefresh
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.PullToRefresh} Reference to this
in order to allow method chaining
*/
public detachRefresh(fnFunction: Function, oListener: any): sap.m.PullToRefresh;
/**
* Creates a new subclass of class sap.m.PullToRefresh with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:refresh refresh} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.PullToRefresh} Reference to this
in order to allow method chaining
*/
protected fireRefresh(mParameters?: any): sap.m.PullToRefresh;
/**
* Gets current value of property {@link #getCustomIcon customIcon}.
*
* Provide a URI to a custom icon image to replace the SAP logo. Large images are scaled down to max 50px height.
* @returns {sap.ui.core.URI} Value of property customIcon
*/
public getCustomIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getDescription description}.
*
* Optional description. May be used to inform a user, for example, when the list has been updated last time.
* @returns {string} Value of property description
*/
public getDescription(): string;
/**
* Gets current value of property {@link #getIconDensityAware iconDensityAware}.
*
* By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
*
* If bandwidth is the key for the application, set this value to false.
*
* Default value is true
.
* @returns {boolean} Value of property iconDensityAware
*/
public getIconDensityAware(): boolean;
/**
* Returns a metadata object for class sap.m.PullToRefresh.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowIcon showIcon}.
*
* Set to true to display an icon/logo. Icon must be set either in the customIcon property or in the CSS theme for the PullToRefresh control.
*
* Default value is false
.
* @returns {boolean} Value of property showIcon
*/
public getShowIcon(): boolean;
/**
* Hides the control and resets it to the normal state. In non-touch environments the control is not hidden.
*/
public hide(): void;
/**
* Sets a new value for property {@link #getCustomIcon customIcon}.
*
* Provide a URI to a custom icon image to replace the SAP logo. Large images are scaled down to max 50px height.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sCustomIcon - New value for property customIcon
* @returns {sap.m.PullToRefresh} Reference to this
in order to allow method chaining
*/
public setCustomIcon(sCustomIcon: sap.ui.core.URI): sap.m.PullToRefresh;
/**
* Sets a new value for property {@link #getDescription description}.
*
* Optional description. May be used to inform a user, for example, when the list has been updated last time.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sDescription - New value for property description
* @returns {sap.m.PullToRefresh} Reference to this
in order to allow method chaining
*/
public setDescription(sDescription: string): sap.m.PullToRefresh;
/**
* Sets a new value for property {@link #getIconDensityAware iconDensityAware}.
*
* By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
*
* If bandwidth is the key for the application, set this value to false.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconDensityAware - New value for property iconDensityAware
* @returns {sap.m.PullToRefresh} Reference to this
in order to allow method chaining
*/
public setIconDensityAware(bIconDensityAware: boolean): sap.m.PullToRefresh;
/**
* Sets a new value for property {@link #getShowIcon showIcon}.
*
* Set to true to display an icon/logo. Icon must be set either in the customIcon property or in the CSS theme for the PullToRefresh control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowIcon - New value for property showIcon
* @returns {sap.m.PullToRefresh} Reference to this
in order to allow method chaining
*/
public setShowIcon(bShowIcon: boolean): sap.m.PullToRefresh;
}
/**
* The QuickView control renders a responsive popover (sap.m.Popover or sap.m.Dialog)
* and displays information of an object in a business-card format. It also allows this object to be linked to
* another object using one of the links in the responsive popover. Clicking that link updates the information in the
* popover with the data of the linked object. Unlimited number of objects can be linked.
*/
export class QuickView extends sap.m.QuickViewBase {
/**
* Constructor for a new QuickView.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:afterClose afterClose} event of this sap.m.QuickView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.QuickView
itself.
*
* This event fires after the QuickView is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.QuickView
itself
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
public attachAfterClose(fnFunction: Function, oListener?: any): sap.m.QuickView;
/**
* Attaches event handler fnFunction
to the {@link #event:afterClose afterClose} event of this sap.m.QuickView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.QuickView
itself.
*
* This event fires after the QuickView is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.QuickView
itself
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
public attachAfterClose(oData: any, fnFunction: Function, oListener?: any): sap.m.QuickView;
/**
* Attaches event handler fnFunction
to the {@link #event:afterOpen afterOpen} event of this sap.m.QuickView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.QuickView
itself.
*
* This event fires after the QuickView is opened.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.QuickView
itself
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
public attachAfterOpen(fnFunction: Function, oListener?: any): sap.m.QuickView;
/**
* Attaches event handler fnFunction
to the {@link #event:afterOpen afterOpen} event of this sap.m.QuickView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.QuickView
itself.
*
* This event fires after the QuickView is opened.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.QuickView
itself
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
public attachAfterOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.QuickView;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.QuickView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.QuickView
itself.
*
* This event fires before the QuickView is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.QuickView
itself
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
public attachBeforeClose(fnFunction: Function, oListener?: any): sap.m.QuickView;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.QuickView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.QuickView
itself.
*
* This event fires before the QuickView is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.QuickView
itself
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
public attachBeforeClose(oData: any, fnFunction: Function, oListener?: any): sap.m.QuickView;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.QuickView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.QuickView
itself.
*
* This event fires before the QuickView is opened.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.QuickView
itself
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(fnFunction: Function, oListener?: any): sap.m.QuickView;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.QuickView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.QuickView
itself.
*
* This event fires before the QuickView is opened.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.QuickView
itself
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.QuickView;
/**
* Detaches event handler fnFunction
from the {@link #event:afterClose afterClose} event of this sap.m.QuickView
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
public detachAfterClose(fnFunction: Function, oListener: any): sap.m.QuickView;
/**
* Detaches event handler fnFunction
from the {@link #event:afterOpen afterOpen} event of this sap.m.QuickView
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
public detachAfterOpen(fnFunction: Function, oListener: any): sap.m.QuickView;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeClose beforeClose} event of this sap.m.QuickView
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
public detachBeforeClose(fnFunction: Function, oListener: any): sap.m.QuickView;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeOpen beforeOpen} event of this sap.m.QuickView
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
public detachBeforeOpen(fnFunction: Function, oListener: any): sap.m.QuickView;
/**
* Creates a new subclass of class sap.m.QuickView with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.QuickViewBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:afterClose afterClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
protected fireAfterClose(mParameters?: any): sap.m.QuickView;
/**
* Fires event {@link #event:afterOpen afterOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
protected fireAfterOpen(mParameters?: any): sap.m.QuickView;
/**
* Fires event {@link #event:beforeClose beforeClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
protected fireBeforeClose(mParameters?: any): sap.m.QuickView;
/**
* Fires event {@link #event:beforeOpen beforeOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.QuickView} Reference to this
in order to allow method chaining
*/
protected fireBeforeOpen(mParameters?: any): sap.m.QuickView;
/**
* Returns a metadata object for class sap.m.QuickView.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPlacement placement}.
*
* This property is reused from sap.m.Popover and only takes effect when running on desktop or tablet. Please refer the documentation of the placement property of sap.m.Popover.
*
* Default value is Right
.
* @returns {sap.m.PlacementType} Value of property placement
*/
public getPlacement(): sap.m.PlacementType;
/**
* Gets current value of property {@link #getWidth width}.
*
* The width of the QuickView. The property takes effect only when running on desktop or tablet.
*
* Default value is 320px
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Opens the QuickView.
* @param {sap.ui.core.Control} oControl - The control which opens the QuickView.
* @returns {sap.m.QuickView} Pointer to the control instance for chaining
*/
public openBy(oControl: sap.ui.core.Control): sap.m.QuickView;
/**
* The method sets placement position of the QuickView.
* @param {sap.m.PlacementType} sPlacement - The side from which the QuickView appears relative to the control that opens it.
* @returns {sap.m.QuickView} Pointer to the control instance for chaining.
*/
public setPlacement(sPlacement: sap.m.PlacementType): sap.m.QuickView;
/**
* The method sets the width of the QuickView.
* Works only on desktop or tablet.
* @param {sap.ui.core.CSSSize} sWidth - The new width of the QuickView.
* @returns {sap.m.QuickView} Pointer to the control instance for chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.QuickView;
}
/**
* QuickViewBase class provides base functionality for QuickView and QuickViewCard.
* Do not use it directly.
*/
export class QuickViewBase extends sap.ui.core.Control {
/**
* Constructor for a new QuickViewBase.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some page to the aggregation {@link #getPages pages}.
* @param {sap.m.QuickViewPage} oPage - the page to add; if empty, nothing is inserted
* @returns {sap.m.QuickViewBase} Reference to this
in order to allow method chaining
*/
public addPage(oPage: sap.m.QuickViewPage): sap.m.QuickViewBase;
/**
* Attaches event handler fnFunction
to the {@link #event:afterNavigate afterNavigate} event of this sap.m.QuickViewBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.QuickViewBase
itself.
*
* The event is fired when navigation between two pages has completed.
* In case of animated transitions this event is fired with some delay
* after the "navigate" event.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.QuickViewBase
itself
* @returns {sap.m.QuickViewBase} Reference to this
in order to allow method chaining
*/
public attachAfterNavigate(fnFunction: Function, oListener?: any): sap.m.QuickViewBase;
/**
* Attaches event handler fnFunction
to the {@link #event:afterNavigate afterNavigate} event of this sap.m.QuickViewBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.QuickViewBase
itself.
*
* The event is fired when navigation between two pages has completed.
* In case of animated transitions this event is fired with some delay
* after the "navigate" event.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.QuickViewBase
itself
* @returns {sap.m.QuickViewBase} Reference to this
in order to allow method chaining
*/
public attachAfterNavigate(oData: any, fnFunction: Function, oListener?: any): sap.m.QuickViewBase;
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.m.QuickViewBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.QuickViewBase
itself.
*
* The event is fired when navigation between two pages has been triggered.
* The transition (if any) to the new page has not started yet.
* This event can be aborted by the application with preventDefault(),
* which means that there will be no navigation.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.QuickViewBase
itself
* @returns {sap.m.QuickViewBase} Reference to this
in order to allow method chaining
*/
public attachNavigate(fnFunction: Function, oListener?: any): sap.m.QuickViewBase;
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.m.QuickViewBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.QuickViewBase
itself.
*
* The event is fired when navigation between two pages has been triggered.
* The transition (if any) to the new page has not started yet.
* This event can be aborted by the application with preventDefault(),
* which means that there will be no navigation.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.QuickViewBase
itself
* @returns {sap.m.QuickViewBase} Reference to this
in order to allow method chaining
*/
public attachNavigate(oData: any, fnFunction: Function, oListener?: any): sap.m.QuickViewBase;
/**
* Binds aggregation {@link #getPages pages} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.QuickViewBase} Reference to this
in order to allow method chaining
*/
public bindPages(oBindingInfo: any): sap.m.QuickViewBase;
/**
* Destroys all the pages in the aggregation {@link #getPages pages}.
* @returns {sap.m.QuickViewBase} Reference to this
in order to allow method chaining
*/
public destroyPages(): sap.m.QuickViewBase;
/**
* Detaches event handler fnFunction
from the {@link #event:afterNavigate afterNavigate} event of this sap.m.QuickViewBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.QuickViewBase} Reference to this
in order to allow method chaining
*/
public detachAfterNavigate(fnFunction: Function, oListener: any): sap.m.QuickViewBase;
/**
* Detaches event handler fnFunction
from the {@link #event:navigate navigate} event of this sap.m.QuickViewBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.QuickViewBase} Reference to this
in order to allow method chaining
*/
public detachNavigate(fnFunction: Function, oListener: any): sap.m.QuickViewBase;
/**
* Creates a new subclass of class sap.m.QuickViewBase with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:afterNavigate afterNavigate} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.QuickViewBase} Reference to this
in order to allow method chaining
*/
protected fireAfterNavigate(mParameters?: any): sap.m.QuickViewBase;
/**
* Fires event {@link #event:navigate navigate} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireNavigate(mParameters?: any): boolean;
/**
* Returns a metadata object for class sap.m.QuickViewBase.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getPages pages}.
*
* Displays a page header, object icon or image, object name with short description,
* and object information divided in groups
* @returns {sap.m.QuickViewPage[]}
*/
public getPages(): sap.m.QuickViewPage[];
/**
* Checks for the provided sap.m.QuickViewPage
in the aggregation {@link #getPages pages}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.QuickViewPage} oPage - The page whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfPage(oPage: sap.m.QuickViewPage): number;
/**
* Inserts a page into the aggregation {@link #getPages pages}.
* @param {sap.m.QuickViewPage} oPage - the page to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the page should be inserted at; for a negative value of iIndex
, the page is inserted at position 0; for a value greater than the current size of the aggregation, the page is inserted at the last position
* @returns {sap.m.QuickViewBase} Reference to this
in order to allow method chaining
*/
public insertPage(oPage: sap.m.QuickViewPage, iIndex: number): sap.m.QuickViewBase;
/**
* Navigates to the previous page if there is such.
*/
public navigateBack(): void;
/**
* Removes all the controls from the aggregation {@link #getPages pages}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.QuickViewPage[]} An array of the removed elements (might be empty)
*/
public removeAllPages(): sap.m.QuickViewPage[];
/**
* Removes a page from the aggregation {@link #getPages pages}.
* @param {number|string|sap.m.QuickViewPage} vPage - The page to remove or its index or id
* @returns {sap.m.QuickViewPage} The removed page or null
*/
public removePage(vPage: number|string|sap.m.QuickViewPage): sap.m.QuickViewPage;
/**
* Unbinds aggregation {@link #getPages pages} from model data.
* @returns {sap.m.QuickViewBase} Reference to this
in order to allow method chaining
*/
public unbindPages(): sap.m.QuickViewBase;
}
/**
* The QuickViewCard control displays information of an object in a business-card format.
* It also allows this object to be linked to another object using one of the links.
* Clicking that link updates the information with the data of the linked object.
* Unlimited number of objects can be linked.
*/
export class QuickViewCard extends sap.m.QuickViewBase {
/**
* Constructor for a new QuickViewCard.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.QuickViewCard with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.QuickViewBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.QuickViewCard.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowVerticalScrollBar showVerticalScrollBar}.
*
* Determines whether the browser displays the vertical scroll bar or simply cuts the content of the QuickViewCard.
*
* Default value is true
.
* @returns {boolean} Value of property showVerticalScrollBar
*/
public getShowVerticalScrollBar(): boolean;
/**
* Sets a new value for property {@link #getShowVerticalScrollBar showVerticalScrollBar}.
*
* Determines whether the browser displays the vertical scroll bar or simply cuts the content of the QuickViewCard.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowVerticalScrollBar - New value for property showVerticalScrollBar
* @returns {sap.m.QuickViewCard} Reference to this
in order to allow method chaining
*/
public setShowVerticalScrollBar(bShowVerticalScrollBar: boolean): sap.m.QuickViewCard;
}
/**
* QuickViewGroup consists of a title (optional) and an entity of group elements.
*/
export class QuickViewGroup extends sap.ui.core.Element {
/**
* Constructor for a new QuickViewGroup.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some element to the aggregation {@link #getElements elements}.
* @param {sap.m.QuickViewGroupElement} oElement - the element to add; if empty, nothing is inserted
* @returns {sap.m.QuickViewGroup} Reference to this
in order to allow method chaining
*/
public addElement(oElement: sap.m.QuickViewGroupElement): sap.m.QuickViewGroup;
/**
* Binds aggregation {@link #getElements elements} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.QuickViewGroup} Reference to this
in order to allow method chaining
*/
public bindElements(oBindingInfo: any): sap.m.QuickViewGroup;
/**
* Destroys all the elements in the aggregation {@link #getElements elements}.
* @returns {sap.m.QuickViewGroup} Reference to this
in order to allow method chaining
*/
public destroyElements(): sap.m.QuickViewGroup;
/**
* Creates a new subclass of class sap.m.QuickViewGroup with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getElements elements}.
*
* A combination of one label and another control (Link or Text) associated to this label.
* @returns {sap.m.QuickViewGroupElement[]}
*/
public getElements(): sap.m.QuickViewGroupElement[];
/**
* Gets current value of property {@link #getHeading heading}.
*
* The title of the group
*
* Default value is
.
* @returns {string} Value of property heading
*/
public getHeading(): string;
/**
* Returns a metadata object for class sap.m.QuickViewGroup.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Determines whether the group is visible on the screen.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Checks for the provided sap.m.QuickViewGroupElement
in the aggregation {@link #getElements elements}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.QuickViewGroupElement} oElement - The element whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfElement(oElement: sap.m.QuickViewGroupElement): number;
/**
* Inserts a element into the aggregation {@link #getElements elements}.
* @param {sap.m.QuickViewGroupElement} oElement - the element to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the element should be inserted at; for a negative value of iIndex
, the element is inserted at position 0; for a value greater than the current size of the aggregation, the element is inserted at the last position
* @returns {sap.m.QuickViewGroup} Reference to this
in order to allow method chaining
*/
public insertElement(oElement: sap.m.QuickViewGroupElement, iIndex: number): sap.m.QuickViewGroup;
/**
* Removes all the controls from the aggregation {@link #getElements elements}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.QuickViewGroupElement[]} An array of the removed elements (might be empty)
*/
public removeAllElements(): sap.m.QuickViewGroupElement[];
/**
* Removes a element from the aggregation {@link #getElements elements}.
* @param {number|string|sap.m.QuickViewGroupElement} vElement - The element to remove or its index or id
* @returns {sap.m.QuickViewGroupElement} The removed element or null
*/
public removeElement(vElement: number|string|sap.m.QuickViewGroupElement): sap.m.QuickViewGroupElement;
/**
* Sets a new value for property {@link #getHeading heading}.
*
* The title of the group
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sHeading - New value for property heading
* @returns {sap.m.QuickViewGroup} Reference to this
in order to allow method chaining
*/
public setHeading(sHeading: string): sap.m.QuickViewGroup;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Determines whether the group is visible on the screen.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.QuickViewGroup} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.QuickViewGroup;
/**
* Unbinds aggregation {@link #getElements elements} from model data.
* @returns {sap.m.QuickViewGroup} Reference to this
in order to allow method chaining
*/
public unbindElements(): sap.m.QuickViewGroup;
}
/**
* QuickViewGroupElement is a combination of one label and another control (Link or Text) associated to this label.
*/
export class QuickViewGroupElement extends sap.ui.core.Element {
/**
* Constructor for a new QuickViewGroupElement.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.QuickViewGroupElement with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getEmailSubject emailSubject}.
*
* The subject of the email.
* Works only with QuickViewGroupElement of type email.
*
* Default value is
.
* @returns {string} Value of property emailSubject
*/
public getEmailSubject(): string;
/**
* Gets current value of property {@link #getLabel label}.
*
* Specifies the text displayed below the associated label.
*
* Default value is
.
* @returns {string} Value of property label
*/
public getLabel(): string;
/**
* Returns a metadata object for class sap.m.QuickViewGroupElement.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPageLinkId pageLinkId}.
*
* Specifies the ID of the QuickViewPage, which is opened from the link in the QuickViewGroupElement.
* Works only with QuickViewGroupElement of type pageLink.
*
* Default value is
.
* @returns {string} Value of property pageLinkId
*/
public getPageLinkId(): string;
/**
* Gets current value of property {@link #getTarget target}.
*
* Specifies the target of the link – it works like the target property of the HTML tag. Works only with QuickViewGroupElement of type link.
*
* Default value is _blank
.
* @returns {string} Value of property target
*/
public getTarget(): string;
/**
* Gets current value of property {@link #getType type}.
*
* Specifies the type of the displayed information – phone number, mobile number, e-mail, link, text or a link to another QuickViewPage. Default value is ‘text’.
*
* Default value is GroupElementType.text
.
* @returns {sap.m.QuickViewGroupElementType} Value of property type
*/
public getType(): sap.m.QuickViewGroupElementType;
/**
* Gets current value of property {@link #getUrl url}.
*
* Specifies the address of the QuickViewGroupElement link. Works only with QuickViewGroupElement of type link.
*
* Default value is
.
* @returns {string} Value of property url
*/
public getUrl(): string;
/**
* Gets current value of property {@link #getValue value}.
*
* Specifies the text of the control that associates with the label.
*
* Default value is
.
* @returns {string} Value of property value
*/
public getValue(): string;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Determines whether the element should be visible on the screen.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Sets a new value for property {@link #getEmailSubject emailSubject}.
*
* The subject of the email.
* Works only with QuickViewGroupElement of type email.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sEmailSubject - New value for property emailSubject
* @returns {sap.m.QuickViewGroupElement} Reference to this
in order to allow method chaining
*/
public setEmailSubject(sEmailSubject: string): sap.m.QuickViewGroupElement;
/**
* Sets a new value for property {@link #getLabel label}.
*
* Specifies the text displayed below the associated label.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sLabel - New value for property label
* @returns {sap.m.QuickViewGroupElement} Reference to this
in order to allow method chaining
*/
public setLabel(sLabel: string): sap.m.QuickViewGroupElement;
/**
* Sets a new value for property {@link #getPageLinkId pageLinkId}.
*
* Specifies the ID of the QuickViewPage, which is opened from the link in the QuickViewGroupElement.
* Works only with QuickViewGroupElement of type pageLink.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sPageLinkId - New value for property pageLinkId
* @returns {sap.m.QuickViewGroupElement} Reference to this
in order to allow method chaining
*/
public setPageLinkId(sPageLinkId: string): sap.m.QuickViewGroupElement;
/**
* Sets a new value for property {@link #getTarget target}.
*
* Specifies the target of the link – it works like the target property of the HTML tag. Works only with QuickViewGroupElement of type link.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is _blank
.
* @param {string} sTarget - New value for property target
* @returns {sap.m.QuickViewGroupElement} Reference to this
in order to allow method chaining
*/
public setTarget(sTarget: string): sap.m.QuickViewGroupElement;
/**
* Sets a new value for property {@link #getType type}.
*
* Specifies the type of the displayed information – phone number, mobile number, e-mail, link, text or a link to another QuickViewPage. Default value is ‘text’.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is GroupElementType.text
.
* @param {sap.m.QuickViewGroupElementType} sType - New value for property type
* @returns {sap.m.QuickViewGroupElement} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.m.QuickViewGroupElementType): sap.m.QuickViewGroupElement;
/**
* Sets a new value for property {@link #getUrl url}.
*
* Specifies the address of the QuickViewGroupElement link. Works only with QuickViewGroupElement of type link.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sUrl - New value for property url
* @returns {sap.m.QuickViewGroupElement} Reference to this
in order to allow method chaining
*/
public setUrl(sUrl: string): sap.m.QuickViewGroupElement;
/**
* Sets a new value for property {@link #getValue value}.
*
* Specifies the text of the control that associates with the label.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sValue - New value for property value
* @returns {sap.m.QuickViewGroupElement} Reference to this
in order to allow method chaining
*/
public setValue(sValue: string): sap.m.QuickViewGroupElement;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Determines whether the element should be visible on the screen.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.QuickViewGroupElement} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.QuickViewGroupElement;
}
/**
* QuickViewGroupElement is a combination of one label and another control (Link or Text) associated to this label
*/
export enum QuickViewGroupElementType {
/**
* Displays an e-mail link
*/
email = "email",
/**
* Displayes a regular HTML link
*/
link = "link",
/**
* Displays a phone number link for direct dialing and an icon for sending a text message
*/
mobile = "mobile",
/**
* Dislpays a link for navigating to another QuickViewPage
*/
pageLink = "pageLink",
/**
* Displays a phone number link for direct dialing
*/
phone = "phone",
/**
* Dislpays text
*/
text = "text",
}
/**
* QuickViewPage consists of a page header, an object icon or image,
* an object name with short description, and an object information divided in groups.
* The control uses the sap.m.SimpleForm control to display information.
*/
export class QuickViewPage extends sap.ui.core.Control {
/**
* Constructor for a new QuickViewPage.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some group to the aggregation {@link #getGroups groups}.
* @param {sap.m.QuickViewGroup} oGroup - the group to add; if empty, nothing is inserted
* @returns {sap.m.QuickViewPage} Reference to this
in order to allow method chaining
*/
public addGroup(oGroup: sap.m.QuickViewGroup): sap.m.QuickViewPage;
/**
* Binds aggregation {@link #getGroups groups} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.QuickViewPage} Reference to this
in order to allow method chaining
*/
public bindGroups(oBindingInfo: any): sap.m.QuickViewPage;
/**
* Destroys all the groups in the aggregation {@link #getGroups groups}.
* @returns {sap.m.QuickViewPage} Reference to this
in order to allow method chaining
*/
public destroyGroups(): sap.m.QuickViewPage;
/**
* Creates a new subclass of class sap.m.QuickViewPage with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getCrossAppNavCallback crossAppNavCallback}.
*
* Specifies the application which provides target and param configuration for cross-application navigation from the 'page header'.
* @returns {any} Value of property crossAppNavCallback
*/
public getCrossAppNavCallback(): any;
/**
* Gets current value of property {@link #getDescription description}.
*
* Specifies the text displayed under the header of the content section
*
* Default value is
.
* @returns {string} Value of property description
*/
public getDescription(): string;
/**
* Gets content of aggregation {@link #getGroups groups}.
*
* QuickViewGroup consists of a title (optional) and an entity of group elements.
* @returns {sap.m.QuickViewGroup[]}
*/
public getGroups(): sap.m.QuickViewGroup[];
/**
* Gets current value of property {@link #getHeader header}.
*
* Specifies the text displayed in the header of the control.
*
* Default value is
.
* @returns {string} Value of property header
*/
public getHeader(): string;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Specifies the URL of the icon displayed under the header of the page
*
* Default value is
.
* @returns {string} Value of property icon
*/
public getIcon(): string;
/**
* Returns a metadata object for class sap.m.QuickViewPage.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPageId pageId}.
*
* Page id
*
* Default value is
.
* @returns {string} Value of property pageId
*/
public getPageId(): string;
/**
* Gets current value of property {@link #getTitle title}.
*
* Specifies the text displayed in the header of the content section of the control.
*
* Default value is
.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getTitleUrl titleUrl}.
*
* Specifies the URL which opens when the title or the thumbnail is clicked.
*
* Default value is
.
* @returns {string} Value of property titleUrl
*/
public getTitleUrl(): string;
/**
* Checks for the provided sap.m.QuickViewGroup
in the aggregation {@link #getGroups groups}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.QuickViewGroup} oGroup - The group whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfGroup(oGroup: sap.m.QuickViewGroup): number;
/**
* Inserts a group into the aggregation {@link #getGroups groups}.
* @param {sap.m.QuickViewGroup} oGroup - the group to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the group should be inserted at; for a negative value of iIndex
, the group is inserted at position 0; for a value greater than the current size of the aggregation, the group is inserted at the last position
* @returns {sap.m.QuickViewPage} Reference to this
in order to allow method chaining
*/
public insertGroup(oGroup: sap.m.QuickViewGroup, iIndex: number): sap.m.QuickViewPage;
/**
* Removes all the controls from the aggregation {@link #getGroups groups}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.QuickViewGroup[]} An array of the removed elements (might be empty)
*/
public removeAllGroups(): sap.m.QuickViewGroup[];
/**
* Removes a group from the aggregation {@link #getGroups groups}.
* @param {number|string|sap.m.QuickViewGroup} vGroup - The group to remove or its index or id
* @returns {sap.m.QuickViewGroup} The removed group or null
*/
public removeGroup(vGroup: number|string|sap.m.QuickViewGroup): sap.m.QuickViewGroup;
/**
* Sets a new value for property {@link #getCrossAppNavCallback crossAppNavCallback}.
*
* Specifies the application which provides target and param configuration for cross-application navigation from the 'page header'.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oCrossAppNavCallback - New value for property crossAppNavCallback
* @returns {sap.m.QuickViewPage} Reference to this
in order to allow method chaining
*/
public setCrossAppNavCallback(oCrossAppNavCallback: any): sap.m.QuickViewPage;
/**
* Sets a new value for property {@link #getDescription description}.
*
* Specifies the text displayed under the header of the content section
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sDescription - New value for property description
* @returns {sap.m.QuickViewPage} Reference to this
in order to allow method chaining
*/
public setDescription(sDescription: string): sap.m.QuickViewPage;
/**
* Sets a new value for property {@link #getHeader header}.
*
* Specifies the text displayed in the header of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sHeader - New value for property header
* @returns {sap.m.QuickViewPage} Reference to this
in order to allow method chaining
*/
public setHeader(sHeader: string): sap.m.QuickViewPage;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Specifies the URL of the icon displayed under the header of the page
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sIcon - New value for property icon
* @returns {sap.m.QuickViewPage} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: string): sap.m.QuickViewPage;
/**
* Sets a new value for property {@link #getPageId pageId}.
*
* Page id
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sPageId - New value for property pageId
* @returns {sap.m.QuickViewPage} Reference to this
in order to allow method chaining
*/
public setPageId(sPageId: string): sap.m.QuickViewPage;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Specifies the text displayed in the header of the content section of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sTitle - New value for property title
* @returns {sap.m.QuickViewPage} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.QuickViewPage;
/**
* Sets a new value for property {@link #getTitleUrl titleUrl}.
*
* Specifies the URL which opens when the title or the thumbnail is clicked.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sTitleUrl - New value for property titleUrl
* @returns {sap.m.QuickViewPage} Reference to this
in order to allow method chaining
*/
public setTitleUrl(sTitleUrl: string): sap.m.QuickViewPage;
/**
* Unbinds aggregation {@link #getGroups groups} from model data.
* @returns {sap.m.QuickViewPage} Reference to this
in order to allow method chaining
*/
public unbindGroups(): sap.m.QuickViewPage;
}
/**
* RadioButton is a control similar to a {@link sap.m.CheckBox checkbox}, but it allows you to choose only one of the predefined set of options.
* Multiple radio buttons have to belong to the same group (have the same value for groupName
) in order to be mutually exclusive.
* A wrapper control {@link sap.m.RadioButtonGroup RadioButtonGroup} can be used instead of individual radio buttons.
* Structure
*
* - Radio buttons can have a value state like Error or Warning.
* - Radio buttons can be arranged vertically by setting the
column
to a number higher than 1.
* - Radio button options need to have a {@link sap.m.Label label}.
*
* Usage
* When to use:
*
* - You quickly need to choose between at least two alternatives.
* - You need to place other controls between the radio button options.
*
* When not to use:
*
* - You want to select multiple values for the same option. Use {@link sap.m.CheckBox checkboxes} instead.
* - When the default value is recommended for most users in most situations. Use a {@link sap.m.Select drop-down} instead as is saves space by not showing all the alternatives.
* - You want have more than 8 options. Use a {@link sap.m.Select drop-down} instead.
* - When the options are mutually exclusive e.g. ON/OFF. Use a {@link sap.m.Switch switch} instead.
* - Avoid using horizontally aligned radio buttons as they will be cut off on phones.
*
*/
export class RadioButton extends sap.ui.core.Control {
/**
* Constructor for a new RadioButton.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control Enables users to select a single option from a set of options.
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.RadioButton} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.RadioButton;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.RadioButton} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.RadioButton;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.RadioButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.RadioButton
itself.
*
* Event is triggered when the user makes a change on the radio button (selecting or unselecting it).
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.RadioButton
itself
* @returns {sap.m.RadioButton} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.m.RadioButton;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.RadioButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.RadioButton
itself.
*
* Event is triggered when the user makes a change on the radio button (selecting or unselecting it).
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.RadioButton
itself
* @returns {sap.m.RadioButton} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.m.RadioButton;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.m.RadioButton
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.RadioButton} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.m.RadioButton;
/**
* Destroys all related objects to the RadioButton
*/
public exit(): void;
/**
* Creates a new subclass of class sap.m.RadioButton with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.RadioButton} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.m.RadioButton;
/**
* Gets current value of property {@link #getActiveHandling activeHandling}.
*
* This is a flag to switch on activeHandling. When it is switched off,
* there will not be visual changes on active state. Default value is 'true'
*
* Default value is true
.
* @returns {boolean} Value of property activeHandling
*/
public getActiveHandling(): boolean;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEditable editable}.
*
* Specifies whether the user can select the radio button.
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Specifies if the radio button is disabled.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getGroupName groupName}.
*
* Name of the radio button group the current radio button belongs to. You can define a new name for the group.
* If no new name is specified, this radio button belongs to the sapMRbDefaultGroup per default. Default behavior of a radio button in a group is that when one of the radio buttons in a group is selected, all others are unselected.
*
* Default value is sapMRbDefaultGroup
.
* @returns {string} Value of property groupName
*/
public getGroupName(): string;
/**
* Returns a metadata object for class sap.m.RadioButton.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSelected selected}.
*
* Specifies the select state of the radio button
*
* Default value is false
.
* @returns {boolean} Value of property selected
*/
public getSelected(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* Specifies the text displayed next to the RadioButton
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextAlign textAlign}.
*
* Specifies the alignment of the radio button. Available alignment settings are "Begin", "Center", "End", "Left", and "Right".
*
* Default value is Begin
.
* @returns {sap.ui.core.TextAlign} Value of property textAlign
*/
public getTextAlign(): sap.ui.core.TextAlign;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Options for the text direction are RTL and LTR. Alternatively, the control can inherit the text direction from its parent container.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getUseEntireWidth useEntireWidth}.
*
* Indicates if the given width will be applied for the whole RadioButton or only it's label.
* By Default width is set only for the label.
*
* Default value is false
.
* @returns {boolean} Value of property useEntireWidth
*/
public getUseEntireWidth(): boolean;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Enumeration sap.ui.core.ValueState provides state values Error, Success, Warning, None
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the RadioButton or it's label depending on the useEntireWidth property.
* By Default width is set only for the label.
*
* Default value is
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Pseudo event for pseudo 'select' event... space, enter, ... without modifiers (Ctrl, Alt or Shift)
* @param {any} oEvent - provides information for the event
*/
public onsapselect(oEvent: any): void;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getActiveHandling activeHandling}.
*
* This is a flag to switch on activeHandling. When it is switched off,
* there will not be visual changes on active state. Default value is 'true'
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bActiveHandling - New value for property activeHandling
* @returns {sap.m.RadioButton} Reference to this
in order to allow method chaining
*/
public setActiveHandling(bActiveHandling: boolean): sap.m.RadioButton;
/**
* Method to set a RadioButton's state to active or inactive.
* @param {boolean} bActive - Sets the active state to true or false
*/
public setActiveState(bActive: boolean): void;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Specifies whether the user can select the radio button.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.m.RadioButton} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.m.RadioButton;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Specifies if the radio button is disabled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.RadioButton} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.RadioButton;
/**
* Sets RadioButton's groupName. Only one radioButton from the same group can be selected
* @param {string} sGroupName - Name of the group to which the RadioButton will belong.
* @returns {sap.m.RadioButton} Reference to the control instance for chaining
*/
public setGroupName(sGroupName: string): sap.m.RadioButton;
/**
* Sets the state of the RadioButton to selected.
* @param {boolean} bSelected - defines if the radio button is selected
* @returns {sap.m.RadioButton} Reference to the control instance for chaining
*/
public setSelected(bSelected: boolean): sap.m.RadioButton;
/**
* Sets the text for the RadioButton's label.
* @param {string} sText - The text to be set
* @returns {sap.m.RadioButton} Reference to the control instance for chaining
*/
public setText(sText: string): sap.m.RadioButton;
/**
* Sets a new value for property {@link #getTextAlign textAlign}.
*
* Specifies the alignment of the radio button. Available alignment settings are "Begin", "Center", "End", "Left", and "Right".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Begin
.
* @param {sap.ui.core.TextAlign} sTextAlign - New value for property textAlign
* @returns {sap.m.RadioButton} Reference to this
in order to allow method chaining
*/
public setTextAlign(sTextAlign: sap.ui.core.TextAlign): sap.m.RadioButton;
/**
* Sets the text direction for the RadioButton's label.
* @param {string} sDirection - Text direction to be set to RadioButton's label
* @returns {sap.m.RadioButton} Reference to the control instance for chaining
*/
public setTextDirection(sDirection: string): sap.m.RadioButton;
/**
* Sets a new value for property {@link #getUseEntireWidth useEntireWidth}.
*
* Indicates if the given width will be applied for the whole RadioButton or only it's label.
* By Default width is set only for the label.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bUseEntireWidth - New value for property useEntireWidth
* @returns {sap.m.RadioButton} Reference to this
in order to allow method chaining
*/
public setUseEntireWidth(bUseEntireWidth: boolean): sap.m.RadioButton;
/**
* Sets a new value for property {@link #getValueState valueState}.
*
* Enumeration sap.ui.core.ValueState provides state values Error, Success, Warning, None
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sValueState - New value for property valueState
* @returns {sap.m.RadioButton} Reference to this
in order to allow method chaining
*/
public setValueState(sValueState: sap.ui.core.ValueState): sap.m.RadioButton;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of the RadioButton or it's label depending on the useEntireWidth property.
* By Default width is set only for the label.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.RadioButton} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.RadioButton;
}
/**
* This control is used as a wrapper for a group of {@link sap.m.RadioButton} controls, which can be used as a single UI element.
* You can select only one of the grouped radio buttons at a time.
* Structure
*
* - The radio buttons are stored in the
buttons
aggregation.
* - By setting the
columns
property, you can create layouts like a 'matrix', 'vertical' or 'horizontal'.
* - Note:For proper display on all devices, we recommend creating radio button groups with only one row or only one column.
*
* Usage
* When to use:
*
* - You want to attach a single event handler on a group of buttons, rather than on each individual button.
*
* When not to use:
*
* - Do not put two radio button groups right next to each other as it is difficult to determine which buttons belong to which group.
*
*/
export class RadioButtonGroup extends sap.ui.core.Control {
/**
* Constructor for a new RadioButtonGroup.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control A wrapper control for a group of radio buttons.
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.RadioButtonGroup;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.RadioButtonGroup;
/**
* Adds a new radio button to the group.
* @param {sap.m.RadioButton} oButton - The button which will be added to the group
* @returns {sap.m.RadioButtonGroup} Pointer to the control instance for chaining
*/
public addButton(oButton: sap.m.RadioButton): sap.m.RadioButtonGroup;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.RadioButtonGroup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.RadioButtonGroup
itself.
*
* Fires when selection is changed by user interaction.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.RadioButtonGroup
itself
* @returns {sap.m.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.m.RadioButtonGroup;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.RadioButtonGroup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.RadioButtonGroup
itself.
*
* Fires when selection is changed by user interaction.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.RadioButtonGroup
itself
* @returns {sap.m.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.m.RadioButtonGroup;
/**
* Binds aggregation {@link #getButtons buttons} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public bindButtons(oBindingInfo: any): sap.m.RadioButtonGroup;
/**
* Creates a new instance of RadioButtonGroup, with the same settings as the RadioButtonGroup
* on which the method is called.
* Event handlers are not cloned.
* @returns {sap.m.RadioButtonGroup} New instance of RadioButtonGroup
*/
public clone(): sap.m.RadioButtonGroup;
/**
* Destroys all radio buttons.
* @returns {sap.m.RadioButtonGroup} Pointer to the control instance for chaining
*/
public destroyButtons(): sap.m.RadioButtonGroup;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.m.RadioButtonGroup
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.m.RadioButtonGroup;
/**
* Creates a new subclass of class sap.m.RadioButtonGroup with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.m.RadioButtonGroup;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets content of aggregation {@link #getButtons buttons}.
*
* Returns a list of the RadioButtons in a RadioButtonGroup
* @returns {sap.m.RadioButton[]}
*/
public getButtons(): sap.m.RadioButton[];
/**
* Gets current value of property {@link #getColumns columns}.
*
* Specifies the maximum number of radio buttons displayed in one line.
*
* Default value is 1
.
* @returns {number} Value of property columns
*/
public getColumns(): number;
/**
* Gets current value of property {@link #getEditable editable}.
*
* Specifies whether the user can change the selected value of the RadioButtonGroup.
* When the property is set to false, the control obtains visual styles
* different from its visual styles for the normal and the disabled state.
* Additionally, the control is no longer interactive, but can receive focus.
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Switches the enabled state of the control. All Radio Buttons inside a disabled group are disabled. Default value is “true”.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Returns a metadata object for class sap.m.RadioButtonGroup.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the selected radio button.
* @returns {sap.m.RadioButton} The selected radio button
*/
public getSelectedButton(): sap.m.RadioButton;
/**
* Gets current value of property {@link #getSelectedIndex selectedIndex}.
*
* Determines the index of the selected/checked RadioButton. Default is 0.
* If no radio button is selected, the selectedIndex property will return -1.
*
* Default value is 0
.
* @returns {number} Value of property selectedIndex
*/
public getSelectedIndex(): number;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* This property specifies the element's text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Тhe value state to be displayed for the radio button. Possible values are: sap.ui.core.ValueState.Error,
* sap.ui.core.ValueState.Warning, sap.ui.core.ValueState.Success and sap.ui.core.ValueState.None.
* Note: Setting this attribute to sap.ui.core.ValueState.Error when the accessibility feature is enabled,
* sets the value of the invalid propery for the whole RadioButtonGroup to “true”.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getWidth width}.
*
* Specifies the width of the RadioButtonGroup.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.m.RadioButton
in the aggregation {@link #getButtons buttons}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.RadioButton} oButton - The button whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfButton(oButton: sap.m.RadioButton): number;
/**
* Adds a new radio button to the group at a specified index.
* @param {sap.m.RadioButton} oButton - The radio button which will be added to the group
* @param {number} iIndex - The index, at which the radio button will be added
* @returns {sap.m.RadioButtonGroup} Pointer to the control instance for chaining
*/
public insertButton(oButton: sap.m.RadioButton, iIndex: number): sap.m.RadioButtonGroup;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all radio buttons.
* @returns {any[]} Array of removed buttons or null
*/
public removeAllButtons(): any[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a radio button from the group.
* @returns {sap.m.RadioButton} The removed radio button
*/
public removeButton(): sap.m.RadioButton;
/**
* Sets a new value for property {@link #getColumns columns}.
*
* Specifies the maximum number of radio buttons displayed in one line.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} iColumns - New value for property columns
* @returns {sap.m.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public setColumns(iColumns: number): sap.m.RadioButtonGroup;
/**
* Sets the editable property of the RadioButtonGroup. Single buttons preserve the value of their editable property.
* If the group is set to editable=false the buttons are also displayed and function as read only.
* Non editable radio buttons can still obtain focus.
* @param {boolean} bEditable - Defines whether the radio buttons should be interactive.
* @returns {sap.m.RadioButtonGroup} Pointer to the control instance for chaining
*/
public setEditable(bEditable: boolean): sap.m.RadioButtonGroup;
/**
* Sets the enabled property of the RadioButtonGroup. Single buttons preserve internally the value of their enabled property.
* If the group is set to enabled=false the buttons are also displayed as disabled and getEnabled returns false.
* @param {boolean} bEnabled - Defines whether the radio buttons should be interactive.
* @returns {sap.m.RadioButtonGroup} Pointer to the control instance for chaining
*/
public setEnabled(bEnabled: boolean): sap.m.RadioButtonGroup;
/**
* Sets the selected sap.m.RadioButton using sap.m.RadioButton.
* @param {sap.m.RadioButton} oSelectedButton - The item to be selected
* @returns {sap.m.RadioButtonGroup} Pointer to the control instance for chaining
*/
public setSelectedButton(oSelectedButton: sap.m.RadioButton): sap.m.RadioButtonGroup;
/**
* Sets the selected sap.m.RadioButton using index.
* @param {number} iSelectedIndex - The index of the radio button which has to be selected
* @returns {sap.m.RadioButtonGroup} Pointer to the control instance for chaining
*/
public setSelectedIndex(iSelectedIndex: number): sap.m.RadioButtonGroup;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* This property specifies the element's text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.RadioButtonGroup;
/**
* Sets ValueState of all radio buttons in the group.
* @param {string} sValueState - The value state of the radio group - none, success, warning, error.
* @returns {sap.m.RadioButtonGroup} Pointer to the control instance for chaining
*/
public setValueState(sValueState: string): sap.m.RadioButtonGroup;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Specifies the width of the RadioButtonGroup.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.RadioButtonGroup;
/**
* Unbinds aggregation {@link #getButtons buttons} from model data.
* @returns {sap.m.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public unbindButtons(): sap.m.RadioButtonGroup;
}
/**
* Overview
*
* A {@link sap.m.RangeSlider} control represents a numerical interval and two handles to select a sub-range within it.
* The purpose of the control is to enable visual selection of sub-ranges within a given interval.
*
* Notes:
*
* - The RangeSlider extends the functionality of the {@link sap.m.Slider Slider}
* - The right and left handle can be moved individually and their positions could therefore switch.
* - The entire range can be moved along the interval.
* - The right and left handle can select the same value
*
* Usage
*
* The most common usecase is to select and move sub-ranges on a continuous numerical scale.
*
* Responsive Behavior
*
* You can move the currently selected range by clicking on it and dragging it along the interval.
*/
export class RangeSlider extends sap.m.Slider {
/**
* Constructor for a new RangeSlider
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.RangeSlider with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.Slider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.RangeSlider.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRange range}.
*
* Determines the currently selected range on the slider.
*
* If the value is lower/higher than the allowed minimum/maximum, a warning message will be output to the console.
*
* Default value is [0,100]
.
* @returns {number[]} Value of property range
*/
public getRange(): number[];
/**
* Gets current value of property {@link #getValue2 value2}.
*
* Current second value of the slider. (Position of the second handle.)
*
* Note: If the value is not in the valid range (between min
and max
) it will be changed to be in the valid range.
* If it is smaller than value
it will be set to the same value.
*
* Default value is 100
.
* @returns {number} Value of property value2
*/
public getValue2(): number;
/**
* Sets a new value for property {@link #getRange range}.
*
* Determines the currently selected range on the slider.
*
* If the value is lower/higher than the allowed minimum/maximum, a warning message will be output to the console.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is [0,100]
.
* @param {number[]} sRange - New value for property range
* @returns {sap.m.RangeSlider} Reference to this
in order to allow method chaining
*/
public setRange(sRange: number[]): sap.m.RangeSlider;
/**
* Sets a new value for property {@link #getValue2 value2}.
*
* Current second value of the slider. (Position of the second handle.)
*
* Note: If the value is not in the valid range (between min
and max
) it will be changed to be in the valid range.
* If it is smaller than value
it will be set to the same value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100
.
* @param {number} fValue2 - New value for property value2
* @returns {sap.m.RangeSlider} Reference to this
in order to allow method chaining
*/
public setValue2(fValue2: number): sap.m.RangeSlider;
}
/**
* The rating indicator is used to display a specific number of icons that are used to rate an item. Additionally it is also used to display the average over all ratings.
* Structure
*
* - The rating indicator can use different icons (default: stars) which are defined as URIs in the properties
iconHovered
, iconSelected
and iconUnselected
.
* - The rating indicator can display half-values ({@link sap.m.RatingIndicatorVisualMode visualMode} = Half) when it is used to show the average. Half-values can't be selected by the user.
*
* Usage
* The preferred number of icons is between 5 (default) and 7.
* Responsive Behavior
* You can display icons in 4 recommended sizes:
*
* - large - 32px
* - medium(default) - 22px
* - small - 16px
* - XS - 12px
*
* Note: If no icon size is set, the rating indicator will set it according to the content density.
*/
export class RatingIndicator extends sap.ui.core.Control {
/**
* Constructor for a new RatingIndicator.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control Enables users to rate an item on a numeric scale.
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.RatingIndicator;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.RatingIndicator;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.RatingIndicator
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.RatingIndicator
itself.
*
* The event is fired when the user has done a rating.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.RatingIndicator
itself
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.m.RatingIndicator;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.RatingIndicator
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.RatingIndicator
itself.
*
* The event is fired when the user has done a rating.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.RatingIndicator
itself
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.m.RatingIndicator;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.m.RatingIndicator
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.RatingIndicator
itself.
*
* This event is triggered during the dragging period, each time the rating value changes.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.RatingIndicator
itself
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public attachLiveChange(fnFunction: Function, oListener?: any): sap.m.RatingIndicator;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.m.RatingIndicator
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.RatingIndicator
itself.
*
* This event is triggered during the dragging period, each time the rating value changes.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.RatingIndicator
itself
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public attachLiveChange(oData: any, fnFunction: Function, oListener?: any): sap.m.RatingIndicator;
/**
* Binds property {@link #getValue value} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a
* detailed description of the possible properties of oBindingInfo
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public bindValue(oBindingInfo: any): sap.m.RatingIndicator;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.m.RatingIndicator
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.m.RatingIndicator;
/**
* Detaches event handler fnFunction
from the {@link #event:liveChange liveChange} event of this sap.m.RatingIndicator
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public detachLiveChange(fnFunction: Function, oListener: any): sap.m.RatingIndicator;
/**
* Creates a new subclass of class sap.m.RatingIndicator with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.m.RatingIndicator;
/**
* Fires event {@link #event:liveChange liveChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
protected fireLiveChange(mParameters?: any): sap.m.RatingIndicator;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Value "true" is required to let the user rate with this control. It is recommended to set this parameter to "false" for the "Small" size which is meant for indicating a value only
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getIconHovered iconHovered}.
*
* The URI to the icon font icon or image that will be displayed for hovered rating symbols. A star icon will be used if the property is not set
* @returns {sap.ui.core.URI} Value of property iconHovered
*/
public getIconHovered(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconSelected iconSelected}.
*
* The URI to the icon font icon or image that will be displayed for selected rating symbols. A star icon will be used if the property is not set
* @returns {sap.ui.core.URI} Value of property iconSelected
*/
public getIconSelected(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconSize iconSize}.
*
* The Size of the image or icon to be displayed. The default value depends on the theme. Please be sure that the size is corresponding to a full pixel value as some browsers don't support subpixel calculations. Recommended size is 1.375rem (22px) for normal, 1rem (16px) for small, and 2rem (32px) for large icons correspondingly.
* @returns {sap.ui.core.CSSSize} Value of property iconSize
*/
public getIconSize(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getIconUnselected iconUnselected}.
*
* The URI to the icon font icon or image that will be displayed for all unselected rating symbols. A star icon will be used if the property is not set
* @returns {sap.ui.core.URI} Value of property iconUnselected
*/
public getIconUnselected(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getMaxValue maxValue}.
*
* The number of displayed rating symbols
*
* Default value is 5
.
* @returns {number} Value of property maxValue
*/
public getMaxValue(): number;
/**
* Returns a metadata object for class sap.m.RatingIndicator.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getValue value}.
*
* The indicated value of the rating
*
* Default value is 0
.
* @returns {number} Value of property value
*/
public getValue(): number;
/**
* Gets current value of property {@link #getVisualMode visualMode}.
*
* Defines how float values are visualized: Full, Half (see enumeration RatingIndicatorVisualMode)
*
* Default value is Half
.
* @returns {sap.m.RatingIndicatorVisualMode} Value of property visualMode
*/
public getVisualMode(): sap.m.RatingIndicatorVisualMode;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Value "true" is required to let the user rate with this control. It is recommended to set this parameter to "false" for the "Small" size which is meant for indicating a value only
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.RatingIndicator;
/**
* Sets a new value for property {@link #getIconHovered iconHovered}.
*
* The URI to the icon font icon or image that will be displayed for hovered rating symbols. A star icon will be used if the property is not set
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIconHovered - New value for property iconHovered
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public setIconHovered(sIconHovered: sap.ui.core.URI): sap.m.RatingIndicator;
/**
* Sets a new value for property {@link #getIconSelected iconSelected}.
*
* The URI to the icon font icon or image that will be displayed for selected rating symbols. A star icon will be used if the property is not set
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIconSelected - New value for property iconSelected
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public setIconSelected(sIconSelected: sap.ui.core.URI): sap.m.RatingIndicator;
/**
* Sets the icon size value. The method is automatically updating the UI components if the control has been rendered before.
* @param {sap.ui.core.CSSSize} sIconSize
* @returns {sap.m.RatingIndicator} Returns this
to facilitate method chaining.
*/
public setIconSize(sIconSize: sap.ui.core.CSSSize): sap.m.RatingIndicator;
/**
* Sets a new value for property {@link #getIconUnselected iconUnselected}.
*
* The URI to the icon font icon or image that will be displayed for all unselected rating symbols. A star icon will be used if the property is not set
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIconUnselected - New value for property iconUnselected
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public setIconUnselected(sIconUnselected: sap.ui.core.URI): sap.m.RatingIndicator;
/**
* Sets a new value for property {@link #getMaxValue maxValue}.
*
* The number of displayed rating symbols
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 5
.
* @param {number} iMaxValue - New value for property maxValue
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public setMaxValue(iMaxValue: number): sap.m.RatingIndicator;
/**
* Sets the rating value. The method is automatically checking whether the value is in the valid range of 0-{@link #getMaxValue maxValue} and if it is a valid number. Calling the setter with null or undefined will reset the value to it's default.
* @param {number} fValue - The rating value to be set.
* @returns {sap.m.RatingIndicator} Returns this
to facilitate method chaining.
*/
public setValue(fValue: number): sap.m.RatingIndicator;
/**
* Sets a new value for property {@link #getVisualMode visualMode}.
*
* Defines how float values are visualized: Full, Half (see enumeration RatingIndicatorVisualMode)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Half
.
* @param {sap.m.RatingIndicatorVisualMode} sVisualMode - New value for property visualMode
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public setVisualMode(sVisualMode: sap.m.RatingIndicatorVisualMode): sap.m.RatingIndicator;
/**
* Unbinds property {@link #getValue value} from model data.
* @returns {sap.m.RatingIndicator} Reference to this
in order to allow method chaining
*/
public unbindValue(): sap.m.RatingIndicator;
}
/**
* Possible values for the visualization of float values in the RatingIndicator Control.
*/
export enum RatingIndicatorVisualMode {
/**
* Values are rounded to the nearest integer value (e.g. 1.7 -> 2).
*/
Full = "Full",
/**
* Values are rounded to the nearest half value (e.g. 1.7 -> 1.5).
*/
Half = "Half",
}
/**
* The responsive popover acts as a {@link sap.m.Popover popover} on desktop and tablet,
* while on phone it acts as a {@ link sap.m.Dialog dialog} with stretch
set to true.
* Usage
* When you want to make sure that all content is visible on any device.
*/
export class ResponsivePopover extends sap.ui.core.Control {
/**
* Constructor for a new ResponsivePopover.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control A popover-based control that behaves differently according to the device it is on.
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.ResponsivePopover;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.ResponsivePopover;
/**
* Adds content to the ResponsivePopover
* @param {sap.ui.core.Control} oControl - The control to be added to the content
*/
public addContent(oControl: sap.ui.core.Control): void;
/**
* Attaches event handler fnFunction
to the {@link #event:afterClose afterClose} event of this sap.m.ResponsivePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ResponsivePopover
itself.
*
* Event is fired after popover or dialog is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ResponsivePopover
itself
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public attachAfterClose(fnFunction: Function, oListener?: any): sap.m.ResponsivePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:afterClose afterClose} event of this sap.m.ResponsivePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ResponsivePopover
itself.
*
* Event is fired after popover or dialog is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ResponsivePopover
itself
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public attachAfterClose(oData: any, fnFunction: Function, oListener?: any): sap.m.ResponsivePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:afterOpen afterOpen} event of this sap.m.ResponsivePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ResponsivePopover
itself.
*
* Event is fired after popover or dialog is open.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ResponsivePopover
itself
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public attachAfterOpen(fnFunction: Function, oListener?: any): sap.m.ResponsivePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:afterOpen afterOpen} event of this sap.m.ResponsivePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ResponsivePopover
itself.
*
* Event is fired after popover or dialog is open.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ResponsivePopover
itself
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public attachAfterOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.ResponsivePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.ResponsivePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ResponsivePopover
itself.
*
* Event is fired before popover or dialog is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ResponsivePopover
itself
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public attachBeforeClose(fnFunction: Function, oListener?: any): sap.m.ResponsivePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.ResponsivePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ResponsivePopover
itself.
*
* Event is fired before popover or dialog is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ResponsivePopover
itself
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public attachBeforeClose(oData: any, fnFunction: Function, oListener?: any): sap.m.ResponsivePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.ResponsivePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ResponsivePopover
itself.
*
* Event is fired before popover or dialog is open.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ResponsivePopover
itself
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(fnFunction: Function, oListener?: any): sap.m.ResponsivePopover;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.ResponsivePopover
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ResponsivePopover
itself.
*
* Event is fired before popover or dialog is open.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ResponsivePopover
itself
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.ResponsivePopover;
/**
* Creates a new instance of ResponsivePopover with the same settings as the ResponsivePopover on which the method is called
* @returns {sap.m.ResponsivePopover} New instance of ResponsivePopover
*/
public clone(): sap.m.ResponsivePopover;
/**
* Closes the ResponsivePopover.
* @returns {sap.ui.core.Control}
*/
public close(): sap.ui.core.Control;
/**
* Destroys the beginButton in the aggregation {@link #getBeginButton beginButton}.
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public destroyBeginButton(): sap.m.ResponsivePopover;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.ResponsivePopover;
/**
* Destroys the customHeader in the aggregation {@link #getCustomHeader customHeader}.
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public destroyCustomHeader(): sap.m.ResponsivePopover;
/**
* Destroys the endButton in the aggregation {@link #getEndButton endButton}.
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public destroyEndButton(): sap.m.ResponsivePopover;
/**
* Destroys the subHeader in the aggregation {@link #getSubHeader subHeader}.
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public destroySubHeader(): sap.m.ResponsivePopover;
/**
* Detaches event handler fnFunction
from the {@link #event:afterClose afterClose} event of this sap.m.ResponsivePopover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public detachAfterClose(fnFunction: Function, oListener: any): sap.m.ResponsivePopover;
/**
* Detaches event handler fnFunction
from the {@link #event:afterOpen afterOpen} event of this sap.m.ResponsivePopover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public detachAfterOpen(fnFunction: Function, oListener: any): sap.m.ResponsivePopover;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeClose beforeClose} event of this sap.m.ResponsivePopover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public detachBeforeClose(fnFunction: Function, oListener: any): sap.m.ResponsivePopover;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeOpen beforeOpen} event of this sap.m.ResponsivePopover
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public detachBeforeOpen(fnFunction: Function, oListener: any): sap.m.ResponsivePopover;
/**
* Creates a new subclass of class sap.m.ResponsivePopover with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:afterClose afterClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
protected fireAfterClose(mParameters?: any): sap.m.ResponsivePopover;
/**
* Fires event {@link #event:afterOpen afterOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
protected fireAfterOpen(mParameters?: any): sap.m.ResponsivePopover;
/**
* Fires event {@link #event:beforeClose beforeClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
protected fireBeforeClose(mParameters?: any): sap.m.ResponsivePopover;
/**
* Fires event {@link #event:beforeOpen beforeOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
protected fireBeforeOpen(mParameters?: any): sap.m.ResponsivePopover;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Getter for beginButton aggregation
* @returns {sap.m.Button} The button that is set as a beginButton aggregation
*/
public getBeginButton(): sap.m.Button;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Content is supported by both variants. Please see the documentation on sap.m.Popover#content and sap.m.Dialog#content
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getContentHeight contentHeight}.
*
* This property is supported by both variants. Please see the documentation on sap.m.Popover#contentHeight and sap.m.Dialog#contentHeight
* @returns {sap.ui.core.CSSSize} Value of property contentHeight
*/
public getContentHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getContentWidth contentWidth}.
*
* This property is supported by both variants. Please see the documentation on sap.m.Popover#contentWidth and sap.m.Dialog#contentWidth
* @returns {sap.ui.core.CSSSize} Value of property contentWidth
*/
public getContentWidth(): sap.ui.core.CSSSize;
/**
* Gets content of aggregation {@link #getCustomHeader customHeader}.
*
* CustomHeader is supported by both variants. Please see the documentation on sap.m.Popover#customHeader and sap.m.Dialog#customHeader
* @returns {sap.m.IBar}
*/
public getCustomHeader(): sap.m.IBar;
/**
* Getter for endButton aggregation
* @returns {sap.m.Button} The button that is set as an endButton aggregation
*/
public getEndButton(): sap.m.Button;
/**
* Gets current value of property {@link #getHorizontalScrolling horizontalScrolling}.
*
* This property is supported by both variants. Please see the documentation on sap.m.Popover#horizontalScrolling and sap.m.Dialog#horizontalScrolling
*
* Default value is true
.
* @returns {boolean} Value of property horizontalScrolling
*/
public getHorizontalScrolling(): boolean;
/**
* Gets current value of property {@link #getIcon icon}.
*
* This property only takes effect on phone. Please see the documentation sap.m.Dialog#icon.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* ID of the element which is the current target of the association {@link #getInitialFocus initialFocus}, or null
.
* @returns {sap.ui.core.ID}
*/
public getInitialFocus(): sap.ui.core.ID;
/**
* Returns a metadata object for class sap.m.ResponsivePopover.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getModal modal}.
*
* This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#modal.
* @returns {boolean} Value of property modal
*/
public getModal(): boolean;
/**
* Gets current value of property {@link #getOffsetX offsetX}.
*
* This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetX.
* @returns {number} Value of property offsetX
*/
public getOffsetX(): number;
/**
* Gets current value of property {@link #getOffsetY offsetY}.
*
* This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetY.
* @returns {number} Value of property offsetY
*/
public getOffsetY(): number;
/**
* Gets current value of property {@link #getPlacement placement}.
*
* This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#placement.
*
* Default value is Right
.
* @returns {sap.m.PlacementType} Value of property placement
*/
public getPlacement(): sap.m.PlacementType;
/**
* Gets current value of property {@link #getResizable resizable}.
*
* Whether resize option is enabled.
*
* Default value is false
.
* @returns {boolean} Value of property resizable
*/
public getResizable(): boolean;
/**
* Gets current value of property {@link #getShowArrow showArrow}.
*
* This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#showArrow.
*
* Default value is true
.
* @returns {boolean} Value of property showArrow
*/
public getShowArrow(): boolean;
/**
* Gets current value of property {@link #getShowCloseButton showCloseButton}.
*
* Determines if a close button should be inserted into the dialog's header dynamically to close the dialog. This property only takes effect on phone.
*
* Default value is true
.
* @returns {boolean} Value of property showCloseButton
*/
public getShowCloseButton(): boolean;
/**
* Gets current value of property {@link #getShowHeader showHeader}.
*
* This property is supported by both variants. Please see the documentation on sap.m.Popover#showHeader and sap.m.Dialog#showHeader
*
* Default value is true
.
* @returns {boolean} Value of property showHeader
*/
public getShowHeader(): boolean;
/**
* Gets content of aggregation {@link #getSubHeader subHeader}.
*
* SubHeader is supported by both variants. Please see the documentation on sap.m.Popover#subHeader and sap.m.Dialog#subHeader
* @returns {sap.m.IBar}
*/
public getSubHeader(): sap.m.IBar;
/**
* Gets current value of property {@link #getTitle title}.
*
* This property is supported by both variants. Please see the documentation on sap.m.Popover#title and sap.m.Dialog#title
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getVerticalScrolling verticalScrolling}.
*
* This property is supported by both variants. Please see the documentation on sap.m.Popover#verticalScrolling and sap.m.Dialog#verticalScrolling
*
* Default value is true
.
* @returns {boolean} Value of property verticalScrolling
*/
public getVerticalScrolling(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.ResponsivePopover;
/**
* Checks whether the ResponsivePopover is currently open.
* @returns {sap.ui.core.Control}
*/
public isOpen(): sap.ui.core.Control;
/**
* Opens the ResponsivePopover. The ResponsivePopover is positioned relatively to the control parameter on tablet or desktop and is full screen on phone. Therefore the control parameter is only used on tablet or desktop and is ignored on phone.
* @param {any} oControl - When this control is displayed on tablet or desktop, the ResponsivePopover is positioned relatively to this control.
* @returns {sap.ui.core.Control}
*/
public openBy(oControl: any): sap.ui.core.Control;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Setter for beginButton aggregation
* @param {sap.m.Button} oButton - The button that will be set as an aggregation
* @returns {sap.m.ResponsivePopover} Pointer to the control instance for chaining
*/
public setBeginButton(oButton: sap.m.Button): sap.m.ResponsivePopover;
/**
* Sets a new value for property {@link #getContentHeight contentHeight}.
*
* This property is supported by both variants. Please see the documentation on sap.m.Popover#contentHeight and sap.m.Dialog#contentHeight
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sContentHeight - New value for property contentHeight
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setContentHeight(sContentHeight: sap.ui.core.CSSSize): sap.m.ResponsivePopover;
/**
* Sets a new value for property {@link #getContentWidth contentWidth}.
*
* This property is supported by both variants. Please see the documentation on sap.m.Popover#contentWidth and sap.m.Dialog#contentWidth
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sContentWidth - New value for property contentWidth
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setContentWidth(sContentWidth: sap.ui.core.CSSSize): sap.m.ResponsivePopover;
/**
* Sets the aggregated {@link #getCustomHeader customHeader}.
* @param {sap.m.IBar} oCustomHeader - The customHeader to set
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setCustomHeader(oCustomHeader: sap.m.IBar): sap.m.ResponsivePopover;
/**
* Setter for endButton aggregation
* @param {sap.m.Button} oButton - The button that will be set as an aggregation
* @returns {sap.m.ResponsivePopover} Pointer to the control instance for chaining
*/
public setEndButton(oButton: sap.m.Button): sap.m.ResponsivePopover;
/**
* Sets a new value for property {@link #getHorizontalScrolling horizontalScrolling}.
*
* This property is supported by both variants. Please see the documentation on sap.m.Popover#horizontalScrolling and sap.m.Dialog#horizontalScrolling
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bHorizontalScrolling - New value for property horizontalScrolling
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setHorizontalScrolling(bHorizontalScrolling: boolean): sap.m.ResponsivePopover;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* This property only takes effect on phone. Please see the documentation sap.m.Dialog#icon.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.ResponsivePopover;
/**
* Sets the associated {@link #getInitialFocus initialFocus}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oInitialFocus - ID of an element which becomes the new target of this initialFocus association; alternatively, an element instance may be given
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setInitialFocus(oInitialFocus: sap.ui.core.ID|sap.ui.core.Control): sap.m.ResponsivePopover;
/**
* Sets a new value for property {@link #getModal modal}.
*
* This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#modal.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bModal - New value for property modal
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setModal(bModal: boolean): sap.m.ResponsivePopover;
/**
* Sets a new value for property {@link #getOffsetX offsetX}.
*
* This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetX.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iOffsetX - New value for property offsetX
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setOffsetX(iOffsetX: number): sap.m.ResponsivePopover;
/**
* Sets a new value for property {@link #getOffsetY offsetY}.
*
* This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetY.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iOffsetY - New value for property offsetY
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setOffsetY(iOffsetY: number): sap.m.ResponsivePopover;
/**
* Sets a new value for property {@link #getPlacement placement}.
*
* This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#placement.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Right
.
* @param {sap.m.PlacementType} sPlacement - New value for property placement
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setPlacement(sPlacement: sap.m.PlacementType): sap.m.ResponsivePopover;
/**
* Sets a new value for property {@link #getResizable resizable}.
*
* Whether resize option is enabled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bResizable - New value for property resizable
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setResizable(bResizable: boolean): sap.m.ResponsivePopover;
/**
* Sets a new value for property {@link #getShowArrow showArrow}.
*
* This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#showArrow.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowArrow - New value for property showArrow
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setShowArrow(bShowArrow: boolean): sap.m.ResponsivePopover;
/**
* Determines if the close button to the ResponsivePopover is shown or not. Works only when ResponsivePopover is used as a dialog
* @param {boolean} bShowCloseButton - Defines whether the close button is shown
* @returns {sap.m.ResponsivePopover} Pointer to the control instance for chaining
*/
public setShowCloseButton(bShowCloseButton: boolean): sap.m.ResponsivePopover;
/**
* Sets a new value for property {@link #getShowHeader showHeader}.
*
* This property is supported by both variants. Please see the documentation on sap.m.Popover#showHeader and sap.m.Dialog#showHeader
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowHeader - New value for property showHeader
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setShowHeader(bShowHeader: boolean): sap.m.ResponsivePopover;
/**
* Sets the aggregated {@link #getSubHeader subHeader}.
* @param {sap.m.IBar} oSubHeader - The subHeader to set
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setSubHeader(oSubHeader: sap.m.IBar): sap.m.ResponsivePopover;
/**
* Sets a new value for property {@link #getTitle title}.
*
* This property is supported by both variants. Please see the documentation on sap.m.Popover#title and sap.m.Dialog#title
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.ResponsivePopover;
/**
* Sets a new value for property {@link #getVerticalScrolling verticalScrolling}.
*
* This property is supported by both variants. Please see the documentation on sap.m.Popover#verticalScrolling and sap.m.Dialog#verticalScrolling
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVerticalScrolling - New value for property verticalScrolling
* @returns {sap.m.ResponsivePopover} Reference to this
in order to allow method chaining
*/
public setVerticalScrolling(bVerticalScrolling: boolean): sap.m.ResponsivePopover;
}
/**
* Overview
*
* A {@link sap.m.Slider} element represents a scale with tickmarks and labels.
* The purpose of the element is to decouple the scale logic from other controls i.e. Slider / RangeSlider
*
*
* The most important properties of the ResponsiveScale are:
*
* - tickmarksBetweenLabels - Puts a label on every N-th tickmark.
*
*/
export class ResponsiveScale extends sap.ui.core.Element {
/**
* Constructor for a new ResponsiveScale
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.ResponsiveScale with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.ResponsiveScale.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTickmarksBetweenLabels tickmarksBetweenLabels}.
*
* Put a label on every N-th tickmark.
*
* Default value is 0
.
* @returns {number} Value of property tickmarksBetweenLabels
*/
public getTickmarksBetweenLabels(): number;
/**
* Sets a new value for property {@link #getTickmarksBetweenLabels tickmarksBetweenLabels}.
*
* Put a label on every N-th tickmark.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iTickmarksBetweenLabels - New value for property tickmarksBetweenLabels
* @returns {sap.m.ResponsiveScale} Reference to this
in order to allow method chaining
*/
public setTickmarksBetweenLabels(iTickmarksBetweenLabels: number): sap.m.ResponsiveScale;
}
/**
*/
namespace routing {
/**
* This class will attach to the Events of a provided router and add the views created by it to a {@link sap.m.SplitContainer} or a {@link sap.m.NavContainer} Control, if this is the target control of the route.
* If the targetControl is no {@link sap.m.SplitContainer} or a {@link sap.m.NavContainer}, It will only close the dialogs, according to the property value.
*
* When a navigation is triggered, this class will try to determine the transition of the pages based on the history.
* Eg: if a user presses browser back, it will show a backwards animation.
*
* The navigation on the container takes place in the RoutePatternMatched event of the Router. If you register on the RouteMatched event of the Router, the visual navigation did not take place yet.
*
* Since it is hard to detect if a user has pressed browser back, this transitions will not be reliable, for example if someone bookmarked a detail page, and wants to navigate to a masterPage.
* If you want this case to always show a backwards transition, you should specify a "viewLevel" property on your Route.
* The viewLevel has to be an integer. The Master should have a lower number than the detail.
* These levels should represent the user process of your application and they do not have to match the container structure of your Routes.
* If the user navigates between views with the same viewLevel, the history is asked for the direction.
*
* You can specify a property "transition" in a route to define which transition will be applied when navigating. If it is not defined, the nav container will take its default transition.
*
* You can also specify "transitionParameters" on a Route, to give the transition parameters.
*
* preservePageInSplitContainer is deprecated since 1.28 since Targets make this parameter obsolete.
* If you want to preserve the current view when navigating, but you want to navigate to it when nothing is displayed in the navContainer, you can set preservePageInSplitContainer = true
* When the route that has this flag directly matches the pattern, the view will still be switched by the splitContainer.
*
*/
export class RouteMatchedHandler {
/**
* Instantiates a RouteMatchedHandler.
* @param {sap.ui.core.routing.Router} router - A router that creates views
* @param {boolean} closeDialogs - the default is true - will close all open dialogs before navigating, if set to true. If set to false it will just navigate without closing dialogs.
*/
public constructor(router: sap.ui.core.routing.Router, closeDialogs: boolean);
/**
* Removes the routeMatchedHandler from the Router
* @returns {sap.m.routing.RouteMatchedHandler} for chaining
*/
public destroy(): sap.m.routing.RouteMatchedHandler;
/**
* Creates a new subclass of class sap.m.routing.RouteMatchedHandler with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets if a navigation should close dialogs
* @returns {boolean} a flag indication if dialogs will be closed
*/
public getCloseDialogs(): boolean;
/**
* Returns a metadata object for class sap.m.routing.RouteMatchedHandler.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets if a navigation should close dialogs
* @param {boolean} bCloseDialogs - close dialogs if true
* @returns {sap.m.routing.RouteMatchedHandler} for chaining
*/
public setCloseDialogs(bCloseDialogs: boolean): sap.m.routing.RouteMatchedHandler;
}
/**
*/
export class Router extends sap.ui.core.routing.Router {
/**
* Instantiates an SAPUI5 mobile Router see {@link sap.ui.core.routing.Router} for the constructor arguments
* The difference to the {@link sap.ui.core.routing.Router} are the properties viewLevel, transition and transitionParameters you can specify in every Route or Target created by this router.
* @param {any|any[]} oRoutes - may contain many Route configurations as {@link sap.ui.core.routing.Route#constructor}.
Each of the routes contained in the array/object will be added to the router.
One way of defining routes is an array: [ //Will create a route called 'firstRouter' you can later use this name in navTo to navigate to this route { name: "firstRoute" pattern : "usefulPattern" }, //Will create a route called 'anotherRoute' { name: "anotherRoute" pattern : "anotherPattern" } ]
The alternative way of defining routes is an Object.
If you choose this way, the name attribute is the name of the property. { //Will create a route called 'firstRouter' you can later use this name in navTo to navigate to this route firstRoute : { pattern : "usefulPattern" }, //Will create a route called 'anotherRoute' anotherRoute : { pattern : "anotherPattern" } }
The values that may be provided are the same as in {@link sap.ui.core.routing.Route#constructor}
* @param {any} oConfig - Default values for route configuration - also takes the same parameters as {@link sap.ui.core.routing.Target#constructor}.
This config will be used for routes and for targets, used in the router
Eg: if the config object specifies : { viewType : "XML" }
The targets look like this: { xmlTarget : { ... }, jsTarget : { viewType : "JS" ... } }
Then the effective config will look like this: { xmlTarget : { viewType : "XML" ... }, jsTarget : { viewType : "JS" ... } }
Since the xmlTarget does not specify its viewType, XML is taken from the config object. The jsTarget is specifying it, so the viewType will be JS.
* @param {sap.ui.core.UIComponent} oOwner - the Component of all the views that will be created by this Router,
will get forwarded to the {@link sap.ui.core.routing.Views#constructor}.
If you are using the componentMetadata to define your routes you should skip this parameter.
* @param {any} oTargetsConfig - the target configuration, see {@link sap.m.routing.Targets#constructor} documentation (the options object).
You should use Targets to create and display views. The route should only contain routing relevant properties.
Example: new Router( // Routes [ { // no view creation related properties are in the route name: "startRoute", //no hash pattern: "", // you can find this target in the targetConfig target: "welcome" } ], // Default values shared by routes and Targets { viewNamespace: "my.application.namespace", viewType: "XML" }, // You should only use this constructor when you are not using a router with a component. // Please use the metadata of a component to define your routes and targets. // The documentation can be found here: {@link sap.ui.core.UIComponent.extend}. null, // Target config { //same name as in the route called 'startRoute' welcome: { // All properties for creating and placing a view go here or in the config viewName: "Welcome", controlId: "app", controlAggregation: "pages" } })
*/
public constructor(oRoutes?: any|any[], oConfig?: any, oOwner?: sap.ui.core.UIComponent, oTargetsConfig?: any);
/**
* Creates a new subclass of class sap.m.routing.Router with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.routing.Router.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.routing.Router.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the TargetHandler instance.
* @returns {sap.m.routing.TargetHandler} the TargetHandler instance
*/
public getTargetHandler(): sap.m.routing.TargetHandler;
}
/**
*/
export class TargetHandler {
/**
* Instantiates a TargetHandler, a class used for closing dialogs and showing transitions in NavContainers when targets are displayed.
* You should not create an own instance of this class. It will be created when using {@link sap.m.routing.Router} or {@link sap.m.routing.Targets}.
* You may use the {@link #setCloseDialogs} function to specify if dialogs should be closed on displaying other views.
* @param {boolean} closeDialogs - the default is true - will close all open dialogs before navigating, if set to true. If set to false it will just navigate without closing dialogs.
*/
public constructor(closeDialogs: boolean);
/**
* Creates a new subclass of class sap.m.routing.TargetHandler with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets if a navigation should close dialogs
* @returns {boolean} a flag indication if dialogs will be closed
*/
public getCloseDialogs(): boolean;
/**
* Returns a metadata object for class sap.m.routing.TargetHandler.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets if a navigation should close dialogs
* @param {boolean} bCloseDialogs - close dialogs if true
* @returns {sap.m.routing.TargetHandler} for chaining
*/
public setCloseDialogs(bCloseDialogs: boolean): sap.m.routing.TargetHandler;
}
/**
*/
export class Targets extends sap.ui.core.routing.Targets {
/**
* Provides a convenient way for placing views into the correct containers of your application.
* The mobile extension of Targets also handles the triggering of page navigation when the target control is a {@link sap.m.SplitContainer}, a {@link sap.m.NavContainer} or a control which extends one of these.
* Other controls are also allowed, but the extra parameters viewLevel, transition and transitionParameters are ignored and it will behave like {@link sap.ui.core.routing.Targets}.
* When a target is displayed, dialogs will be closed. To change this use {@link #getTargetHandler} and {@link sap.m.routing.TargetHandler#setCloseDialogs}.
* @param {any} oOptions
*/
public constructor(oOptions: any);
/**
* Creates a new subclass of class sap.m.routing.Targets with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.routing.Targets.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.routing.Targets.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the TargetHandler instance.
* @returns {sap.m.routing.TargetHandler} the TargetHandler instance
*/
public getTargetHandler(): sap.m.routing.TargetHandler;
}
}
/**
* Breakpoint names for different screen sizes.
*/
export enum ScreenSize {
/**
* 1024px wide
*/
Desktop = "Desktop",
/**
* 768px wide
*/
Large = "Large",
/**
* 560px wide
*/
Medium = "Medium",
/**
* 240px wide
*/
Phone = "Phone",
/**
* 480px wide
*/
Small = "Small",
/**
* 600px wide
*/
Tablet = "Tablet",
/**
* 960px wide
*/
XLarge = "XLarge",
/**
* 320px wide
*/
XSmall = "XSmall",
/**
* 1120px wide
*/
XXLarge = "XXLarge",
/**
* 240px wide
*/
XXSmall = "XXSmall",
}
/**
* The ScrollContainer is a control that can display arbitrary content within a limited screen area and provides touch scrolling to make all content accessible.
*
* Note that it is not recommended to have nested scrolling areas that scroll into the same direction (e.g. a ScrollContainer that scrolls vertically inside a Page control with scrolling enabled). This is currently not considered a valid use-case of a good UI and the behavior will feel wrong.
*/
export class ScrollContainer extends sap.ui.core.Control {
/**
* Constructor for a new ScrollContainer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.ScrollContainer} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.ScrollContainer;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.ScrollContainer} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.ScrollContainer;
/**
* Creates a new subclass of class sap.m.ScrollContainer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content of the ScrollContainer.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getFocusable focusable}.
*
* Whether the scroll container can be focused.
*
* Note that it should be set to "true" when there are no focusable elements inside or when keyboard interaction requires an additional tab stop on the container.
*
* Default value is false
.
* @returns {boolean} Value of property focusable
*/
public getFocusable(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* The height of the ScrollContainer.
* By default the height equals the content height. If only horizontal scrolling is used, do not set the height or make sure the height is always larger than the height of the content.
*
* Note that when a percentage is given, for the height to work as expected, the height of the surrounding container must be defined.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getHorizontal horizontal}.
*
* Whether horizontal scrolling should be possible.
*
* Default value is true
.
* @returns {boolean} Value of property horizontal
*/
public getHorizontal(): boolean;
/**
* Returns a metadata object for class sap.m.ScrollContainer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getVertical vertical}.
*
* Whether vertical scrolling should be possible.
*
* Note that this is off by default because typically a Page is used as fullscreen element which can handle vertical scrolling. If this is not the case and vertical scrolling is required, this flag needs to be set to "true".
* Important: it is not supported to have nested controls that both enable scrolling into the same dimension.
*
* Default value is false
.
* @returns {boolean} Value of property vertical
*/
public getVertical(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* The width of the ScrollContainer.
* If not set, it consumes the complete available width, behaving like normal HTML block elements. If only vertical scrolling is enabled, make sure the content always fits or wraps.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.ScrollContainer} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.ScrollContainer;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Scrolls to the given position.
* When called while the control is not rendered (yet), the scrolling position is still applied, but there is no animation.
* @param {number} x - The horizontal pixel position to scroll to. Scrolling to the right happens with positive values. In right-to-left mode scrolling starts at the right side and higher values scroll to the left. If only vertical scrolling is enabled, give 0 as value.
* @param {number} y - The vertical pixel position to scroll to. Scrolling down happens with positive values. If only horizontal scrolling is enabled, give 0 as value.
* @param {number} time - The duration of animated scrolling. To scroll immediately without animation, give 0 as value. 0 is also the default value, when this optional parameter is omitted.
* @returns {sap.m.ScrollContainer}
*/
public scrollTo(x: number, y: number, time: number): sap.m.ScrollContainer;
/**
* Scrolls to an element(DOM or sap.ui.core.Element) within the page if the element is rendered.
* @param {HTMLElement|sap.ui.core.Element} element - The element to which should be scrolled.
* @param {number} time - The duration of animated scrolling. To scroll immediately without animation, give 0 as value or leave it default.
* @returns {sap.m.ScrollContainer} this
to facilitate method chaining.
*/
public scrollToElement(element: HTMLElement|sap.ui.core.Element, time?: number): sap.m.ScrollContainer;
/**
* Sets a new value for property {@link #getFocusable focusable}.
*
* Whether the scroll container can be focused.
*
* Note that it should be set to "true" when there are no focusable elements inside or when keyboard interaction requires an additional tab stop on the container.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bFocusable - New value for property focusable
* @returns {sap.m.ScrollContainer} Reference to this
in order to allow method chaining
*/
public setFocusable(bFocusable: boolean): sap.m.ScrollContainer;
/**
* Sets a new value for property {@link #getHeight height}.
*
* The height of the ScrollContainer.
* By default the height equals the content height. If only horizontal scrolling is used, do not set the height or make sure the height is always larger than the height of the content.
*
* Note that when a percentage is given, for the height to work as expected, the height of the surrounding container must be defined.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.m.ScrollContainer} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.m.ScrollContainer;
/**
* Sets a new value for property {@link #getHorizontal horizontal}.
*
* Whether horizontal scrolling should be possible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bHorizontal - New value for property horizontal
* @returns {sap.m.ScrollContainer} Reference to this
in order to allow method chaining
*/
public setHorizontal(bHorizontal: boolean): sap.m.ScrollContainer;
/**
* Sets a new value for property {@link #getVertical vertical}.
*
* Whether vertical scrolling should be possible.
*
* Note that this is off by default because typically a Page is used as fullscreen element which can handle vertical scrolling. If this is not the case and vertical scrolling is required, this flag needs to be set to "true".
* Important: it is not supported to have nested controls that both enable scrolling into the same dimension.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bVertical - New value for property vertical
* @returns {sap.m.ScrollContainer} Reference to this
in order to allow method chaining
*/
public setVertical(bVertical: boolean): sap.m.ScrollContainer;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The width of the ScrollContainer.
* If not set, it consumes the complete available width, behaving like normal HTML block elements. If only vertical scrolling is enabled, make sure the content always fits or wraps.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.ScrollContainer} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.ScrollContainer;
}
/**
* An input field to search for a specific item.
* Overview
* A search field is needed when the user needs to find specific information in large amounts of data.
* The search field is also the control of choice for filtering down
* a given amount of information.
* Structure
* The search input field can be used in two ways:
*
* - Manual search - The search is triggered after the user presses the search button.
* Manual search uses a “starts with” approach.
* - Live search (search-as-you-type) - The search is triggered after each button press.
* A suggestion list is shown below the search field. Live search uses a “contains” approach.
*
* Usage
* When to use:
*
* - Use live search whenever possible.
* - Use a manual search only if the amount of data is too large and if your app would otherwise run
* into performance issues.
*
* Responsive Behavior
* On mobile devices, there is no refresh button in the search field. "Pull Down to Refresh" is used instead.
* The "Pull Down to Refresh" arrow icon is animated and spins to signal that the user should release it.
*/
export class SearchField extends sap.ui.core.Control {
/**
* Constructor for a new SearchField.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.SearchField;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.SearchField;
/**
* Adds some suggestionItem to the aggregation {@link #getSuggestionItems suggestionItems}.
* @param {sap.m.SuggestionItem} oSuggestionItem - the suggestionItem to add; if empty, nothing is inserted
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public addSuggestionItem(oSuggestionItem: sap.m.SuggestionItem): sap.m.SearchField;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.m.SearchField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SearchField
itself.
*
* This event is fired when the value of the search field is changed by a user - e.g. at each key press. Do not invalidate or re-render a focused search field, especially during the liveChange event.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SearchField
itself
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public attachLiveChange(fnFunction: Function, oListener?: any): sap.m.SearchField;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.m.SearchField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SearchField
itself.
*
* This event is fired when the value of the search field is changed by a user - e.g. at each key press. Do not invalidate or re-render a focused search field, especially during the liveChange event.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SearchField
itself
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public attachLiveChange(oData: any, fnFunction: Function, oListener?: any): sap.m.SearchField;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.m.SearchField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SearchField
itself.
*
* Event which is fired when the user triggers a search.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SearchField
itself
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public attachSearch(fnFunction: Function, oListener?: any): sap.m.SearchField;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.m.SearchField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SearchField
itself.
*
* Event which is fired when the user triggers a search.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SearchField
itself
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public attachSearch(oData: any, fnFunction: Function, oListener?: any): sap.m.SearchField;
/**
* Attaches event handler fnFunction
to the {@link #event:suggest suggest} event of this sap.m.SearchField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SearchField
itself.
*
* This event is fired when the search field is initially focused or its value is changed by the user.
* This event means that suggestion data should be updated, in case if suggestions are used.
* Use the value parameter to create new suggestions for it.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SearchField
itself
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public attachSuggest(fnFunction: Function, oListener?: any): sap.m.SearchField;
/**
* Attaches event handler fnFunction
to the {@link #event:suggest suggest} event of this sap.m.SearchField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SearchField
itself.
*
* This event is fired when the search field is initially focused or its value is changed by the user.
* This event means that suggestion data should be updated, in case if suggestions are used.
* Use the value parameter to create new suggestions for it.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SearchField
itself
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public attachSuggest(oData: any, fnFunction: Function, oListener?: any): sap.m.SearchField;
/**
* Binds property {@link #getValue value} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a
* detailed description of the possible properties of oBindingInfo
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public bindValue(oBindingInfo: any): sap.m.SearchField;
/**
* Destroys all the suggestionItems in the aggregation {@link #getSuggestionItems suggestionItems}.
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public destroySuggestionItems(): sap.m.SearchField;
/**
* Detaches event handler fnFunction
from the {@link #event:liveChange liveChange} event of this sap.m.SearchField
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public detachLiveChange(fnFunction: Function, oListener: any): sap.m.SearchField;
/**
* Detaches event handler fnFunction
from the {@link #event:search search} event of this sap.m.SearchField
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public detachSearch(fnFunction: Function, oListener: any): sap.m.SearchField;
/**
* Detaches event handler fnFunction
from the {@link #event:suggest suggest} event of this sap.m.SearchField
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public detachSuggest(fnFunction: Function, oListener: any): sap.m.SearchField;
/**
* Creates a new subclass of class sap.m.SearchField with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:liveChange liveChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
protected fireLiveChange(mParameters?: any): sap.m.SearchField;
/**
* Fires event {@link #event:search search} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
protected fireSearch(mParameters?: any): sap.m.SearchField;
/**
* Fires event {@link #event:suggest suggest} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
protected fireSuggest(mParameters?: any): sap.m.SearchField;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Boolean property to enable the control (default is true).
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getEnableSuggestions enableSuggestions}.
*
* If true, a suggest
event is fired when user types in the input and when the input is focused.
* On a phone device, a full screen dialog with suggestions is always shown even if the suggestions list is empty.
*
* Default value is false
.
* @returns {boolean} Value of property enableSuggestions
*/
public getEnableSuggestions(): boolean;
/**
* Gets current value of property {@link #getMaxLength maxLength}.
*
* Maximum number of characters. Value '0' means the feature is switched off.
*
* Default value is 0
.
* @returns {number} Value of property maxLength
*/
public getMaxLength(): number;
/**
* Returns a metadata object for class sap.m.SearchField.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPlaceholder placeholder}.
*
* Text shown when no value available. Default placeholder text is the word "Search" in the current local language (if supported) or in English.
* @returns {string} Value of property placeholder
*/
public getPlaceholder(): string;
/**
* Function returns DOM element which acts as reference point for the opening suggestion menu
* @returns {HTMLElement} the DOM element at which to open the suggestion list
*/
protected getPopupAnchorDomRef(): HTMLElement;
/**
* Gets current value of property {@link #getRefreshButtonTooltip refreshButtonTooltip}.
*
* Tooltip text of the refresh button. If it is not set, the tooltip of the SearchField (if any) is displayed. Tooltips are not displayed on touch devices.
* @returns {string} Value of property refreshButtonTooltip
*/
public getRefreshButtonTooltip(): string;
/**
* Gets current value of property {@link #getSelectOnFocus selectOnFocus}.
*
* Normally, search text is selected for copy when the SearchField is focused by keyboard navigation. If an application re-renders the SearchField during the liveChange event, set this property to false to disable text selection by focus.
*
* Default value is true
.
* @returns {boolean} Value of property selectOnFocus
*/
public getSelectOnFocus(): boolean;
/**
* Gets current value of property {@link #getShowMagnifier showMagnifier}.
*
* Set to false to hide the magnifier icon.
*
* Default value is true
.
* @returns {boolean} Value of property showMagnifier
*/
public getShowMagnifier(): boolean;
/**
* Gets current value of property {@link #getShowRefreshButton showRefreshButton}.
*
* Set to true to display a refresh button in place of the search icon. By pressing the refresh button or F5 key on keyboard, the user can reload the results list without changing the search string.
*
* Default value is false
.
* @returns {boolean} Value of property showRefreshButton
*/
public getShowRefreshButton(): boolean;
/**
* Gets current value of property {@link #getShowSearchButton showSearchButton}.
*
* Set to true to show the search button with the magnifier icon.
* If false, both the search and refresh buttons are not displayed even if the "showRefreshButton" property is true.
*
* Default value is true
.
* @returns {boolean} Value of property showSearchButton
*/
public getShowSearchButton(): boolean;
/**
* Gets content of aggregation {@link #getSuggestionItems suggestionItems}.
*
* SuggestionItems
are the items which will be shown in the suggestions list.
* The following properties can be used:
*
* key
is not displayed and may be used as internal technical field
* text
is displayed as normal suggestion text
* icon
* description
- additional text may be used to visually display search item type or category
*
* @returns {sap.m.SuggestionItem[]}
*/
public getSuggestionItems(): sap.m.SuggestionItem[];
/**
* Gets current value of property {@link #getValue value}.
*
* Input Value.
* @returns {string} Value of property value
*/
public getValue(): string;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Invisible inputs are not rendered.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the CSS width of the input. If not set, width is 100%.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.m.SuggestionItem
in the aggregation {@link #getSuggestionItems suggestionItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.SuggestionItem} oSuggestionItem - The suggestionItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSuggestionItem(oSuggestionItem: sap.m.SuggestionItem): number;
/**
* Inserts a suggestionItem into the aggregation {@link #getSuggestionItems suggestionItems}.
* @param {sap.m.SuggestionItem} oSuggestionItem - the suggestionItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the suggestionItem should be inserted at; for a negative value of iIndex
, the suggestionItem is inserted at position 0; for a value greater than the current size of the aggregation, the suggestionItem is inserted at the last position
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public insertSuggestionItem(oSuggestionItem: sap.m.SuggestionItem, iIndex: number): sap.m.SearchField;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getSuggestionItems suggestionItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.SuggestionItem[]} An array of the removed elements (might be empty)
*/
public removeAllSuggestionItems(): sap.m.SuggestionItem[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a suggestionItem from the aggregation {@link #getSuggestionItems suggestionItems}.
* @param {number|string|sap.m.SuggestionItem} vSuggestionItem - The suggestionItem to remove or its index or id
* @returns {sap.m.SuggestionItem} The removed suggestionItem or null
*/
public removeSuggestionItem(vSuggestionItem: number|string|sap.m.SuggestionItem): sap.m.SuggestionItem;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Boolean property to enable the control (default is true).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.SearchField;
/**
* Sets a new value for property {@link #getEnableSuggestions enableSuggestions}.
*
* If true, a suggest
event is fired when user types in the input and when the input is focused.
* On a phone device, a full screen dialog with suggestions is always shown even if the suggestions list is empty.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableSuggestions - New value for property enableSuggestions
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public setEnableSuggestions(bEnableSuggestions: boolean): sap.m.SearchField;
/**
* Sets a new value for property {@link #getMaxLength maxLength}.
*
* Maximum number of characters. Value '0' means the feature is switched off.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iMaxLength - New value for property maxLength
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public setMaxLength(iMaxLength: number): sap.m.SearchField;
/**
* Sets a new value for property {@link #getPlaceholder placeholder}.
*
* Text shown when no value available. Default placeholder text is the word "Search" in the current local language (if supported) or in English.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sPlaceholder - New value for property placeholder
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public setPlaceholder(sPlaceholder: string): sap.m.SearchField;
/**
* Sets a new value for property {@link #getRefreshButtonTooltip refreshButtonTooltip}.
*
* Tooltip text of the refresh button. If it is not set, the tooltip of the SearchField (if any) is displayed. Tooltips are not displayed on touch devices.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sRefreshButtonTooltip - New value for property refreshButtonTooltip
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public setRefreshButtonTooltip(sRefreshButtonTooltip: string): sap.m.SearchField;
/**
* Sets a new value for property {@link #getSelectOnFocus selectOnFocus}.
*
* Normally, search text is selected for copy when the SearchField is focused by keyboard navigation. If an application re-renders the SearchField during the liveChange event, set this property to false to disable text selection by focus.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bSelectOnFocus - New value for property selectOnFocus
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public setSelectOnFocus(bSelectOnFocus: boolean): sap.m.SearchField;
/**
* Sets a new value for property {@link #getShowMagnifier showMagnifier}.
*
* Set to false to hide the magnifier icon.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowMagnifier - New value for property showMagnifier
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public setShowMagnifier(bShowMagnifier: boolean): sap.m.SearchField;
/**
* Sets a new value for property {@link #getShowRefreshButton showRefreshButton}.
*
* Set to true to display a refresh button in place of the search icon. By pressing the refresh button or F5 key on keyboard, the user can reload the results list without changing the search string.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowRefreshButton - New value for property showRefreshButton
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public setShowRefreshButton(bShowRefreshButton: boolean): sap.m.SearchField;
/**
* Sets a new value for property {@link #getShowSearchButton showSearchButton}.
*
* Set to true to show the search button with the magnifier icon.
* If false, both the search and refresh buttons are not displayed even if the "showRefreshButton" property is true.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowSearchButton - New value for property showSearchButton
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public setShowSearchButton(bShowSearchButton: boolean): sap.m.SearchField;
/**
* Sets a new value for property {@link #getValue value}.
*
* Input Value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sValue - New value for property value
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public setValue(sValue: string): sap.m.SearchField;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Invisible inputs are not rendered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.SearchField;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the CSS width of the input. If not set, width is 100%.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.SearchField;
/**
* Toggle visibility of the suggestion list.
* @param {boolean|any} bShow - set to true
to display suggestions and false
to hide them. Default value is true
. An empty suggestion list is not shown on desktop and tablet devices.
This method may be called only as a response to the suggest
event to ensure that the suggestion list is shown at the moment when the user expects it.
* @returns {sap.m.SearchField} this
to allow method chaining
*/
public suggest(bShow: boolean|any): sap.m.SearchField;
/**
* Unbinds property {@link #getValue value} from model data.
* @returns {sap.m.SearchField} Reference to this
in order to allow method chaining
*/
public unbindValue(): sap.m.SearchField;
}
/**
* SegmentedButton is a horizontal control made of multiple buttons, which can display a title or an image. It automatically resizes the buttons to fit proportionally within the control. When no width is set, the control uses the available width.
*/
export class SegmentedButton extends sap.ui.core.Control {
/**
* Constructor for a new SegmentedButton.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.SegmentedButton;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.SegmentedButton;
/**
* Adds some button to the aggregation {@link #getButtons buttons}.
* @param {sap.m.Button} oButton - the button to add; if empty, nothing is inserted
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
public addButton(oButton: sap.m.Button): sap.m.SegmentedButton;
/**
* Adds item to items
aggregation
* @param {sap.m.SegmentedButtonItem} oItem
* @param {boolean} bSuppressInvalidate - If true
the control invalidation will be suppressed
*/
public addItem(oItem: sap.m.SegmentedButtonItem, bSuppressInvalidate?: boolean): void;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.SegmentedButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SegmentedButton
itself.
*
* Fires when the user selects a button, which returns the ID and button object.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SegmentedButton
itself
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.m.SegmentedButton;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.SegmentedButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SegmentedButton
itself.
*
* Fires when the user selects a button, which returns the ID and button object.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SegmentedButton
itself
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.m.SegmentedButton;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.m.SegmentedButton;
/**
* Binds property {@link #getSelectedKey selectedKey} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a
* detailed description of the possible properties of oBindingInfo
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
public bindSelectedKey(oBindingInfo: any): sap.m.SegmentedButton;
/**
* Adds a Button with a text as title, a URI for an icon, enabled and textDirection.
* Only one is allowed.
* @param {string} sText - Defines the title text of the newly created Button
* @param {sap.ui.core.URI} sURI - Icon to be displayed as graphical element within the Button. Density related image will be loaded if image with density awareness name in format [imageName]@[densityValue].[extension] is provided.
* @param {boolean} bEnabled - Enables the control (default is true). Buttons that are disabled have other colors than enabled ones, depending on custom settings.
* @param {sap.ui.core.TextDirection} sTextDirection - Element's text directionality with enumerated options
* @returns {sap.m.Button} The created Button
*/
public createButton(sText: string, sURI: sap.ui.core.URI, bEnabled: boolean, sTextDirection?: sap.ui.core.TextDirection): sap.m.Button;
/**
* Destroys all the buttons in the aggregation {@link #getButtons buttons}.
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
public destroyButtons(): sap.m.SegmentedButton;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.SegmentedButton;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.m.SegmentedButton
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.m.SegmentedButton;
/**
* Creates a new subclass of class sap.m.SegmentedButton with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.m.SegmentedButton;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets content of aggregation {@link #getButtons buttons}.
*
* The buttons of the SegmentedButton control. The items set in this aggregation are used as an interface for the buttons displayed by the control. Only the properties ID, icon, text, enabled and textDirections of the Button control are evaluated. Setting other properties of the button will have no effect. Alternatively, you can use the createButton method to add buttons.
* @returns {sap.m.Button[]}
*/
public getButtons(): sap.m.Button[];
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Disables all the buttons in the SegmentedButton control. When disabled all the buttons look grey and you cannot focus or click on them.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Aggregation of items to be displayed. The items set in this aggregation are used as an interface for the buttons displayed by the control.
* The "items" and "buttons" aggregations should NOT be used simultaneously as it causes the control to work incorrectly.
* @returns {sap.m.SegmentedButtonItem[]}
*/
public getItems(): sap.m.SegmentedButtonItem[];
/**
* Returns a metadata object for class sap.m.SegmentedButton.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* ID of the element which is the current target of the association {@link #getSelectedButton selectedButton}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedButton(): sap.ui.core.ID;
/**
* Gets the selectedKey
and is usable only when the control is initiated with the items
aggregation.
* @returns {string} Current selected key
*/
public getSelectedKey(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the SegmentedButton control. If not set, it uses the minimum required width to make all buttons inside of the same size (based on the biggest button).
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.m.Button
in the aggregation {@link #getButtons buttons}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Button} oButton - The button whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfButton(oButton: sap.m.Button): number;
/**
* Checks for the provided sap.m.SegmentedButtonItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.SegmentedButtonItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.m.SegmentedButtonItem): number;
/**
* Inserts a button into the aggregation {@link #getButtons buttons}.
* @param {sap.m.Button} oButton - the button to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the button should be inserted at; for a negative value of iIndex
, the button is inserted at position 0; for a value greater than the current size of the aggregation, the button is inserted at the last position
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
public insertButton(oButton: sap.m.Button, iIndex: number): sap.m.SegmentedButton;
/**
* Inserts item into items
aggregation
* @param {sap.m.SegmentedButtonItem} oItem
* @param {number} iIndex - index the item should be inserted at
* @param {boolean} bSuppressInvalidate - If true
the control invalidation will be suppressed
*/
public insertItem(oItem: sap.m.SegmentedButtonItem, iIndex: number, bSuppressInvalidate?: boolean): void;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getButtons buttons}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Button[]} An array of the removed elements (might be empty)
*/
public removeAllButtons(): sap.m.Button[];
/**
* Removes all items from items
aggregation
* @param {boolean} bSuppressInvalidate - If true
the control invalidation will be suppressed
*/
public removeAllItems(bSuppressInvalidate?: boolean): void;
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a button from the aggregation {@link #getButtons buttons}.
* @param {number|string|sap.m.Button} vButton - The button to remove or its index or id
* @returns {sap.m.Button} The removed button or null
*/
public removeButton(vButton: number|string|sap.m.Button): sap.m.Button;
/**
* Removes an item from items
aggregation
* @param {sap.m.SegmentedButtonItem} oItem
* @param {boolean} bSuppressInvalidate - If true
the control invalidation will be suppressed
*/
public removeItem(oItem: sap.m.SegmentedButtonItem, bSuppressInvalidate?: boolean): void;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Disables all the buttons in the SegmentedButton control. When disabled all the buttons look grey and you cannot focus or click on them.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.SegmentedButton;
/**
* Setter for association selectedButton
.
* @param {string|sap.m.Button|null|any} vButton - New value for association setSelectedButton
An sap.m.Button instance which becomes the new target of this selectedButton
association. Alternatively, the ID of an sap.m.Button instance may be given as a string. If the value of null, undefined, or an empty string is provided the first item will be selected.
* @returns {sap.m.SegmentedButton} this
this pointer for chaining
*/
public setSelectedButton(vButton: string|sap.m.Button|null|any): sap.m.SegmentedButton;
/**
* Sets the selectedKey
and is usable only when the control is initiated with the items
aggregation.
* @param {string} sKey - The key of the button to be selected
* @returns {sap.m.SegmentedButton} this
pointer for chaining
*/
public setSelectedKey(sKey: string): sap.m.SegmentedButton;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the SegmentedButton control. If not set, it uses the minimum required width to make all buttons inside of the same size (based on the biggest button).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.SegmentedButton;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.m.SegmentedButton;
/**
* Unbinds property {@link #getSelectedKey selectedKey} from model data.
* @returns {sap.m.SegmentedButton} Reference to this
in order to allow method chaining
*/
public unbindSelectedKey(): sap.m.SegmentedButton;
}
/**
* The SegmentedButtonItem control is used for creating buttons for the sap.m.SegmentedButton.
* It is derived from a core sap.ui.core.Item.
*/
export class SegmentedButtonItem extends sap.ui.core.Item {
/**
* Constructor for a new SegmentedButtonItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.SegmentedButtonItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SegmentedButtonItem
itself.
*
* Fires when the user clicks on an individual button.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SegmentedButtonItem
itself
* @returns {sap.m.SegmentedButtonItem} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.SegmentedButtonItem;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.SegmentedButtonItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SegmentedButtonItem
itself.
*
* Fires when the user clicks on an individual button.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SegmentedButtonItem
itself
* @returns {sap.m.SegmentedButtonItem} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.SegmentedButtonItem;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.SegmentedButtonItem
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SegmentedButtonItem} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.SegmentedButtonItem;
/**
* Cleanup
*/
protected exit(): void;
/**
* Creates a new subclass of class sap.m.SegmentedButtonItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SegmentedButtonItem} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.SegmentedButtonItem;
/**
* Gets current value of property {@link #getIcon icon}.
*
* The icon, which belongs to the button.
* This can be a URI to an image or an icon font URI.
* @returns {string} Value of property icon
*/
public getIcon(): string;
/**
* Returns a metadata object for class sap.m.SegmentedButtonItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Whether the button should be visible on the screen. If set to false, a placeholder is rendered instead of the real button.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* Sets the width of the buttons.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Called once during the element's initialization
*/
protected init(): void;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* The icon, which belongs to the button.
* This can be a URI to an image or an icon font URI.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sIcon - New value for property icon
* @returns {sap.m.SegmentedButtonItem} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: string): sap.m.SegmentedButtonItem;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Whether the button should be visible on the screen. If set to false, a placeholder is rendered instead of the real button.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.SegmentedButtonItem} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.SegmentedButtonItem;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Sets the width of the buttons.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.SegmentedButtonItem} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.SegmentedButtonItem;
}
/**
* The sap.m.Select
control provides a list of items that allows users to select an item.
*/
export class Select extends sap.ui.core.Control {
/**
* Constructor for a new sap.m.Select
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given.
* @param {any} mSettings - Initial settings for the new control.
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Select;
/**
* Adds an item to the aggregation named items
.
* @param {sap.ui.core.Item} oItem - The item to be added; if empty, nothing is added.
* @returns {sap.m.Select} this
to allow method chaining.
*/
public addItem(oItem: sap.ui.core.Item): sap.m.Select;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.Select
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Select
itself.
*
* This event is fired when the value in the selection field is changed in combination with one of
* the following actions:
*
* - The focus leaves the selection field
* - The Enter key is pressed
* - The item is pressed
*
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Select
itself
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.m.Select;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.Select
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Select
itself.
*
* This event is fired when the value in the selection field is changed in combination with one of
* the following actions:
*
* - The focus leaves the selection field
* - The Enter key is pressed
* - The item is pressed
*
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Select
itself
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.m.Select;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.m.Select;
/**
* Closes the control's picker popup.
* @returns {sap.m.Select} this
to allow method chaining.
*/
public close(): sap.m.Select;
/**
* Creates a picker popup container where the selection should take place.
* @param {string} sPickerType
* @returns {sap.m.Popover|sap.m.Dialog}
*/
protected createPicker(sPickerType: string): sap.m.Popover|sap.m.Dialog;
/**
* Destroys all the items in the aggregation named items
.
* @returns {sap.m.Select} this
to allow method chaining.
*/
public destroyItems(): sap.m.Select;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.m.Select
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.m.Select;
/**
* Creates a new subclass of class sap.m.Select with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.m.Select;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getAutoAdjustWidth autoAdjustWidth}.
*
* Indicates whether the width of the input field is determined by the selected item's content.
*
* Default value is false
.
* @returns {boolean} Value of property autoAdjustWidth
*/
public getAutoAdjustWidth(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Indicates whether the user can change the selection.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets the enabled items from the aggregation named items
.
* @param {sap.ui.core.Item[]} aItems - Items to filter.
* @returns {sap.ui.core.Item[]} An array containing the enabled items.
*/
public getEnabledItems(aItems?: sap.ui.core.Item[]): sap.ui.core.Item[];
/**
* Gets the first item from the aggregation named items
.
* @returns {sap.ui.core.Item|null} The first item, or null if there are no items.
*/
public getFirstItem(): sap.ui.core.Item|null;
/**
* Gets current value of property {@link #getForceSelection forceSelection}.
*
* Indicates whether the selection is restricted to one of the items in the list.
* Note: We strongly recommend that you always set this property to false
and bind
* the selectedKey
property to the desired value for better interoperability with data binding.
*
* Default value is true
.
* @returns {boolean} Value of property forceSelection
*/
public getForceSelection(): boolean;
/**
* Gets current value of property {@link #getIcon icon}.
*
* The URI to the icon that will be displayed only when using the IconOnly
type.
*
* Default value is
.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets the item from the aggregation named items
at the given 0-based index.
* @param {number} iIndex - Index of the item to return.
* @returns {sap.ui.core.Item|null} Item at the given index, or null if none.
*/
public getItemAt(iIndex: number): sap.ui.core.Item|null;
/**
* Gets the item with the given key from the aggregation named items
.
*
* Note: If duplicate keys exist, the first item matching the key is returned.
* @param {string} sKey - An item key that specifies the item to be retrieved.
* @returns {sap.ui.core.Item|null}
*/
public getItemByKey(sKey: string): sap.ui.core.Item|null;
/**
* Gets aggregation items
.
*
* Note: This is the default aggregation.
* @returns {sap.ui.core.Item[]}
*/
public getItems(): sap.ui.core.Item[];
/**
* Gets the last item from the aggregation named items
.
* @returns {sap.ui.core.Item|null} The last item, or null if there are no items.
*/
public getLastItem(): sap.ui.core.Item|null;
/**
* Gets current value of property {@link #getMaxWidth maxWidth}.
*
* Sets the maximum width of the control.
*
* Note: This property is ignored if the autoAdjustWidth
property is set to true
.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property maxWidth
*/
public getMaxWidth(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.m.Select.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* The name to be used in the HTML code (for example, for HTML forms that send data to the server via submit).
*
* Default value is
.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets the selected item object from the aggregation named items
.
* @returns {sap.ui.core.Item|null} The current target of the selectedItem
association, or null.
*/
public getSelectedItem(): sap.ui.core.Item|null;
/**
* Gets current value of property {@link #getSelectedItemId selectedItemId}.
*
* ID of the selected item.
*
* Default value is
.
* @returns {string} Value of property selectedItemId
*/
public getSelectedItemId(): string;
/**
* Gets current value of property {@link #getSelectedKey selectedKey}.
*
* Key of the selected item.
*
* Note: If duplicate keys exist, the first item matching the key is used.
*
* Default value is
.
* @returns {string} Value of property selectedKey
*/
public getSelectedKey(): string;
/**
* Gets current value of property {@link #getShowSecondaryValues showSecondaryValues}.
*
* Indicates whether the text values of the additionalText
property of a
* {@link sap.ui.core.ListItem} are shown.
*
* Default value is false
.
* @returns {boolean} Value of property showSecondaryValues
*/
public getShowSecondaryValues(): boolean;
/**
* Gets current value of property {@link #getTextAlign textAlign}.
*
* Sets the horizontal alignment of the text within the input field.
*
* Default value is Initial
.
* @returns {sap.ui.core.TextAlign} Value of property textAlign
*/
public getTextAlign(): sap.ui.core.TextAlign;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Specifies the direction of the text within the input field with enumerated options.
* By default, the control inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getType type}.
*
* Type of a select. Possible values Default
, IconOnly
.
*
* Default value is Default
.
* @returns {sap.m.SelectType} Value of property type
*/
public getType(): sap.m.SelectType;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Visualizes the validation state of the control, e.g. Error
, Warning
,
* Success
.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getValueStateText valueStateText}.
*
* Defines the text of the value state message popup.
* If this is not specified, a default text is shown from the resource bundle.
*
* Default value is
.
* @returns {string} Value of property valueStateText
*/
public getValueStateText(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Sets the width of the field. By default, the field width is automatically adjusted to the size
* of its content and the default width of the field is calculated based on the widest list item
* in the dropdown list.
* If the width defined is smaller than its content, only the field width is changed whereas
* the dropdown list keeps the width of its content.
* If the dropdown list is wider than the visual viewport, it is truncated and an ellipsis is displayed
* for each item.
* For phones, the width of the dropdown list is always the same as the viewport.
*
* Note: This property is ignored if the autoAdjustWidth
property is set to true
.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Item
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Item} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.core.Item): number;
/**
* Inserts an item into the aggregation named items
.
* @param {sap.ui.core.Item} oItem - The item to be inserted; if empty, nothing is inserted.
* @param {number} iIndex - The 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position.
* @returns {sap.m.Select} this
to allow method chaining.
*/
public insertItem(oItem: sap.ui.core.Item, iIndex: number): sap.m.Select;
/**
* Indicates whether the control's picker popup is opened.
* @returns {boolean} Indicates whether the picker popup is currently open (this includes opening and closing animations).
*/
public isOpen(): boolean;
/**
* Open the control's picker popup.
* @returns {sap.m.Select} this
to allow method chaining.
*/
protected open(): sap.m.Select;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the items in the aggregation named items
.
* Additionally unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Item[]} An array of the removed items (might be empty).
*/
public removeAllItems(): sap.ui.core.Item[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an item from the aggregation named items
.
* @param {number|string|sap.ui.core.Item} vItem - The item to be removed or its index or ID.
* @returns {sap.ui.core.Item} The removed item or null.
*/
public removeItem(vItem: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Sets a new value for property {@link #getAutoAdjustWidth autoAdjustWidth}.
*
* Indicates whether the width of the input field is determined by the selected item's content.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bAutoAdjustWidth - New value for property autoAdjustWidth
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public setAutoAdjustWidth(bAutoAdjustWidth: boolean): sap.m.Select;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Indicates whether the user can change the selection.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.Select;
/**
* Sets a new value for property {@link #getForceSelection forceSelection}.
*
* Indicates whether the selection is restricted to one of the items in the list.
* Note: We strongly recommend that you always set this property to false
and bind
* the selectedKey
property to the desired value for better interoperability with data binding.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bForceSelection - New value for property forceSelection
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public setForceSelection(bForceSelection: boolean): sap.m.Select;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* The URI to the icon that will be displayed only when using the IconOnly
type.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.Select;
/**
* Sets a new value for property {@link #getMaxWidth maxWidth}.
*
* Sets the maximum width of the control.
*
* Note: This property is ignored if the autoAdjustWidth
property is set to true
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sMaxWidth - New value for property maxWidth
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public setMaxWidth(sMaxWidth: sap.ui.core.CSSSize): sap.m.Select;
/**
* Sets a new value for property {@link #getName name}.
*
* The name to be used in the HTML code (for example, for HTML forms that send data to the server via submit).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sName - New value for property name
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.m.Select;
/**
* Sets the selectedItem
association.
*
* Default value is null
.
* @param {string|sap.ui.core.Item|null} vItem - New value for the selectedItem
association. If an ID of a sap.ui.core.Item
is given, the item with this ID becomes the selectedItem
association. Alternatively, a sap.ui.core.Item
instance may be given or null
. If the value of null
is provided, the first enabled item will be selected (if any items exist).
* @returns {sap.m.Select} this
to allow method chaining.
*/
public setSelectedItem(vItem: string|sap.ui.core.Item|null): sap.m.Select;
/**
* Sets the selectedItemId
property.
*
* Default value is an empty string ""
or undefined
.
* @param {string|any} vItem - New value for property selectedItemId
. If the provided vItem
has a default value, the first enabled item will be selected (if any items exist).
* @returns {sap.m.Select} this
to allow method chaining.
*/
public setSelectedItemId(vItem: string|any): sap.m.Select;
/**
* Sets property selectedKey
.
*
* Default value is an empty string ""
or undefined
.
* @param {string} sKey - New value for property selectedKey
. If the forceSelection
property is set to true
and the provided sKey
is an empty string ""
or undefined
, the value of sKey
is changed to match the key
of the first enabled item and the first enabled item is selected (if any items exist). In the case that an item has the default key value, it is selected instead. If duplicate keys exist, the first item matching the key is selected.
* @returns {sap.m.Select} this
to allow method chaining.
*/
public setSelectedKey(sKey: string): sap.m.Select;
/**
* Sets a new value for property {@link #getShowSecondaryValues showSecondaryValues}.
*
* Indicates whether the text values of the additionalText
property of a
* {@link sap.ui.core.ListItem} are shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowSecondaryValues - New value for property showSecondaryValues
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public setShowSecondaryValues(bShowSecondaryValues: boolean): sap.m.Select;
/**
* Sets a new value for property {@link #getTextAlign textAlign}.
*
* Sets the horizontal alignment of the text within the input field.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Initial
.
* @param {sap.ui.core.TextAlign} sTextAlign - New value for property textAlign
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public setTextAlign(sTextAlign: sap.ui.core.TextAlign): sap.m.Select;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Specifies the direction of the text within the input field with enumerated options.
* By default, the control inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.Select;
/**
* Sets a new value for property {@link #getType type}.
*
* Type of a select. Possible values Default
, IconOnly
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Default
.
* @param {sap.m.SelectType} sType - New value for property type
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.m.SelectType): sap.m.Select;
/**
* Sets a new value for property {@link #getValueState valueState}.
*
* Visualizes the validation state of the control, e.g. Error
, Warning
,
* Success
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sValueState - New value for property valueState
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public setValueState(sValueState: sap.ui.core.ValueState): sap.m.Select;
/**
* Sets a new value for property {@link #getValueStateText valueStateText}.
*
* Defines the text of the value state message popup.
* If this is not specified, a default text is shown from the resource bundle.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sValueStateText - New value for property valueStateText
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public setValueStateText(sValueStateText: string): sap.m.Select;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Sets the width of the field. By default, the field width is automatically adjusted to the size
* of its content and the default width of the field is calculated based on the widest list item
* in the dropdown list.
* If the width defined is smaller than its content, only the field width is changed whereas
* the dropdown list keeps the width of its content.
* If the dropdown list is wider than the visual viewport, it is truncated and an ellipsis is displayed
* for each item.
* For phones, the width of the dropdown list is always the same as the viewport.
*
* Note: This property is ignored if the autoAdjustWidth
property is set to true
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.Select;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.m.Select} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.m.Select;
}
/**
* Overview
* A SelectDialog is a dialog containing a list, search functionality to filter it and a confirmation/cancel button.
* The list used in the dialog is a growing list and can be filled with any kind of list item.
* Structure
* Dialog structure
* The select dialog has the following components:
*
* - Header - title of the dialog
* - Search field - input field to enter search terms
* - Info toolbar (only in multi-select) - displays the number of currently selected items
* - Content - {@link sap.m.StandardListItem standard list items}, {@link sap.m.DisplayListItem
* display list items} or {@link sap.m.FeedListItem feed list items}
* - Button toolbar - for confirmation/cancellation buttons
*
* List structure & selection
*
* - The search field triggers the events
search
and liveChange
* where a filter function can be applied to the list binding.
* - The growing functionality of the list does not support two-way Binding, so if you use this control with a JSON model
* make sure the binding mode is set to
OneWay
and that you update the selection model manually with
* the items passed in the confirm event.
* - In the multi-select mode of the select dialog, checkboxes are provided for choosing multiple entries.
* - You can set
rememberSelections
to true to store the current selection and load this state
* when the dialog is opened again.
* - When cancelling the selection, the event
change
will be fired and the selection is restored
* to the state when the dialog was opened.
*
* Usage
* When to use:
*
* - You need to select one or more entries from a comprehensive list that contains multiple attributes or values.
*
* When not to use:
*
* - You need to pick one item from a predefined set of options. Use {@link sap.m.Select select}
* or {@link sap.m.ComboBox combobox} instead.
* - You need to select a range of item. Use {@link sap.ui.comp.valuehelpdialog.ValueHelpDialog value help dialog instead.
* - You need to be able to add your own values to an existing list. Use a {@link sap.m.Dialog dialog} instead.
*
* Responsive Behavior
*
* - On phones, the select dialog takes up the whole screen.
* - On desktop and tablet devices, the select dialog appears as a popover.
*
*/
export class SelectDialog extends sap.ui.core.Control {
/**
* Constructor for a new SelectDialog.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control A dialog that enables users to select one or more items from a comprehensive list.
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.m.ListItemBase} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.m.ListItemBase): sap.m.SelectDialog;
/**
* Forward method to the inner dialog: addStyleClass
* @returns {sap.m.SelectDialog} this pointer for chaining
*/
public addStyleClass(): sap.m.SelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.m.SelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectDialog
itself.
*
* This event will be fired when the cancel button is clicked
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectDialog
itself
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public attachCancel(fnFunction: Function, oListener?: any): sap.m.SelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.m.SelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectDialog
itself.
*
* This event will be fired when the cancel button is clicked
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectDialog
itself
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public attachCancel(oData: any, fnFunction: Function, oListener?: any): sap.m.SelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:confirm confirm} event of this sap.m.SelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectDialog
itself.
*
* This event will be fired when the dialog is confirmed by selecting an item in single selection mode or by pressing the confirmation button in multi selection mode . The items being selected are returned as event parameters.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectDialog
itself
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public attachConfirm(fnFunction: Function, oListener?: any): sap.m.SelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:confirm confirm} event of this sap.m.SelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectDialog
itself.
*
* This event will be fired when the dialog is confirmed by selecting an item in single selection mode or by pressing the confirmation button in multi selection mode . The items being selected are returned as event parameters.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectDialog
itself
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public attachConfirm(oData: any, fnFunction: Function, oListener?: any): sap.m.SelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.m.SelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectDialog
itself.
*
* This event will be fired when the value of the search field is changed by a user - e.g. at each key press
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectDialog
itself
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public attachLiveChange(fnFunction: Function, oListener?: any): sap.m.SelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.m.SelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectDialog
itself.
*
* This event will be fired when the value of the search field is changed by a user - e.g. at each key press
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectDialog
itself
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public attachLiveChange(oData: any, fnFunction: Function, oListener?: any): sap.m.SelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.m.SelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectDialog
itself.
*
* This event will be fired when the search button has been clicked on the searchfield on the visual control
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectDialog
itself
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public attachSearch(fnFunction: Function, oListener?: any): sap.m.SelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.m.SelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectDialog
itself.
*
* This event will be fired when the search button has been clicked on the searchfield on the visual control
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectDialog
itself
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public attachSearch(oData: any, fnFunction: Function, oListener?: any): sap.m.SelectDialog;
/**
* Forwards aggregations with the name of items to the internal list.
* @param {string} sAggregationName - The name for the binding
* @param {any} oBindingInfo - The configuration parameters for the binding
* @returns {sap.m.SelectDialog} this pointer for chaining
*/
public bindAggregation(sAggregationName: string, oBindingInfo: any): sap.m.SelectDialog;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.SelectDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:cancel cancel} event of this sap.m.SelectDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public detachCancel(fnFunction: Function, oListener: any): sap.m.SelectDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:confirm confirm} event of this sap.m.SelectDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public detachConfirm(fnFunction: Function, oListener: any): sap.m.SelectDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:liveChange liveChange} event of this sap.m.SelectDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public detachLiveChange(fnFunction: Function, oListener: any): sap.m.SelectDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:search search} event of this sap.m.SelectDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public detachSearch(fnFunction: Function, oListener: any): sap.m.SelectDialog;
/**
* Creates a new subclass of class sap.m.SelectDialog with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:cancel cancel} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
protected fireCancel(mParameters?: any): sap.m.SelectDialog;
/**
* Fires event {@link #event:confirm confirm} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
protected fireConfirm(mParameters?: any): sap.m.SelectDialog;
/**
* Fires event {@link #event:liveChange liveChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
protected fireLiveChange(mParameters?: any): sap.m.SelectDialog;
/**
* Fires event {@link #event:search search} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
protected fireSearch(mParameters?: any): sap.m.SelectDialog;
/**
* Get the internal Dialog's contentHeight property {@link sap.m.Dialog}
* @returns {sap.ui.core.CSSSize} sHeight The content width of the internal dialog
*/
public getContentHeight(): sap.ui.core.CSSSize;
/**
* Get the internal Dialog's contentWidth property {@link sap.m.Dialog}
* @returns {sap.ui.core.CSSSize} sWidth The content width of the internal dialog
*/
public getContentWidth(): sap.ui.core.CSSSize;
/**
* Forward method to the inner dialog: getDomRef
* @returns {HTMLElement} The Element's DOM Element sub DOM Element or null
*/
public getDomRef(): HTMLElement;
/**
* Gets current value of property {@link #getGrowingThreshold growingThreshold}.
*
* Determines the number of items initially displayed in the list. Also defines the number of items to be requested from the model for each grow.
* @returns {number} Value of property growingThreshold
*/
public getGrowingThreshold(): number;
/**
* Gets content of aggregation {@link #getItems items}.
*
* The items of the list shown in the search dialog. It is recommended to use a StandardListItem for the dialog but other combinations are also possible.
* @returns {sap.m.ListItemBase[]}
*/
public getItems(): sap.m.ListItemBase[];
/**
* Returns a metadata object for class sap.m.SelectDialog.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMultiSelect multiSelect}.
*
* Determines if the user can select several options from the list
*
* Default value is false
.
* @returns {boolean} Value of property multiSelect
*/
public getMultiSelect(): boolean;
/**
* Get the internal List's no data text property
* @returns {string} the current no data text
*/
public getNoDataText(): string;
/**
* Gets current value of property {@link #getRememberSelections rememberSelections}.
*
* This flag controls whether the dialog clears the selection after the confirm event has been fired. If the dialog needs to be opened multiple times in the same context to allow for corrections of previous user inputs, set this flag to "true".
*
* Default value is false
.
* @returns {boolean} Value of property rememberSelections
*/
public getRememberSelections(): boolean;
/**
* Gets current value of property {@link #getTitle title}.
*
* Determines the title text that appears in the dialog header
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Forward method to the inner dialog: hasStyleClass
* @returns {boolean} true if the class is set, false otherwise
*/
public hasStyleClass(): boolean;
/**
* Checks for the provided sap.m.ListItemBase
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ListItemBase} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.m.ListItemBase): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.m.ListItemBase} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.m.ListItemBase, iIndex: number): sap.m.SelectDialog;
/**
* Opens the internal dialog with a searchfield and a list.
* @param {string} sSearchValue - A value for the search can be passed to match with the filter applied to the list binding.
* @returns {sap.m.SelectDialog}
*/
public open(sSearchValue: string): sap.m.SelectDialog;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ListItemBase[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.m.ListItemBase[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.m.ListItemBase} vItem - The item to remove or its index or id
* @returns {sap.m.ListItemBase} The removed item or null
*/
public removeItem(vItem: number|string|sap.m.ListItemBase): sap.m.ListItemBase;
/**
* Forward method to the inner dialog: removeStyleClass
* @returns {sap.m.SelectDialog} this pointer for chaining
*/
public removeStyleClass(): sap.m.SelectDialog;
/**
* Set the internal Dialog's contentHeight property {@link sap.m.Dialog}
* @param {sap.ui.core.CSSSize} sHeight - The new content width value for the dialog
* @returns {sap.m.SelectDialog} this pointer for chaining
*/
public setContentHeight(sHeight: sap.ui.core.CSSSize): sap.m.SelectDialog;
/**
* Set the internal Dialog's contentWidth property {@link sap.m.Dialog}
* @param {sap.ui.core.CSSSize} sWidth - The new content width value for the dialog
* @returns {sap.m.SelectDialog} this pointer for chaining
*/
public setContentWidth(sWidth: sap.ui.core.CSSSize): sap.m.SelectDialog;
/**
* Sets the growing threshold to the internal list
* @param {number} iValue - Value for the list's growing threshold.
* @returns {sap.m.SelectDialog} this pointer for chaining
*/
public setGrowingThreshold(iValue: number): sap.m.SelectDialog;
/**
* Enable/Disable multi selection mode.
* @param {boolean} bMulti - Flag for multi selection mode
* @returns {sap.m.SelectDialog} this pointer for chaining
*/
public setMultiSelect(bMulti: boolean): sap.m.SelectDialog;
/**
* Set the internal List's no data text property
* @param {string} sNoDataText - The no data text for the list
* @returns {sap.m.SelectDialog} this pointer for chaining
*/
public setNoDataText(sNoDataText: string): sap.m.SelectDialog;
/**
* Sets a new value for property {@link #getRememberSelections rememberSelections}.
*
* This flag controls whether the dialog clears the selection after the confirm event has been fired. If the dialog needs to be opened multiple times in the same context to allow for corrections of previous user inputs, set this flag to "true".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bRememberSelections - New value for property rememberSelections
* @returns {sap.m.SelectDialog} Reference to this
in order to allow method chaining
*/
public setRememberSelections(bRememberSelections: boolean): sap.m.SelectDialog;
/**
* Set the title of the internal dialog
* @param {string} sTitle - The title text for the dialog
* @returns {sap.m.SelectDialog} this pointer for chaining
*/
public setTitle(sTitle: string): sap.m.SelectDialog;
/**
* Forward method to the inner dialog: toggleStyleClass
* @returns {sap.m.SelectDialog} this pointer for chaining
*/
public toggleStyleClass(): sap.m.SelectDialog;
}
/**
* The protected control provides a popover that displays the details of the items selected in the chart. This control should only be used in the suite.ui.commons.ChartContainer toolbar and sap.ui.comp.smartchart.SmartChart controls. Initially, the control is rendered as a button that opens the popup after clicking on it.
* Note:It is protected and should ony be used within the framework itself.
*/
export class SelectionDetails extends sap.ui.core.Control {
/**
* Constructor for a new SelectionDetails.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some action to the aggregation {@link #getActions actions}.
* @param {sap.ui.core.Item} oAction - the action to add; if empty, nothing is inserted
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public addAction(oAction: sap.ui.core.Item): sap.m.SelectionDetails;
/**
* Adds some actionGroup to the aggregation {@link #getActionGroups actionGroups}.
* @param {sap.ui.core.Item} oActionGroup - the actionGroup to add; if empty, nothing is inserted
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public addActionGroup(oActionGroup: sap.ui.core.Item): sap.m.SelectionDetails;
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.m.SelectionDetailsItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.m.SelectionDetailsItem): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:actionPress actionPress} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered when a custom action is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public attachActionPress(fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:actionPress actionPress} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered when a custom action is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public attachActionPress(oData: any, fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered before the popover is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public attachBeforeClose(fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered before the popover is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public attachBeforeClose(oData: any, fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered before the popover is open.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered before the popover is open.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered after a list item of {@link sap.m.SelectionDetailsItem} is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public attachNavigate(fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered after a list item of {@link sap.m.SelectionDetailsItem} is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public attachNavigate(oData: any, fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Attaches an event handler to the given listener to react to user selection interaction.
* @param {string} eventId - The identifier of the event to listen for
* @param {any} listener - The object which triggers the event to register on
* @returns {sap.m.SelectionDetails} this to allow method chaining
*/
protected attachSelectionHandler(eventId: string, listener: any): sap.m.SelectionDetails;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.m.SelectionDetails;
/**
* Destroys all the actionGroups in the aggregation {@link #getActionGroups actionGroups}.
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public destroyActionGroups(): sap.m.SelectionDetails;
/**
* Destroys all the actions in the aggregation {@link #getActions actions}.
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public destroyActions(): sap.m.SelectionDetails;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.SelectionDetails;
/**
* Detaches event handler fnFunction
from the {@link #event:actionPress actionPress} event of this sap.m.SelectionDetails
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public detachActionPress(fnFunction: Function, oListener: any): sap.m.SelectionDetails;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeClose beforeClose} event of this sap.m.SelectionDetails
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public detachBeforeClose(fnFunction: Function, oListener: any): sap.m.SelectionDetails;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeOpen beforeOpen} event of this sap.m.SelectionDetails
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public detachBeforeOpen(fnFunction: Function, oListener: any): sap.m.SelectionDetails;
/**
* Detaches event handler fnFunction
from the {@link #event:navigate navigate} event of this sap.m.SelectionDetails
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public detachNavigate(fnFunction: Function, oListener: any): sap.m.SelectionDetails;
/**
* Detaches the event which was attached by attachSelectionHandler
.
* @returns {sap.m.SelectionDetails} this to allow method chaining
*/
protected detachSelectionHandler(): sap.m.SelectionDetails;
/**
* Creates a new subclass of class sap.m.SelectionDetails with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:actionPress actionPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
protected fireActionPress(mParameters?: any): sap.m.SelectionDetails;
/**
* Fires event {@link #event:beforeClose beforeClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
protected fireBeforeClose(mParameters?: any): sap.m.SelectionDetails;
/**
* Fires event {@link #event:beforeOpen beforeOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
protected fireBeforeOpen(mParameters?: any): sap.m.SelectionDetails;
/**
* Fires event {@link #event:navigate navigate} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
protected fireNavigate(mParameters?: any): sap.m.SelectionDetails;
/**
* Gets content of aggregation {@link #getActionGroups actionGroups}.
*
* Contains actions that are rendered as a dedicated {@link sap.m.StandardListItem item}.
* In case an action group is pressed, a navigation should be triggered via navTo
method.
* A maximum of 5 actionGroups is displayed inside the popover, though more can be added to the aggregation.
* @returns {sap.ui.core.Item[]}
*/
public getActionGroups(): sap.ui.core.Item[];
/**
* Gets content of aggregation {@link #getActions actions}.
*
* Contains custom actions shown in the responsive toolbar below items on the first page.
* @returns {sap.ui.core.Item[]}
*/
public getActions(): sap.ui.core.Item[];
/**
* Returns the public facade of the SelectionDetails control for non inner framework usages.
* @returns {sap.ui.base.Interface} The reduced facade for outer framework usages.
*/
protected getFacade(): sap.ui.base.Interface;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Contains {@link sap.m.SelectionDetailsItem items} that are displayed on the first page.
* @returns {sap.m.SelectionDetailsItem[]}
*/
public getItems(): sap.m.SelectionDetailsItem[];
/**
* Returns a metadata object for class sap.m.SelectionDetails.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.Item
in the aggregation {@link #getActions actions}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Item} oAction - The action whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAction(oAction: sap.ui.core.Item): number;
/**
* Checks for the provided sap.ui.core.Item
in the aggregation {@link #getActionGroups actionGroups}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Item} oActionGroup - The actionGroup whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfActionGroup(oActionGroup: sap.ui.core.Item): number;
/**
* Checks for the provided sap.m.SelectionDetailsItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.SelectionDetailsItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.m.SelectionDetailsItem): number;
/**
* Inserts a action into the aggregation {@link #getActions actions}.
* @param {sap.ui.core.Item} oAction - the action to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the action should be inserted at; for a negative value of iIndex
, the action is inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted at the last position
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public insertAction(oAction: sap.ui.core.Item, iIndex: number): sap.m.SelectionDetails;
/**
* Inserts a actionGroup into the aggregation {@link #getActionGroups actionGroups}.
* @param {sap.ui.core.Item} oActionGroup - the actionGroup to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the actionGroup should be inserted at; for a negative value of iIndex
, the actionGroup is inserted at position 0; for a value greater than the current size of the aggregation, the actionGroup is inserted at the last position
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public insertActionGroup(oActionGroup: sap.ui.core.Item, iIndex: number): sap.m.SelectionDetails;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.m.SelectionDetailsItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.m.SelectionDetailsItem, iIndex: number): sap.m.SelectionDetails;
/**
* Method to register the factory function that creates the SelectionDetailsItems.
* The factory function is called for every selected entry separately with three parameters.
* First parameter is the display data array for each item out of the selection.
* Second parameter is the data array for each item out of the selection.
* Third parameter is the binding context for each item in the selection. This is undefined if no binding is used.
* Fourth parameter is oData
. Can be undefined.
* @param {any} data - Data to be passed to the factory function
* @param {Function} factory - The item factory function that returns SelectionDetailsItems
* @returns {sap.m.SelectionDetails} this to allow method chaining
*/
protected registerSelectionDetailsItemFactory(data: any, factory: Function): sap.m.SelectionDetails;
/**
* Removes a action from the aggregation {@link #getActions actions}.
* @param {number|string|sap.ui.core.Item} vAction - The action to remove or its index or id
* @returns {sap.ui.core.Item} The removed action or null
*/
public removeAction(vAction: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Removes a actionGroup from the aggregation {@link #getActionGroups actionGroups}.
* @param {number|string|sap.ui.core.Item} vActionGroup - The actionGroup to remove or its index or id
* @returns {sap.ui.core.Item} The removed actionGroup or null
*/
public removeActionGroup(vActionGroup: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Removes all the controls from the aggregation {@link #getActionGroups actionGroups}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Item[]} An array of the removed elements (might be empty)
*/
public removeAllActionGroups(): sap.ui.core.Item[];
/**
* Removes all the controls from the aggregation {@link #getActions actions}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Item[]} An array of the removed elements (might be empty)
*/
public removeAllActions(): sap.ui.core.Item[];
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.SelectionDetailsItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.m.SelectionDetailsItem[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.m.SelectionDetailsItem} vItem - The item to remove or its index or id
* @returns {sap.m.SelectionDetailsItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.m.SelectionDetailsItem): sap.m.SelectionDetailsItem;
/**
* Sets the popover to modal or non-modal based on the given parameter. This only takes effect on desktop or tablet.
* Please see the documentation {@link sap.m.ResponsivePopover#modal}.
* @param {boolean} modal - New value for property modal of the internally used popover.
* @returns {sap.m.SelectionDetails} To ensure method chaining, return the SelectionDetails.
*/
protected setPopoverModal(modal: boolean): sap.m.SelectionDetails;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.m.SelectionDetails;
}
/**
* Enumeration for different action levels in sap.m.SelectionDetails control.
*/
export enum SelectionDetailsActionLevel {
}
/**
* The public facade of the {@link sap.m.SelectionDetails} control
*/
export class SelectionDetailsFacade extends sap.ui.base.Interface {
/**
* Describes the public facade of the {@link sap.m.SelectionDetails} control.
*/
public constructor();
/**
* Adds some action to the aggregation {@link #getActions actions}.
* @param {sap.ui.core.Item} oAction - the action to add; if empty, nothing is inserted
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public static addAction(oAction: sap.ui.core.Item): sap.m.SelectionDetails;
/**
* Adds some actionGroup to the aggregation {@link #getActionGroups actionGroups}.
* @param {sap.ui.core.Item} oActionGroup - the actionGroup to add; if empty, nothing is inserted
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public static addActionGroup(oActionGroup: sap.ui.core.Item): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:actionPress actionPress} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered when a custom action is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public static attachActionPress(fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:actionPress actionPress} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered when a custom action is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public static attachActionPress(oData: any, fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered before the popover is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public static attachBeforeClose(fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeClose beforeClose} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered before the popover is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public static attachBeforeClose(oData: any, fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered before the popover is open.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public static attachBeforeOpen(fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered before the popover is open.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public static attachBeforeOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered after a list item of {@link sap.m.SelectionDetailsItem} is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public static attachNavigate(fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.m.SelectionDetails
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectionDetails
itself.
*
* Event is triggered after a list item of {@link sap.m.SelectionDetailsItem} is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectionDetails
itself
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public static attachNavigate(oData: any, fnFunction: Function, oListener?: any): sap.m.SelectionDetails;
/**
* Closes SelectionDetails if open.
* @returns {sap.m.SelectionDetails} To ensure method chaining, return the SelectionDetails.
*/
public close(): sap.m.SelectionDetails;
/**
* Detaches event handler fnFunction
from the {@link #event:actionPress actionPress} event of this sap.m.SelectionDetails
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public static detachActionPress(fnFunction: Function, oListener: any): sap.m.SelectionDetails;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeClose beforeClose} event of this sap.m.SelectionDetails
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public static detachBeforeClose(fnFunction: Function, oListener: any): sap.m.SelectionDetails;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeOpen beforeOpen} event of this sap.m.SelectionDetails
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public static detachBeforeOpen(fnFunction: Function, oListener: any): sap.m.SelectionDetails;
/**
* Detaches event handler fnFunction
from the {@link #event:navigate navigate} event of this sap.m.SelectionDetails
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SelectionDetails} Reference to this
in order to allow method chaining
*/
public static detachNavigate(fnFunction: Function, oListener: any): sap.m.SelectionDetails;
/**
* Returns true if the SelectionDetails is enabled, otherwise false.
* @returns {boolean} True if the SelectionDetails contains items, otherwise false.
*/
public isEnabled(): boolean;
/**
* Returns true if the SelectionDetails is open, otherwise false.
* @returns {boolean} True if the SelectionDetails is open, otherwise false.
*/
public isOpen(): boolean;
/**
* Wraps the given content in {@link sap.m.Page page}, adds it to existing {@link sap.m.NavContainer NavContainer} and navigates to this newly created page.
* Has no effect if the SelectionDetails is closed.
* Lazily processes dependencies for the navigation event.
* @param {string} title - The title property of the {@link sap.m.Page page} control to which the navigation should occur.
* @param {sap.ui.core.Control} content - The content of the control to which the navigation should occur.
* @returns {sap.m.SelectionDetails} To ensure method chaining, return the SelectionDetails.
*/
public navTo(title: string, content: sap.ui.core.Control): sap.m.SelectionDetails;
/**
* Removes a action from the aggregation {@link #getActions actions}.
* @param {number|string|sap.ui.core.Item} vAction - The action to remove or its index or id
* @returns {sap.ui.core.Item} The removed action or null
*/
public static removeAction(vAction: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Removes a actionGroup from the aggregation {@link #getActionGroups actionGroups}.
* @param {number|string|sap.ui.core.Item} vActionGroup - The actionGroup to remove or its index or id
* @returns {sap.ui.core.Item} The removed actionGroup or null
*/
public static removeActionGroup(vActionGroup: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Removes all the controls from the aggregation {@link #getActionGroups actionGroups}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Item[]} An array of the removed elements (might be empty)
*/
public static removeAllActionGroups(): sap.ui.core.Item[];
/**
* Removes all the controls from the aggregation {@link #getActions actions}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Item[]} An array of the removed elements (might be empty)
*/
public static removeAllActions(): sap.ui.core.Item[];
}
/**
* This protected element provides an item for {@link sap.m.SelectionDetails} that is shown inside a list.
* The item includes SelectionDetailsItemLine as its lines that are displayed in one block above the optional actions.
* Note:It is protected and should ony be used within the framework itself.
*/
export class SelectionDetailsItem extends sap.ui.core.Element {
/**
* Constructor for a new SelectionDetailsItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some action to the aggregation {@link #getActions actions}.
* @param {sap.ui.core.Item} oAction - the action to add; if empty, nothing is inserted
* @returns {sap.m.SelectionDetailsItem} Reference to this
in order to allow method chaining
*/
public addAction(oAction: sap.ui.core.Item): sap.m.SelectionDetailsItem;
/**
* Adds some line to the aggregation {@link #getLines lines}.
* @param {sap.m.SelectionDetailsItemLine} oLine - the line to add; if empty, nothing is inserted
* @returns {sap.m.SelectionDetailsItem} Reference to this
in order to allow method chaining
*/
public addLine(oLine: sap.m.SelectionDetailsItemLine): sap.m.SelectionDetailsItem;
/**
* Binds aggregation {@link #getLines lines} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.SelectionDetailsItem} Reference to this
in order to allow method chaining
*/
public bindLines(oBindingInfo: any): sap.m.SelectionDetailsItem;
/**
* Destroys all the actions in the aggregation {@link #getActions actions}.
* @returns {sap.m.SelectionDetailsItem} Reference to this
in order to allow method chaining
*/
public destroyActions(): sap.m.SelectionDetailsItem;
/**
* Destroys all the lines in the aggregation {@link #getLines lines}.
* @returns {sap.m.SelectionDetailsItem} Reference to this
in order to allow method chaining
*/
public destroyLines(): sap.m.SelectionDetailsItem;
/**
* Creates a new subclass of class sap.m.SelectionDetailsItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getActions actions}.
*
* Contains custom actions shown below the main content of the item.
* @returns {sap.ui.core.Item[]}
*/
public getActions(): sap.ui.core.Item[];
/**
* Gets current value of property {@link #getEnableNav enableNav}.
*
* Determines whether or not the item is active and a navigation event is triggered on press.
*
* Default value is false
.
* @returns {boolean} Value of property enableNav
*/
public getEnableNav(): boolean;
/**
* Returns the public facade of the SelectionDetailsItem for non inner framework usages.
* @returns {sap.ui.base.Interface} The reduced facade for outer framework usages.
*/
protected getFacade(): sap.ui.base.Interface;
/**
* Gets content of aggregation {@link #getLines lines}.
*
* Contains a record of information about, for example, measures and dimensions.
* These entries are usually obtained via selection in chart controls.
* @returns {sap.m.SelectionDetailsItemLine[]}
*/
public getLines(): sap.m.SelectionDetailsItemLine[];
/**
* Returns a metadata object for class sap.m.SelectionDetailsItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.Item
in the aggregation {@link #getActions actions}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Item} oAction - The action whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAction(oAction: sap.ui.core.Item): number;
/**
* Checks for the provided sap.m.SelectionDetailsItemLine
in the aggregation {@link #getLines lines}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.SelectionDetailsItemLine} oLine - The line whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfLine(oLine: sap.m.SelectionDetailsItemLine): number;
/**
* Inserts a action into the aggregation {@link #getActions actions}.
* @param {sap.ui.core.Item} oAction - the action to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the action should be inserted at; for a negative value of iIndex
, the action is inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted at the last position
* @returns {sap.m.SelectionDetailsItem} Reference to this
in order to allow method chaining
*/
public insertAction(oAction: sap.ui.core.Item, iIndex: number): sap.m.SelectionDetailsItem;
/**
* Inserts a line into the aggregation {@link #getLines lines}.
* @param {sap.m.SelectionDetailsItemLine} oLine - the line to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the line should be inserted at; for a negative value of iIndex
, the line is inserted at position 0; for a value greater than the current size of the aggregation, the line is inserted at the last position
* @returns {sap.m.SelectionDetailsItem} Reference to this
in order to allow method chaining
*/
public insertLine(oLine: sap.m.SelectionDetailsItemLine, iIndex: number): sap.m.SelectionDetailsItem;
/**
* Removes a action from the aggregation {@link #getActions actions}.
* @param {number|string|sap.ui.core.Item} vAction - The action to remove or its index or id
* @returns {sap.ui.core.Item} The removed action or null
*/
public removeAction(vAction: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Removes all the controls from the aggregation {@link #getActions actions}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Item[]} An array of the removed elements (might be empty)
*/
public removeAllActions(): sap.ui.core.Item[];
/**
* Removes all the controls from the aggregation {@link #getLines lines}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.SelectionDetailsItemLine[]} An array of the removed elements (might be empty)
*/
public removeAllLines(): sap.m.SelectionDetailsItemLine[];
/**
* Removes a line from the aggregation {@link #getLines lines}.
* @param {number|string|sap.m.SelectionDetailsItemLine} vLine - The line to remove or its index or id
* @returns {sap.m.SelectionDetailsItemLine} The removed line or null
*/
public removeLine(vLine: number|string|sap.m.SelectionDetailsItemLine): sap.m.SelectionDetailsItemLine;
/**
* Sets a new value for property {@link #getEnableNav enableNav}.
*
* Determines whether or not the item is active and a navigation event is triggered on press.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableNav - New value for property enableNav
* @returns {sap.m.SelectionDetailsItem} Reference to this
in order to allow method chaining
*/
public setEnableNav(bEnableNav: boolean): sap.m.SelectionDetailsItem;
/**
* Unbinds aggregation {@link #getLines lines} from model data.
* @returns {sap.m.SelectionDetailsItem} Reference to this
in order to allow method chaining
*/
public unbindLines(): sap.m.SelectionDetailsItem;
}
/**
* The public facade of the {@link SelectionDetailsItems} element
*/
export class SelectionDetailsItemFacade extends sap.ui.base.Interface {
/**
* Describes the public facade of the {@link SelectionDetailsItems} element.
*/
public constructor();
/**
* Adds some action to the aggregation {@link #getActions actions}.
* @param {sap.ui.core.Item} oAction - the action to add; if empty, nothing is inserted
* @returns {sap.m.SelectionDetailsItem} Reference to this
in order to allow method chaining
*/
public static addAction(oAction: sap.ui.core.Item): sap.m.SelectionDetailsItem;
/**
* Gets current value of property {@link #getEnableNav enableNav}.
*
* Determines whether or not the item is active and a navigation event is triggered on press.
*
* Default value is false
.
* @returns {boolean} Value of property enableNav
*/
public static getEnableNav(): boolean;
/**
* Removes a action from the aggregation {@link #getActions actions}.
* @param {number|string|sap.ui.core.Item} vAction - The action to remove or its index or id
* @returns {sap.ui.core.Item} The removed action or null
*/
public static removeAction(vAction: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Sets a new value for property {@link #getEnableNav enableNav}.
*
* Determines whether or not the item is active and a navigation event is triggered on press.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableNav - New value for property enableNav
* @returns {sap.m.SelectionDetailsItem} Reference to this
in order to allow method chaining
*/
public static setEnableNav(bEnableNav: boolean): sap.m.SelectionDetailsItem;
}
/**
* This Element provides a means to fill an {@link sap.m.SelectionDetailsItem} with content.
* It is used for a form-like display of a label followed by a value with an optional unit.
* If the unit is used, the value is displayed bold.
* Note:It is protected and should ony be used within the framework itself.
*/
export class SelectionDetailsItemLine extends sap.ui.core.Element {
/**
* Constructor for a new SelectionDetailsItemLine.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.SelectionDetailsItemLine with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getDisplayValue displayValue}.
*
* The display value of the line. If this property is set, it overrides the value property and is displayed as is.
* @returns {string} Value of property displayValue
*/
public getDisplayValue(): string;
/**
* Gets current value of property {@link #getLabel label}.
*
* The label that is shown as the first part of the line.
* It may contain the name of the currently selected dimension or measure.
* @returns {string} Value of property label
*/
public getLabel(): string;
/**
* Returns a metadata object for class sap.m.SelectionDetailsItemLine.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getUnit unit}.
*
* The unit of the given value. If this unit is given, the line is displayed bold.
* @returns {string} Value of property unit
*/
public getUnit(): string;
/**
* Gets current value of property {@link #getValue value}.
*
* The value of the line, for example the value of the currently selected measure.
* Expected type is a string or a plain object, including date and time properties of type string.
* @returns {any} Value of property value
*/
public getValue(): any;
/**
* Sets a new value for property {@link #getDisplayValue displayValue}.
*
* The display value of the line. If this property is set, it overrides the value property and is displayed as is.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sDisplayValue - New value for property displayValue
* @returns {sap.m.SelectionDetailsItemLine} Reference to this
in order to allow method chaining
*/
public setDisplayValue(sDisplayValue: string): sap.m.SelectionDetailsItemLine;
/**
* Sets a new value for property {@link #getLabel label}.
*
* The label that is shown as the first part of the line.
* It may contain the name of the currently selected dimension or measure.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sLabel - New value for property label
* @returns {sap.m.SelectionDetailsItemLine} Reference to this
in order to allow method chaining
*/
public setLabel(sLabel: string): sap.m.SelectionDetailsItemLine;
/**
* Sets a new value for property {@link #getUnit unit}.
*
* The unit of the given value. If this unit is given, the line is displayed bold.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sUnit - New value for property unit
* @returns {sap.m.SelectionDetailsItemLine} Reference to this
in order to allow method chaining
*/
public setUnit(sUnit: string): sap.m.SelectionDetailsItemLine;
/**
* Sets a new value for property {@link #getValue value}.
*
* The value of the line, for example the value of the currently selected measure.
* Expected type is a string or a plain object, including date and time properties of type string.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oValue - New value for property value
* @returns {sap.m.SelectionDetailsItemLine} Reference to this
in order to allow method chaining
*/
public setValue(oValue: any): sap.m.SelectionDetailsItemLine;
}
/**
* The sap.m.SelectList
displays a list of items that allows the user to select an item.
*/
export class SelectList extends sap.ui.core.Control {
/**
* Constructor for a new sap.m.SelectList
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given.
* @param {any} mSettings - Initial settings for the new control.
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.SelectList;
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.ui.core.Item} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.ui.core.Item): sap.m.SelectList;
/**
* Attaches event handler fnFunction
to the {@link #event:itemPress itemPress} event of this sap.m.SelectList
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectList
itself.
*
* This event is fired when an item is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectList
itself
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public attachItemPress(fnFunction: Function, oListener?: any): sap.m.SelectList;
/**
* Attaches event handler fnFunction
to the {@link #event:itemPress itemPress} event of this sap.m.SelectList
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectList
itself.
*
* This event is fired when an item is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectList
itself
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public attachItemPress(oData: any, fnFunction: Function, oListener?: any): sap.m.SelectList;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChange selectionChange} event of this sap.m.SelectList
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectList
itself.
*
* This event is fired when the selection has changed.
*
* Note: The selection can be changed by pressing a non-selected item or
* via keyboard and after the enter or space key is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectList
itself
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public attachSelectionChange(fnFunction: Function, oListener?: any): sap.m.SelectList;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChange selectionChange} event of this sap.m.SelectList
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SelectList
itself.
*
* This event is fired when the selection has changed.
*
* Note: The selection can be changed by pressing a non-selected item or
* via keyboard and after the enter or space key is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SelectList
itself
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public attachSelectionChange(oData: any, fnFunction: Function, oListener?: any): sap.m.SelectList;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.m.SelectList;
/**
* Clear the selection.
*/
protected clearSelection(): void;
/**
* Destroys all the items in the aggregation named items
.
* @returns {sap.m.SelectList} this
to allow method chaining.
*/
public destroyItems(): sap.m.SelectList;
/**
* Detaches event handler fnFunction
from the {@link #event:itemPress itemPress} event of this sap.m.SelectList
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public detachItemPress(fnFunction: Function, oListener: any): sap.m.SelectList;
/**
* Detaches event handler fnFunction
from the {@link #event:selectionChange selectionChange} event of this sap.m.SelectList
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public detachSelectionChange(fnFunction: Function, oListener: any): sap.m.SelectList;
/**
* Creates a new subclass of class sap.m.SelectList with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:itemPress itemPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
protected fireItemPress(mParameters?: any): sap.m.SelectList;
/**
* Fires event {@link #event:selectionChange selectionChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
protected fireSelectionChange(mParameters?: any): sap.m.SelectList;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Retrieves the default selected item from the aggregation named items
.
* @param {sap.ui.core.Item[]} aItems
* @returns {sap.ui.core.Item|null}
*/
protected getDefaultSelectedItem(aItems?: sap.ui.core.Item[]): sap.ui.core.Item|null;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Indicates whether the user can change the selection.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets the enabled items from the aggregation named items
.
* @param {sap.ui.core.Item[]} aItems - items to filter
* @returns {sap.ui.core.Item[]} An array containing the enabled items.
*/
public getEnabledItems(aItems?: sap.ui.core.Item[]): sap.ui.core.Item[];
/**
* Gets the first item from the aggregation named items
.
* @returns {sap.ui.core.Item|null} The first item, or null if there are no items.
*/
public getFirstItem(): sap.ui.core.Item|null;
/**
* Gets the item from the aggregation named items
at the given 0-based index.
* @param {number} iIndex - Index of the item to return.
* @returns {sap.ui.core.Item|null} Item at the given index, or null if none.
*/
public getItemAt(iIndex: number): sap.ui.core.Item|null;
/**
* Gets the item with the given key from the aggregation named items
.
*
* Note: If duplicate keys exists, the first item matching the key is returned.
* @param {string} sKey - An item key that specifies the item to retrieve.
* @returns {sap.ui.core.Item|null}
*/
public getItemByKey(sKey: string): sap.ui.core.Item|null;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Defines the items contained within this control.
* @returns {sap.ui.core.Item[]}
*/
public getItems(): sap.ui.core.Item[];
/**
* Gets current value of property {@link #getKeyboardNavigationMode keyboardNavigationMode}.
*
* Defines the keyboard navigation mode.
*
* Note: The sap.m.SelectListKeyboardNavigationMode.None
enumeration value,
* is only intended for use in some composite controls that handles keyboard navigation by themselves.
*
* Default value is Delimited
.
* @returns {sap.m.SelectListKeyboardNavigationMode} Value of property keyboardNavigationMode
*/
public getKeyboardNavigationMode(): sap.m.SelectListKeyboardNavigationMode;
/**
* Gets the enabled items from the aggregation named items
.
* @returns {sap.ui.core.Item|null} The last item, or null if there are no items.
*/
public getLastItem(): sap.ui.core.Item|null;
/**
* Gets current value of property {@link #getMaxWidth maxWidth}.
*
* Sets the maximum width of the control.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property maxWidth
*/
public getMaxWidth(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.m.SelectList.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets the selected item object from the aggregation named items
.
* @returns {sap.ui.core.Item|null} The current target of the selectedItem
association, or null.
*/
public getSelectedItem(): sap.ui.core.Item|null;
/**
* Gets current value of property {@link #getSelectedItemId selectedItemId}.
*
* ID of the selected item.
*
* Default value is
.
* @returns {string} Value of property selectedItemId
*/
public getSelectedItemId(): string;
/**
* Gets current value of property {@link #getSelectedKey selectedKey}.
*
* Key of the selected item.
*
* Note: If duplicate keys exist, the first item matching the key is used.
*
* Default value is
.
* @returns {string} Value of property selectedKey
*/
public getSelectedKey(): string;
/**
* Gets current value of property {@link #getShowSecondaryValues showSecondaryValues}.
*
* Indicates whether the text values of the additionalText
property of a
* {@link sap.ui.core.ListItem} are shown.
*
* Default value is false
.
* @returns {boolean} Value of property showSecondaryValues
*/
public getShowSecondaryValues(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* Sets the width of the control.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Item
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Item} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.core.Item): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.ui.core.Item} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.ui.core.Item, iIndex: number): sap.m.SelectList;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the items in the aggregation named items
.
* Additionally unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Item[]} An array of the removed items (might be empty).
*/
public removeAllItems(): sap.ui.core.Item[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an item from the aggregation named items
.
* @param {number|string|sap.ui.core.Item} vItem - The item to remove or its index or id.
* @returns {sap.ui.core.Item} The removed item or null.
*/
public removeItem(vItem: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Indicates whether the user can change the selection.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.SelectList;
/**
* Sets a new value for property {@link #getKeyboardNavigationMode keyboardNavigationMode}.
*
* Defines the keyboard navigation mode.
*
* Note: The sap.m.SelectListKeyboardNavigationMode.None
enumeration value,
* is only intended for use in some composite controls that handles keyboard navigation by themselves.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Delimited
.
* @param {sap.m.SelectListKeyboardNavigationMode} sKeyboardNavigationMode - New value for property keyboardNavigationMode
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public setKeyboardNavigationMode(sKeyboardNavigationMode: sap.m.SelectListKeyboardNavigationMode): sap.m.SelectList;
/**
* Sets a new value for property {@link #getMaxWidth maxWidth}.
*
* Sets the maximum width of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sMaxWidth - New value for property maxWidth
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public setMaxWidth(sMaxWidth: sap.ui.core.CSSSize): sap.m.SelectList;
/**
* Sets the selectedItem
association.
* @param {string|sap.ui.core.Item|null} vItem - New value for the selectedItem
association. If an ID of a sap.ui.core.Item
is given, the item with this ID becomes the selectedItem
association. Alternatively, a sap.ui.core.Item
instance may be given or null
to clear the selection.
* @returns {sap.m.SelectList} this
to allow method chaining.
*/
public setSelectedItem(vItem: string|sap.ui.core.Item|null): sap.m.SelectList;
/**
* Sets property selectedItemId
.
*
* Default value is an empty string ""
or undefined
.
* @param {string|any} vItem - New value for property selectedItemId
.
* @returns {sap.m.SelectList} this
to allow method chaining.
*/
public setSelectedItemId(vItem: string|any): sap.m.SelectList;
/**
* Sets property selectedKey
.
*
* Default value is an empty string ""
or undefined
.
* @param {string} sKey - New value for property selectedKey
.
* @returns {sap.m.SelectList} this
to allow method chaining.
*/
public setSelectedKey(sKey: string): sap.m.SelectList;
/**
* Updates and synchronizes selectedItem
association, selectedItemId
and selectedKey
properties.
* @param {string|sap.ui.core.Item|null} vItem
*/
protected setSelection(vItem: string|sap.ui.core.Item|null): void;
/**
* Sets a new value for property {@link #getShowSecondaryValues showSecondaryValues}.
*
* Indicates whether the text values of the additionalText
property of a
* {@link sap.ui.core.ListItem} are shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowSecondaryValues - New value for property showSecondaryValues
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public setShowSecondaryValues(bShowSecondaryValues: boolean): sap.m.SelectList;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Sets the width of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.SelectList;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.m.SelectList} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.m.SelectList;
}
/**
* Defines the keyboard navigation mode.
*/
export enum SelectListKeyboardNavigationMode {
/**
* Keyboard navigation is delimited at the last item or first item of the list.
*/
Delimited = "Delimited",
/**
* Keyboard navigation is disabled.
*/
None = "None",
}
/**
* Enumeration for different Select types.
*/
export enum SelectType {
/**
* Will show the text.
*/
Default = "Default",
/**
* Will show only the specified icon.
*/
IconOnly = "IconOnly",
}
/**
*/
namespace semantic {
/**
* An AddAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*
* See {@link sap.m.semantic.MasterPage#addAction}, {@link sap.m.semantic.FullscreenPage#addAction}, {@link sap.m.semantic.DetailPage#addAction}
*/
export class AddAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new AddAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.AddAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.AddAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A CancelAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class CancelAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new CancelAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.CancelAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.CancelAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A DeleteAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class DeleteAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new DeleteAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.DeleteAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.DeleteAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A DetailPage is a {@link sap.m.semantic.ShareMenuPage} that supports semantic content of the following types:
*
*
* - {@link sap.m.semantic.AddAction}
* - {@link sap.m.semantic.MainAction}
* - {@link sap.m.semantic.PositiveAction}
* - {@link sap.m.semantic.NegativeAction}
* - {@link sap.m.semantic.ForwardAction}
* - {@link sap.m.semantic.EditAction}
* - {@link sap.m.semantic.SaveAction}
* - {@link sap.m.semantic.DeleteAction}
* - {@link sap.m.semantic.CancelAction}
* - {@link sap.m.semantic.FlagAction}
* - {@link sap.m.semantic.FavoriteAction}
* - {@link sap.m.semantic.OpenInAction}
* - {@link sap.m.semantic.DiscussInJamAction}
* - {@link sap.m.semantic.ShareInJamAction}
* - {@link sap.m.semantic.SendEmailAction}
* - {@link sap.m.semantic.SendMessageAction}
* - {@link sap.m.semantic.PrintAction}
* - {@link sap.m.semantic.MessagesIndicator}
* - {@link sap.m.DraftIndicator}
*
*/
export class DetailPage extends sap.m.semantic.ShareMenuPage {
/**
* Constructor for a new DetailPage
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Destroys the addAction in the aggregation {@link #getAddAction addAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyAddAction(): sap.m.semantic.DetailPage;
/**
* Destroys the cancelAction in the aggregation {@link #getCancelAction cancelAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyCancelAction(): sap.m.semantic.DetailPage;
/**
* Destroys the deleteAction in the aggregation {@link #getDeleteAction deleteAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyDeleteAction(): sap.m.semantic.DetailPage;
/**
* Destroys the discussInJamAction in the aggregation {@link #getDiscussInJamAction discussInJamAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyDiscussInJamAction(): sap.m.semantic.DetailPage;
/**
* Destroys the draftIndicator in the aggregation {@link #getDraftIndicator draftIndicator}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyDraftIndicator(): sap.m.semantic.DetailPage;
/**
* Destroys the editAction in the aggregation {@link #getEditAction editAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyEditAction(): sap.m.semantic.DetailPage;
/**
* Destroys the favoriteAction in the aggregation {@link #getFavoriteAction favoriteAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyFavoriteAction(): sap.m.semantic.DetailPage;
/**
* Destroys the flagAction in the aggregation {@link #getFlagAction flagAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyFlagAction(): sap.m.semantic.DetailPage;
/**
* Destroys the forwardAction in the aggregation {@link #getForwardAction forwardAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyForwardAction(): sap.m.semantic.DetailPage;
/**
* Destroys the mainAction in the aggregation {@link #getMainAction mainAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyMainAction(): sap.m.semantic.DetailPage;
/**
* Destroys the messagesIndicator in the aggregation {@link #getMessagesIndicator messagesIndicator}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyMessagesIndicator(): sap.m.semantic.DetailPage;
/**
* Destroys the negativeAction in the aggregation {@link #getNegativeAction negativeAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyNegativeAction(): sap.m.semantic.DetailPage;
/**
* Destroys the openInAction in the aggregation {@link #getOpenInAction openInAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyOpenInAction(): sap.m.semantic.DetailPage;
/**
* Destroys the pagingAction in the aggregation {@link #getPagingAction pagingAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyPagingAction(): sap.m.semantic.DetailPage;
/**
* Destroys the positiveAction in the aggregation {@link #getPositiveAction positiveAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyPositiveAction(): sap.m.semantic.DetailPage;
/**
* Destroys the printAction in the aggregation {@link #getPrintAction printAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyPrintAction(): sap.m.semantic.DetailPage;
/**
* Destroys the saveAction in the aggregation {@link #getSaveAction saveAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroySaveAction(): sap.m.semantic.DetailPage;
/**
* Destroys the saveAsTileAction in the aggregation {@link #getSaveAsTileAction saveAsTileAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroySaveAsTileAction(): sap.m.semantic.DetailPage;
/**
* Destroys the sendEmailAction in the aggregation {@link #getSendEmailAction sendEmailAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroySendEmailAction(): sap.m.semantic.DetailPage;
/**
* Destroys the sendMessageAction in the aggregation {@link #getSendMessageAction sendMessageAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroySendMessageAction(): sap.m.semantic.DetailPage;
/**
* Destroys the shareInJamAction in the aggregation {@link #getShareInJamAction shareInJamAction}.
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public destroyShareInJamAction(): sap.m.semantic.DetailPage;
/**
* Creates a new subclass of class sap.m.semantic.DetailPage with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.ShareMenuPage.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getAddAction addAction}.
*
* Add action
* @returns {sap.m.semantic.AddAction}
*/
public getAddAction(): sap.m.semantic.AddAction;
/**
* Gets content of aggregation {@link #getCancelAction cancelAction}.
*
* Cancel action
* @returns {sap.m.semantic.CancelAction}
*/
public getCancelAction(): sap.m.semantic.CancelAction;
/**
* Gets content of aggregation {@link #getDeleteAction deleteAction}.
*
* Delete action
* @returns {sap.m.semantic.DeleteAction}
*/
public getDeleteAction(): sap.m.semantic.DeleteAction;
/**
* Gets content of aggregation {@link #getDiscussInJamAction discussInJamAction}.
*
* DiscussInJam action
* @returns {sap.m.semantic.DiscussInJamAction}
*/
public getDiscussInJamAction(): sap.m.semantic.DiscussInJamAction;
/**
* Gets content of aggregation {@link #getDraftIndicator draftIndicator}.
*
* DraftIndicator
* @returns {sap.m.DraftIndicator}
*/
public getDraftIndicator(): sap.m.DraftIndicator;
/**
* Gets content of aggregation {@link #getEditAction editAction}.
*
* Edit action
* @returns {sap.m.semantic.EditAction}
*/
public getEditAction(): sap.m.semantic.EditAction;
/**
* Gets content of aggregation {@link #getFavoriteAction favoriteAction}.
*
* Favorite action
* @returns {sap.m.semantic.FavoriteAction}
*/
public getFavoriteAction(): sap.m.semantic.FavoriteAction;
/**
* Gets content of aggregation {@link #getFlagAction flagAction}.
*
* Flag action
* @returns {sap.m.semantic.FlagAction}
*/
public getFlagAction(): sap.m.semantic.FlagAction;
/**
* Gets content of aggregation {@link #getForwardAction forwardAction}.
*
* Negative action
* @returns {sap.m.semantic.ForwardAction}
*/
public getForwardAction(): sap.m.semantic.ForwardAction;
/**
* Gets content of aggregation {@link #getMainAction mainAction}.
*
* Main action
* @returns {sap.m.semantic.MainAction}
*/
public getMainAction(): sap.m.semantic.MainAction;
/**
* Gets content of aggregation {@link #getMessagesIndicator messagesIndicator}.
*
* MessagesIndicator
* @returns {sap.m.semantic.MessagesIndicator}
*/
public getMessagesIndicator(): sap.m.semantic.MessagesIndicator;
/**
* Returns a metadata object for class sap.m.semantic.DetailPage.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getNegativeAction negativeAction}.
*
* Negative action
* @returns {sap.m.semantic.NegativeAction}
*/
public getNegativeAction(): sap.m.semantic.NegativeAction;
/**
* Gets content of aggregation {@link #getOpenInAction openInAction}.
*
* OpenIn action
* @returns {sap.m.semantic.OpenInAction}
*/
public getOpenInAction(): sap.m.semantic.OpenInAction;
/**
* Gets content of aggregation {@link #getPagingAction pagingAction}.
*
* Paging action
* @returns {sap.m.PagingButton}
*/
public getPagingAction(): sap.m.PagingButton;
/**
* Gets content of aggregation {@link #getPositiveAction positiveAction}.
*
* Positive action
* @returns {sap.m.semantic.PositiveAction}
*/
public getPositiveAction(): sap.m.semantic.PositiveAction;
/**
* Gets content of aggregation {@link #getPrintAction printAction}.
*
* Print action
* @returns {sap.m.semantic.PrintAction}
*/
public getPrintAction(): sap.m.semantic.PrintAction;
/**
* Gets content of aggregation {@link #getSaveAction saveAction}.
*
* Save action
* @returns {sap.m.semantic.SaveAction}
*/
public getSaveAction(): sap.m.semantic.SaveAction;
/**
* Gets content of aggregation {@link #getSaveAsTileAction saveAsTileAction}.
*
* SaveAsTile button
* @returns {sap.m.Button}
*/
public getSaveAsTileAction(): sap.m.Button;
/**
* Gets content of aggregation {@link #getSendEmailAction sendEmailAction}.
*
* SendEmail action
* @returns {sap.m.semantic.SendEmailAction}
*/
public getSendEmailAction(): sap.m.semantic.SendEmailAction;
/**
* Gets content of aggregation {@link #getSendMessageAction sendMessageAction}.
*
* SendMessage action
* @returns {sap.m.semantic.SendMessageAction}
*/
public getSendMessageAction(): sap.m.semantic.SendMessageAction;
/**
* Gets content of aggregation {@link #getShareInJamAction shareInJamAction}.
*
* ShareInJam action
* @returns {sap.m.semantic.ShareInJamAction}
*/
public getShareInJamAction(): sap.m.semantic.ShareInJamAction;
/**
* Sets the aggregated {@link #getAddAction addAction}.
* @param {sap.m.semantic.AddAction} oAddAction - The addAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setAddAction(oAddAction: sap.m.semantic.AddAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getCancelAction cancelAction}.
* @param {sap.m.semantic.CancelAction} oCancelAction - The cancelAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setCancelAction(oCancelAction: sap.m.semantic.CancelAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getDeleteAction deleteAction}.
* @param {sap.m.semantic.DeleteAction} oDeleteAction - The deleteAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setDeleteAction(oDeleteAction: sap.m.semantic.DeleteAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getDiscussInJamAction discussInJamAction}.
* @param {sap.m.semantic.DiscussInJamAction} oDiscussInJamAction - The discussInJamAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setDiscussInJamAction(oDiscussInJamAction: sap.m.semantic.DiscussInJamAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getDraftIndicator draftIndicator}.
* @param {sap.m.DraftIndicator} oDraftIndicator - The draftIndicator to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setDraftIndicator(oDraftIndicator: sap.m.DraftIndicator): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getEditAction editAction}.
* @param {sap.m.semantic.EditAction} oEditAction - The editAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setEditAction(oEditAction: sap.m.semantic.EditAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getFavoriteAction favoriteAction}.
* @param {sap.m.semantic.FavoriteAction} oFavoriteAction - The favoriteAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setFavoriteAction(oFavoriteAction: sap.m.semantic.FavoriteAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getFlagAction flagAction}.
* @param {sap.m.semantic.FlagAction} oFlagAction - The flagAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setFlagAction(oFlagAction: sap.m.semantic.FlagAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getForwardAction forwardAction}.
* @param {sap.m.semantic.ForwardAction} oForwardAction - The forwardAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setForwardAction(oForwardAction: sap.m.semantic.ForwardAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getMainAction mainAction}.
* @param {sap.m.semantic.MainAction} oMainAction - The mainAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setMainAction(oMainAction: sap.m.semantic.MainAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getMessagesIndicator messagesIndicator}.
* @param {sap.m.semantic.MessagesIndicator} oMessagesIndicator - The messagesIndicator to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setMessagesIndicator(oMessagesIndicator: sap.m.semantic.MessagesIndicator): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getNegativeAction negativeAction}.
* @param {sap.m.semantic.NegativeAction} oNegativeAction - The negativeAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setNegativeAction(oNegativeAction: sap.m.semantic.NegativeAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getOpenInAction openInAction}.
* @param {sap.m.semantic.OpenInAction} oOpenInAction - The openInAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setOpenInAction(oOpenInAction: sap.m.semantic.OpenInAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getPagingAction pagingAction}.
* @param {sap.m.PagingButton} oPagingAction - The pagingAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setPagingAction(oPagingAction: sap.m.PagingButton): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getPositiveAction positiveAction}.
* @param {sap.m.semantic.PositiveAction} oPositiveAction - The positiveAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setPositiveAction(oPositiveAction: sap.m.semantic.PositiveAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getPrintAction printAction}.
* @param {sap.m.semantic.PrintAction} oPrintAction - The printAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setPrintAction(oPrintAction: sap.m.semantic.PrintAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getSaveAction saveAction}.
* @param {sap.m.semantic.SaveAction} oSaveAction - The saveAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setSaveAction(oSaveAction: sap.m.semantic.SaveAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getSaveAsTileAction saveAsTileAction}.
* @param {sap.m.Button} oSaveAsTileAction - The saveAsTileAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setSaveAsTileAction(oSaveAsTileAction: sap.m.Button): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getSendEmailAction sendEmailAction}.
* @param {sap.m.semantic.SendEmailAction} oSendEmailAction - The sendEmailAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setSendEmailAction(oSendEmailAction: sap.m.semantic.SendEmailAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getSendMessageAction sendMessageAction}.
* @param {sap.m.semantic.SendMessageAction} oSendMessageAction - The sendMessageAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setSendMessageAction(oSendMessageAction: sap.m.semantic.SendMessageAction): sap.m.semantic.DetailPage;
/**
* Sets the aggregated {@link #getShareInJamAction shareInJamAction}.
* @param {sap.m.semantic.ShareInJamAction} oShareInJamAction - The shareInJamAction to set
* @returns {sap.m.semantic.DetailPage} Reference to this
in order to allow method chaining
*/
public setShareInJamAction(oShareInJamAction: sap.m.semantic.ShareInJamAction): sap.m.semantic.DetailPage;
}
/**
* A DiscussInJamAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class DiscussInJamAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new DiscussInJamAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.DiscussInJamAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.DiscussInJamAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* An EditAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class EditAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new EditAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.EditAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.EditAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A FavoriteAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class FavoriteAction extends sap.m.semantic.SemanticToggleButton {
/**
* Constructor for a new FavoriteAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.FavoriteAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticToggleButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.FavoriteAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A FilterAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class FilterAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new FilterAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.FilterAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.FilterAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A FilterSelect button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class FilterSelect extends sap.m.semantic.SemanticSelect {
/**
* Constructor for a new FilterSelect.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.FilterSelect with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticSelect.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.FilterSelect.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A FlagAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class FlagAction extends sap.m.semantic.SemanticToggleButton {
/**
* Constructor for a new FlagAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.FlagAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticToggleButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.FlagAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A ForwardAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class ForwardAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new ForwardAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.ForwardAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.ForwardAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A FullscreenPage is a {@link sap.m.semantic.ShareMenuPage} that supports semantic content of the following types:
*
*
* - {@link sap.m.semantic.AddAction}
* - {@link sap.m.semantic.MainAction}
* - {@link sap.m.semantic.PositiveAction}
* - {@link sap.m.semantic.NegativeAction}
* - {@link sap.m.semantic.ForwardAction}
* - {@link sap.m.semantic.EditAction}
* - {@link sap.m.semantic.SaveAction}
* - {@link sap.m.semantic.DeleteAction}
* - {@link sap.m.semantic.CancelAction}
* - {@link sap.m.semantic.FlagAction}
* - {@link sap.m.semantic.FavoriteAction}
* - {@link sap.m.semantic.OpenInAction}
* - {@link sap.m.semantic.DiscussInJamAction}
* - {@link sap.m.semantic.ShareInJamAction}
* - {@link sap.m.semantic.SendEmailAction}
* - {@link sap.m.semantic.SendMessageAction}
* - {@link sap.m.semantic.PrintAction}
* - {@link sap.m.semantic.MessagesIndicator}
* - {@link sap.m.DraftIndicator}
*
*/
export class FullscreenPage extends sap.m.semantic.ShareMenuPage {
/**
* Constructor for a new FullscreenPage
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Destroys the addAction in the aggregation {@link #getAddAction addAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyAddAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the cancelAction in the aggregation {@link #getCancelAction cancelAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyCancelAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the deleteAction in the aggregation {@link #getDeleteAction deleteAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyDeleteAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the discussInJamAction in the aggregation {@link #getDiscussInJamAction discussInJamAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyDiscussInJamAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the draftIndicator in the aggregation {@link #getDraftIndicator draftIndicator}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyDraftIndicator(): sap.m.semantic.FullscreenPage;
/**
* Destroys the editAction in the aggregation {@link #getEditAction editAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyEditAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the favoriteAction in the aggregation {@link #getFavoriteAction favoriteAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyFavoriteAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the flagAction in the aggregation {@link #getFlagAction flagAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyFlagAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the forwardAction in the aggregation {@link #getForwardAction forwardAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyForwardAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the mainAction in the aggregation {@link #getMainAction mainAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyMainAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the messagesIndicator in the aggregation {@link #getMessagesIndicator messagesIndicator}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyMessagesIndicator(): sap.m.semantic.FullscreenPage;
/**
* Destroys the negativeAction in the aggregation {@link #getNegativeAction negativeAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyNegativeAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the openInAction in the aggregation {@link #getOpenInAction openInAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyOpenInAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the pagingAction in the aggregation {@link #getPagingAction pagingAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyPagingAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the positiveAction in the aggregation {@link #getPositiveAction positiveAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyPositiveAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the printAction in the aggregation {@link #getPrintAction printAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyPrintAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the saveAction in the aggregation {@link #getSaveAction saveAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroySaveAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the saveAsTileAction in the aggregation {@link #getSaveAsTileAction saveAsTileAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroySaveAsTileAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the sendEmailAction in the aggregation {@link #getSendEmailAction sendEmailAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroySendEmailAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the sendMessageAction in the aggregation {@link #getSendMessageAction sendMessageAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroySendMessageAction(): sap.m.semantic.FullscreenPage;
/**
* Destroys the shareInJamAction in the aggregation {@link #getShareInJamAction shareInJamAction}.
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public destroyShareInJamAction(): sap.m.semantic.FullscreenPage;
/**
* Creates a new subclass of class sap.m.semantic.FullscreenPage with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.ShareMenuPage.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getAddAction addAction}.
*
* Add action
* @returns {sap.m.semantic.AddAction}
*/
public getAddAction(): sap.m.semantic.AddAction;
/**
* Gets content of aggregation {@link #getCancelAction cancelAction}.
*
* Cancel action
* @returns {sap.m.semantic.CancelAction}
*/
public getCancelAction(): sap.m.semantic.CancelAction;
/**
* Gets content of aggregation {@link #getDeleteAction deleteAction}.
*
* Delete action
* @returns {sap.m.semantic.DeleteAction}
*/
public getDeleteAction(): sap.m.semantic.DeleteAction;
/**
* Gets content of aggregation {@link #getDiscussInJamAction discussInJamAction}.
*
* DiscussInJam action
* @returns {sap.m.semantic.DiscussInJamAction}
*/
public getDiscussInJamAction(): sap.m.semantic.DiscussInJamAction;
/**
* Gets content of aggregation {@link #getDraftIndicator draftIndicator}.
*
* DraftIndicator
* @returns {sap.m.DraftIndicator}
*/
public getDraftIndicator(): sap.m.DraftIndicator;
/**
* Gets content of aggregation {@link #getEditAction editAction}.
*
* Edit action
* @returns {sap.m.semantic.EditAction}
*/
public getEditAction(): sap.m.semantic.EditAction;
/**
* Gets content of aggregation {@link #getFavoriteAction favoriteAction}.
*
* Favorite action
* @returns {sap.m.semantic.FavoriteAction}
*/
public getFavoriteAction(): sap.m.semantic.FavoriteAction;
/**
* Gets content of aggregation {@link #getFlagAction flagAction}.
*
* Flag action
* @returns {sap.m.semantic.FlagAction}
*/
public getFlagAction(): sap.m.semantic.FlagAction;
/**
* Gets content of aggregation {@link #getForwardAction forwardAction}.
*
* Negative action
* @returns {sap.m.semantic.ForwardAction}
*/
public getForwardAction(): sap.m.semantic.ForwardAction;
/**
* Gets content of aggregation {@link #getMainAction mainAction}.
*
* Main action
* @returns {sap.m.semantic.MainAction}
*/
public getMainAction(): sap.m.semantic.MainAction;
/**
* Gets content of aggregation {@link #getMessagesIndicator messagesIndicator}.
*
* MessagesIndicator
* @returns {sap.m.semantic.MessagesIndicator}
*/
public getMessagesIndicator(): sap.m.semantic.MessagesIndicator;
/**
* Returns a metadata object for class sap.m.semantic.FullscreenPage.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getNegativeAction negativeAction}.
*
* Negative action
* @returns {sap.m.semantic.NegativeAction}
*/
public getNegativeAction(): sap.m.semantic.NegativeAction;
/**
* Gets content of aggregation {@link #getOpenInAction openInAction}.
*
* OpenIn action
* @returns {sap.m.semantic.OpenInAction}
*/
public getOpenInAction(): sap.m.semantic.OpenInAction;
/**
* Gets content of aggregation {@link #getPagingAction pagingAction}.
*
* Paging action
* @returns {sap.m.PagingButton}
*/
public getPagingAction(): sap.m.PagingButton;
/**
* Gets content of aggregation {@link #getPositiveAction positiveAction}.
*
* Positive action
* @returns {sap.m.semantic.PositiveAction}
*/
public getPositiveAction(): sap.m.semantic.PositiveAction;
/**
* Gets content of aggregation {@link #getPrintAction printAction}.
*
* Print action
* @returns {sap.m.semantic.PrintAction}
*/
public getPrintAction(): sap.m.semantic.PrintAction;
/**
* Gets content of aggregation {@link #getSaveAction saveAction}.
*
* Save action
* @returns {sap.m.semantic.SaveAction}
*/
public getSaveAction(): sap.m.semantic.SaveAction;
/**
* Gets content of aggregation {@link #getSaveAsTileAction saveAsTileAction}.
*
* SaveAsTile button
* @returns {sap.m.Button}
*/
public getSaveAsTileAction(): sap.m.Button;
/**
* Gets content of aggregation {@link #getSendEmailAction sendEmailAction}.
*
* SendEmail action
* @returns {sap.m.semantic.SendEmailAction}
*/
public getSendEmailAction(): sap.m.semantic.SendEmailAction;
/**
* Gets content of aggregation {@link #getSendMessageAction sendMessageAction}.
*
* SendMessage action
* @returns {sap.m.semantic.SendMessageAction}
*/
public getSendMessageAction(): sap.m.semantic.SendMessageAction;
/**
* Gets content of aggregation {@link #getShareInJamAction shareInJamAction}.
*
* ShareInJam action
* @returns {sap.m.semantic.ShareInJamAction}
*/
public getShareInJamAction(): sap.m.semantic.ShareInJamAction;
/**
* Sets the aggregated {@link #getAddAction addAction}.
* @param {sap.m.semantic.AddAction} oAddAction - The addAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setAddAction(oAddAction: sap.m.semantic.AddAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getCancelAction cancelAction}.
* @param {sap.m.semantic.CancelAction} oCancelAction - The cancelAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setCancelAction(oCancelAction: sap.m.semantic.CancelAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getDeleteAction deleteAction}.
* @param {sap.m.semantic.DeleteAction} oDeleteAction - The deleteAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setDeleteAction(oDeleteAction: sap.m.semantic.DeleteAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getDiscussInJamAction discussInJamAction}.
* @param {sap.m.semantic.DiscussInJamAction} oDiscussInJamAction - The discussInJamAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setDiscussInJamAction(oDiscussInJamAction: sap.m.semantic.DiscussInJamAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getDraftIndicator draftIndicator}.
* @param {sap.m.DraftIndicator} oDraftIndicator - The draftIndicator to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setDraftIndicator(oDraftIndicator: sap.m.DraftIndicator): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getEditAction editAction}.
* @param {sap.m.semantic.EditAction} oEditAction - The editAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setEditAction(oEditAction: sap.m.semantic.EditAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getFavoriteAction favoriteAction}.
* @param {sap.m.semantic.FavoriteAction} oFavoriteAction - The favoriteAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setFavoriteAction(oFavoriteAction: sap.m.semantic.FavoriteAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getFlagAction flagAction}.
* @param {sap.m.semantic.FlagAction} oFlagAction - The flagAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setFlagAction(oFlagAction: sap.m.semantic.FlagAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getForwardAction forwardAction}.
* @param {sap.m.semantic.ForwardAction} oForwardAction - The forwardAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setForwardAction(oForwardAction: sap.m.semantic.ForwardAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getMainAction mainAction}.
* @param {sap.m.semantic.MainAction} oMainAction - The mainAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setMainAction(oMainAction: sap.m.semantic.MainAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getMessagesIndicator messagesIndicator}.
* @param {sap.m.semantic.MessagesIndicator} oMessagesIndicator - The messagesIndicator to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setMessagesIndicator(oMessagesIndicator: sap.m.semantic.MessagesIndicator): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getNegativeAction negativeAction}.
* @param {sap.m.semantic.NegativeAction} oNegativeAction - The negativeAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setNegativeAction(oNegativeAction: sap.m.semantic.NegativeAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getOpenInAction openInAction}.
* @param {sap.m.semantic.OpenInAction} oOpenInAction - The openInAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setOpenInAction(oOpenInAction: sap.m.semantic.OpenInAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getPagingAction pagingAction}.
* @param {sap.m.PagingButton} oPagingAction - The pagingAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setPagingAction(oPagingAction: sap.m.PagingButton): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getPositiveAction positiveAction}.
* @param {sap.m.semantic.PositiveAction} oPositiveAction - The positiveAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setPositiveAction(oPositiveAction: sap.m.semantic.PositiveAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getPrintAction printAction}.
* @param {sap.m.semantic.PrintAction} oPrintAction - The printAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setPrintAction(oPrintAction: sap.m.semantic.PrintAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getSaveAction saveAction}.
* @param {sap.m.semantic.SaveAction} oSaveAction - The saveAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setSaveAction(oSaveAction: sap.m.semantic.SaveAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getSaveAsTileAction saveAsTileAction}.
* @param {sap.m.Button} oSaveAsTileAction - The saveAsTileAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setSaveAsTileAction(oSaveAsTileAction: sap.m.Button): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getSendEmailAction sendEmailAction}.
* @param {sap.m.semantic.SendEmailAction} oSendEmailAction - The sendEmailAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setSendEmailAction(oSendEmailAction: sap.m.semantic.SendEmailAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getSendMessageAction sendMessageAction}.
* @param {sap.m.semantic.SendMessageAction} oSendMessageAction - The sendMessageAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setSendMessageAction(oSendMessageAction: sap.m.semantic.SendMessageAction): sap.m.semantic.FullscreenPage;
/**
* Sets the aggregated {@link #getShareInJamAction shareInJamAction}.
* @param {sap.m.semantic.ShareInJamAction} oShareInJamAction - The shareInJamAction to set
* @returns {sap.m.semantic.FullscreenPage} Reference to this
in order to allow method chaining
*/
public setShareInJamAction(oShareInJamAction: sap.m.semantic.ShareInJamAction): sap.m.semantic.FullscreenPage;
}
/**
* A GroupAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class GroupAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new GroupAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.GroupAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.GroupAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A GroupSelect button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class GroupSelect extends sap.m.semantic.SemanticSelect {
/**
* Constructor for a new GroupSelect.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.GroupSelect with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticSelect.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.GroupSelect.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Marker interface for controls which are suitable as items of the filter aggregation of sap.m.Semantic.MasterPage.
*/
export interface IFilter {
}
/**
* Marker interface for controls which are suitable as items of the group aggregation of sap.m.Semantic.MasterPage.
*/
export interface IGroup {
}
/**
* Marker interface for controls which are suitable as items of the sort aggregation of sap.m.Semantic.MasterPage.
*/
export interface ISort {
}
/**
* A MainAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class MainAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new MainAction.
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.MainAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.MainAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* Button text
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Sets a new value for property {@link #getText text}.
*
* Button text
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.m.semantic.MainAction} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.semantic.MainAction;
}
/**
* A MasterPage is a {@link sap.m.semantic.SemanticPage} that supports semantic content of the following types:
*
*
* - {@link sap.m.semantic.AddAction}
* - {@link sap.m.semantic.MainAction}
* - {@link sap.m.semantic.PositiveAction}
* - {@link sap.m.semantic.NegativeAction}
* - {@link sap.m.semantic.ForwardAction}
* - {@link sap.m.semantic.EditAction}
* - {@link sap.m.semantic.SaveAction}
* - {@link sap.m.semantic.DeleteAction}
* - {@link sap.m.semantic.CancelAction}
* - {@link sap.m.semantic.MultiSelectAction}
* - {@link sap.m.semantic.FlagAction}
* - {@link sap.m.semantic.FavoriteAction}
* - {@link sap.m.semantic.SortAction}
* - {@link sap.m.semantic.SortSelect}
* - {@link sap.m.semantic.FilterAction}
* - {@link sap.m.semantic.FilterSelect}
* - {@link sap.m.semantic.GroupAction}
* - {@link sap.m.semantic.GroupSelect}
* - {@link sap.m.semantic.MessagesIndicator}
*
*/
export class MasterPage extends sap.m.semantic.SemanticPage {
/**
* Constructor for a new MasterPage
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Destroys the addAction in the aggregation {@link #getAddAction addAction}.
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public destroyAddAction(): sap.m.semantic.MasterPage;
/**
* Destroys the cancelAction in the aggregation {@link #getCancelAction cancelAction}.
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public destroyCancelAction(): sap.m.semantic.MasterPage;
/**
* Destroys the deleteAction in the aggregation {@link #getDeleteAction deleteAction}.
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public destroyDeleteAction(): sap.m.semantic.MasterPage;
/**
* Destroys the editAction in the aggregation {@link #getEditAction editAction}.
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public destroyEditAction(): sap.m.semantic.MasterPage;
/**
* Destroys the filter in the aggregation {@link #getFilter filter}.
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public destroyFilter(): sap.m.semantic.MasterPage;
/**
* Destroys the forwardAction in the aggregation {@link #getForwardAction forwardAction}.
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public destroyForwardAction(): sap.m.semantic.MasterPage;
/**
* Destroys the group in the aggregation {@link #getGroup group}.
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public destroyGroup(): sap.m.semantic.MasterPage;
/**
* Destroys the mainAction in the aggregation {@link #getMainAction mainAction}.
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public destroyMainAction(): sap.m.semantic.MasterPage;
/**
* Destroys the messagesIndicator in the aggregation {@link #getMessagesIndicator messagesIndicator}.
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public destroyMessagesIndicator(): sap.m.semantic.MasterPage;
/**
* Destroys the multiSelectAction in the aggregation {@link #getMultiSelectAction multiSelectAction}.
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public destroyMultiSelectAction(): sap.m.semantic.MasterPage;
/**
* Destroys the negativeAction in the aggregation {@link #getNegativeAction negativeAction}.
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public destroyNegativeAction(): sap.m.semantic.MasterPage;
/**
* Destroys the positiveAction in the aggregation {@link #getPositiveAction positiveAction}.
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public destroyPositiveAction(): sap.m.semantic.MasterPage;
/**
* Destroys the saveAction in the aggregation {@link #getSaveAction saveAction}.
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public destroySaveAction(): sap.m.semantic.MasterPage;
/**
* Destroys the sort in the aggregation {@link #getSort sort}.
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public destroySort(): sap.m.semantic.MasterPage;
/**
* Creates a new subclass of class sap.m.semantic.MasterPage with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticPage.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getAddAction addAction}.
*
* Add action
* @returns {sap.m.semantic.AddAction}
*/
public getAddAction(): sap.m.semantic.AddAction;
/**
* Gets content of aggregation {@link #getCancelAction cancelAction}.
*
* Cancel action
* @returns {sap.m.semantic.CancelAction}
*/
public getCancelAction(): sap.m.semantic.CancelAction;
/**
* Gets content of aggregation {@link #getDeleteAction deleteAction}.
*
* Delete action
* @returns {sap.m.semantic.DeleteAction}
*/
public getDeleteAction(): sap.m.semantic.DeleteAction;
/**
* Gets content of aggregation {@link #getEditAction editAction}.
*
* Edit action
* @returns {sap.m.semantic.EditAction}
*/
public getEditAction(): sap.m.semantic.EditAction;
/**
* Gets content of aggregation {@link #getFilter filter}.
*
* Filter action
* @returns {sap.m.semantic.IFilter}
*/
public getFilter(): sap.m.semantic.IFilter;
/**
* Gets content of aggregation {@link #getForwardAction forwardAction}.
*
* Forward action
* @returns {sap.m.semantic.ForwardAction}
*/
public getForwardAction(): sap.m.semantic.ForwardAction;
/**
* Gets content of aggregation {@link #getGroup group}.
*
* Group action
* @returns {sap.m.semantic.IGroup}
*/
public getGroup(): sap.m.semantic.IGroup;
/**
* Gets content of aggregation {@link #getMainAction mainAction}.
*
* Main action
* @returns {sap.m.semantic.MainAction}
*/
public getMainAction(): sap.m.semantic.MainAction;
/**
* Gets content of aggregation {@link #getMessagesIndicator messagesIndicator}.
*
* MessagesIndicator
* @returns {sap.m.semantic.MessagesIndicator}
*/
public getMessagesIndicator(): sap.m.semantic.MessagesIndicator;
/**
* Returns a metadata object for class sap.m.semantic.MasterPage.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getMultiSelectAction multiSelectAction}.
*
* MultiSelect action
* @returns {sap.m.semantic.MultiSelectAction}
*/
public getMultiSelectAction(): sap.m.semantic.MultiSelectAction;
/**
* Gets content of aggregation {@link #getNegativeAction negativeAction}.
*
* Negative action
* @returns {sap.m.semantic.NegativeAction}
*/
public getNegativeAction(): sap.m.semantic.NegativeAction;
/**
* Gets content of aggregation {@link #getPositiveAction positiveAction}.
*
* Positive action
* @returns {sap.m.semantic.PositiveAction}
*/
public getPositiveAction(): sap.m.semantic.PositiveAction;
/**
* Gets content of aggregation {@link #getSaveAction saveAction}.
*
* Save action
* @returns {sap.m.semantic.SaveAction}
*/
public getSaveAction(): sap.m.semantic.SaveAction;
/**
* Gets content of aggregation {@link #getSort sort}.
*
* Sort action
* @returns {sap.m.semantic.ISort}
*/
public getSort(): sap.m.semantic.ISort;
/**
* Sets the aggregated {@link #getAddAction addAction}.
* @param {sap.m.semantic.AddAction} oAddAction - The addAction to set
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public setAddAction(oAddAction: sap.m.semantic.AddAction): sap.m.semantic.MasterPage;
/**
* Sets the aggregated {@link #getCancelAction cancelAction}.
* @param {sap.m.semantic.CancelAction} oCancelAction - The cancelAction to set
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public setCancelAction(oCancelAction: sap.m.semantic.CancelAction): sap.m.semantic.MasterPage;
/**
* Sets the aggregated {@link #getDeleteAction deleteAction}.
* @param {sap.m.semantic.DeleteAction} oDeleteAction - The deleteAction to set
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public setDeleteAction(oDeleteAction: sap.m.semantic.DeleteAction): sap.m.semantic.MasterPage;
/**
* Sets the aggregated {@link #getEditAction editAction}.
* @param {sap.m.semantic.EditAction} oEditAction - The editAction to set
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public setEditAction(oEditAction: sap.m.semantic.EditAction): sap.m.semantic.MasterPage;
/**
* Sets the aggregated {@link #getFilter filter}.
* @param {sap.m.semantic.IFilter} oFilter - The filter to set
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public setFilter(oFilter: sap.m.semantic.IFilter): sap.m.semantic.MasterPage;
/**
* Sets the aggregated {@link #getForwardAction forwardAction}.
* @param {sap.m.semantic.ForwardAction} oForwardAction - The forwardAction to set
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public setForwardAction(oForwardAction: sap.m.semantic.ForwardAction): sap.m.semantic.MasterPage;
/**
* Sets the aggregated {@link #getGroup group}.
* @param {sap.m.semantic.IGroup} oGroup - The group to set
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public setGroup(oGroup: sap.m.semantic.IGroup): sap.m.semantic.MasterPage;
/**
* Sets the aggregated {@link #getMainAction mainAction}.
* @param {sap.m.semantic.MainAction} oMainAction - The mainAction to set
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public setMainAction(oMainAction: sap.m.semantic.MainAction): sap.m.semantic.MasterPage;
/**
* Sets the aggregated {@link #getMessagesIndicator messagesIndicator}.
* @param {sap.m.semantic.MessagesIndicator} oMessagesIndicator - The messagesIndicator to set
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public setMessagesIndicator(oMessagesIndicator: sap.m.semantic.MessagesIndicator): sap.m.semantic.MasterPage;
/**
* Sets the aggregated {@link #getMultiSelectAction multiSelectAction}.
* @param {sap.m.semantic.MultiSelectAction} oMultiSelectAction - The multiSelectAction to set
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public setMultiSelectAction(oMultiSelectAction: sap.m.semantic.MultiSelectAction): sap.m.semantic.MasterPage;
/**
* Sets the aggregated {@link #getNegativeAction negativeAction}.
* @param {sap.m.semantic.NegativeAction} oNegativeAction - The negativeAction to set
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public setNegativeAction(oNegativeAction: sap.m.semantic.NegativeAction): sap.m.semantic.MasterPage;
/**
* Sets the aggregated {@link #getPositiveAction positiveAction}.
* @param {sap.m.semantic.PositiveAction} oPositiveAction - The positiveAction to set
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public setPositiveAction(oPositiveAction: sap.m.semantic.PositiveAction): sap.m.semantic.MasterPage;
/**
* Sets the aggregated {@link #getSaveAction saveAction}.
* @param {sap.m.semantic.SaveAction} oSaveAction - The saveAction to set
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public setSaveAction(oSaveAction: sap.m.semantic.SaveAction): sap.m.semantic.MasterPage;
/**
* Sets the aggregated {@link #getSort sort}.
* @param {sap.m.semantic.ISort} oSort - The sort to set
* @returns {sap.m.semantic.MasterPage} Reference to this
in order to allow method chaining
*/
public setSort(oSort: sap.m.semantic.ISort): sap.m.semantic.MasterPage;
}
/**
* A MessagesIndicator button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class MessagesIndicator extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new MessagesIndicator.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.MessagesIndicator with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.MessagesIndicator.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A MultiSelectAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class MultiSelectAction extends sap.m.semantic.SemanticToggleButton {
/**
* Constructor for a new MultiSelectAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.MultiSelectAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticToggleButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.MultiSelectAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A NegativeAction button has default semantic-specific properties and
* is eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class NegativeAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new NegativeAction.
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.NegativeAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.NegativeAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* Button text
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Sets a new value for property {@link #getText text}.
*
* Button text
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.m.semantic.NegativeAction} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.semantic.NegativeAction;
}
/**
* An OpenInAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class OpenInAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new OpenInAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.OpenInAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.OpenInAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A PositiveAction button has default semantic-specific properties and
* is eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class PositiveAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new PositiveAction.
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.PositiveAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.PositiveAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* Button text
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Sets a new value for property {@link #getText text}.
*
* Button text
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.m.semantic.PositiveAction} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.semantic.PositiveAction;
}
/**
* A PrintAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class PrintAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new PrintAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.PrintAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.PrintAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A SaveAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class SaveAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new SaveAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.SaveAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.SaveAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A semantic button is either a {@link sap.m.Button} or {@link sap.m.semantic.SemanticOverflowToolbarButton} ,
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class SemanticButton extends sap.m.semantic.SemanticControl {
/**
* Constructor for a new SemanticButton.
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.semantic.SemanticButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.semantic.SemanticButton
itself.
*
* See {@link sap.m.Button#press}
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.semantic.SemanticButton
itself
* @returns {sap.m.semantic.SemanticButton} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.semantic.SemanticButton;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.semantic.SemanticButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.semantic.SemanticButton
itself.
*
* See {@link sap.m.Button#press}
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.semantic.SemanticButton
itself
* @returns {sap.m.semantic.SemanticButton} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.semantic.SemanticButton;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.semantic.SemanticButton
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.semantic.SemanticButton} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.semantic.SemanticButton;
/**
* Creates a new subclass of class sap.m.semantic.SemanticButton with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticControl.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.semantic.SemanticButton} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.semantic.SemanticButton;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* See {@link sap.m.Button#enabled}
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Returns a metadata object for class sap.m.semantic.SemanticButton.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* See {@link sap.m.Button#enabled}
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.semantic.SemanticButton} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.semantic.SemanticButton;
}
/**
* A semantic control is an abstraction for either a {@link sap.m.semantic.SemanticButton} or {@link sap.m.semantic.SemanticSelect} ,
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class SemanticControl extends sap.ui.core.Element {
/**
* Constructor for a new SemanticControl.
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.SemanticControl with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.SemanticControl.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getVisible visible}.
*
* See {@link sap.ui.core.Control#visible}
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* See {@link sap.ui.core.Control#visible}
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.m.semantic.SemanticControl} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.m.semantic.SemanticControl;
}
/**
* A semantic page is an enhanced {@link sap.m.Page}, that can contain controls with semantic meaning, see {@link sap.m.semantic.SemanticControl}.
*
* Note: This control implements the SAP Fiori 1.0 design guidelines. For SAP Fiori 2.0, see the {@link sap.f.semantic.SemanticPage}.
*
* Content specified in the {@link sap.m.semantic.SemanticPage#semanticControls} aggregations will be automatically positioned in dedicated sections of the footer or the header of the page, depending on the control's semantics.
* For example, a semantic button of type {@link sap.m.semantic.PositiveAction} will be positioned in the right side of the footer, and in logically correct sequence order with respect to any other included semantic controls.
*
* The full list of what we internally define for semantic content is:
*
* - Visual properties (e.g. AddAction will be styled as an icon button)
* - Position in the page (UX guidelines specify that some buttons should be in the header only, while others are in the footer or the "share" menu, so we do the correct positioning)
* - Sequence order (UX guidelines define a specific sequence order of semantic controls with respect to each other)
* - Default localized tooltip for icon-only buttons
* - Overflow behavior (UX quidelines define which buttons are allowed to go to the overflow of the toolbar when the screen gets narrower). For icon buttons, we ensure that the text label of the button appears when the button is in overflow, as specified by UX.
* - Screen reader support (invisible text for reading the semantic type)
*
*
* In addition to the predefined semantic controls, the SemanticPage can host also custom application-provided controls. It preserves most of the API of {@link sap.m.Page} for specifying page content.
*/
export class SemanticPage extends sap.ui.core.Control {
/**
* Constructor for a new SemanticPage
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.semantic.SemanticPage;
/**
* Adds some customFooterContent to the aggregation {@link #getCustomFooterContent customFooterContent}.
* @param {sap.m.Button} oCustomFooterContent - the customFooterContent to add; if empty, nothing is inserted
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public addCustomFooterContent(oCustomFooterContent: sap.m.Button): sap.m.semantic.SemanticPage;
/**
* Adds some customHeaderContent to the aggregation {@link #getCustomHeaderContent customHeaderContent}.
* @param {sap.m.Button} oCustomHeaderContent - the customHeaderContent to add; if empty, nothing is inserted
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public addCustomHeaderContent(oCustomHeaderContent: sap.m.Button): sap.m.semantic.SemanticPage;
/**
* Attaches event handler fnFunction
to the {@link #event:navButtonPress navButtonPress} event of this sap.m.semantic.SemanticPage
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.semantic.SemanticPage
itself.
*
* See {@link sap.m.Page#navButtonPress}
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.semantic.SemanticPage
itself
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public attachNavButtonPress(fnFunction: Function, oListener?: any): sap.m.semantic.SemanticPage;
/**
* Attaches event handler fnFunction
to the {@link #event:navButtonPress navButtonPress} event of this sap.m.semantic.SemanticPage
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.semantic.SemanticPage
itself.
*
* See {@link sap.m.Page#navButtonPress}
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.semantic.SemanticPage
itself
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public attachNavButtonPress(oData: any, fnFunction: Function, oListener?: any): sap.m.semantic.SemanticPage;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.semantic.SemanticPage;
/**
* Destroys all the customFooterContent in the aggregation {@link #getCustomFooterContent customFooterContent}.
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public destroyCustomFooterContent(): sap.m.semantic.SemanticPage;
/**
* Destroys all the customHeaderContent in the aggregation {@link #getCustomHeaderContent customHeaderContent}.
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public destroyCustomHeaderContent(): sap.m.semantic.SemanticPage;
/**
* Destroys the landmarkInfo in the aggregation {@link #getLandmarkInfo landmarkInfo}.
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public destroyLandmarkInfo(): sap.m.semantic.SemanticPage;
/**
* Destroys the subHeader in the aggregation {@link #getSubHeader subHeader}.
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public destroySubHeader(): sap.m.semantic.SemanticPage;
/**
* Detaches event handler fnFunction
from the {@link #event:navButtonPress navButtonPress} event of this sap.m.semantic.SemanticPage
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public detachNavButtonPress(fnFunction: Function, oListener: any): sap.m.semantic.SemanticPage;
/**
* Creates a new subclass of class sap.m.semantic.SemanticPage with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:navButtonPress navButtonPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
protected fireNavButtonPress(mParameters?: any): sap.m.semantic.SemanticPage;
/**
* Gets content of aggregation {@link #getContent content}.
*
* See {@link sap.m.Page#content}
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets content of aggregation {@link #getCustomFooterContent customFooterContent}.
*
* Custom footer buttons
* @returns {sap.m.Button[]}
*/
public getCustomFooterContent(): sap.m.Button[];
/**
* Gets content of aggregation {@link #getCustomHeaderContent customHeaderContent}.
*
* Custom header buttons
* @returns {sap.m.Button[]}
*/
public getCustomHeaderContent(): sap.m.Button[];
/**
* Gets current value of property {@link #getEnableScrolling enableScrolling}.
*
* See {@link sap.m.Page#enableScrolling}
*
* Default value is true
.
* @returns {boolean} Value of property enableScrolling
*/
public getEnableScrolling(): boolean;
/**
* Gets current value of property {@link #getFloatingFooter floatingFooter}.
*
* Determines whether the floating footer behavior is enabled.
* If set to true
, the content is visible when it's underneath the footer.
*
* Default value is false
.
* @returns {boolean} Value of property floatingFooter
*/
public getFloatingFooter(): boolean;
/**
* Gets content of aggregation {@link #getLandmarkInfo landmarkInfo}.
*
* Accessible landmark settings to be applied to the containers of the sap.m.Page
control.
*
* If not set, no landmarks will be written.
* @returns {sap.m.PageAccessibleLandmarkInfo}
*/
public getLandmarkInfo(): sap.m.PageAccessibleLandmarkInfo;
/**
* Returns a metadata object for class sap.m.semantic.SemanticPage.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSemanticRuleSet semanticRuleSet}.
*
* Declares the type of semantic ruleset that will govern the styling and positioning of semantic content.
*
* Default value is Classic
.
* @returns {sap.m.semantic.SemanticRuleSetType} Value of property semanticRuleSet
*/
public getSemanticRuleSet(): sap.m.semantic.SemanticRuleSetType;
/**
* Gets current value of property {@link #getShowFooter showFooter}.
*
* Hides or shows the page footer
*
* Default value is true
.
* @returns {boolean} Value of property showFooter
*/
public getShowFooter(): boolean;
/**
* Gets current value of property {@link #getShowNavButton showNavButton}.
*
* See {@link sap.m.Page#showNavButton}
*
* Default value is false
.
* @returns {boolean} Value of property showNavButton
*/
public getShowNavButton(): boolean;
/**
* Gets current value of property {@link #getShowSubHeader showSubHeader}.
*
* See {@link sap.m.Page#showSubHeader}
*
* Default value is true
.
* @returns {boolean} Value of property showSubHeader
*/
public getShowSubHeader(): boolean;
/**
* Gets content of aggregation {@link #getSubHeader subHeader}.
*
* See {@link sap.m.Page#subHeader}
* @returns {sap.m.IBar}
*/
public getSubHeader(): sap.m.IBar;
/**
* Gets current value of property {@link #getTitle title}.
*
* See {@link sap.m.Page#title}
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getTitleLevel titleLevel}.
*
* See {@link sap.m.Page#titleLevel}
*
* Default value is Auto
.
* @returns {sap.ui.core.TitleLevel} Value of property titleLevel
*/
public getTitleLevel(): sap.ui.core.TitleLevel;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.m.Button
in the aggregation {@link #getCustomFooterContent customFooterContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Button} oCustomFooterContent - The customFooterContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfCustomFooterContent(oCustomFooterContent: sap.m.Button): number;
/**
* Checks for the provided sap.m.Button
in the aggregation {@link #getCustomHeaderContent customHeaderContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Button} oCustomHeaderContent - The customHeaderContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfCustomHeaderContent(oCustomHeaderContent: sap.m.Button): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.semantic.SemanticPage;
/**
* Inserts a customFooterContent into the aggregation {@link #getCustomFooterContent customFooterContent}.
* @param {sap.m.Button} oCustomFooterContent - the customFooterContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the customFooterContent should be inserted at; for a negative value of iIndex
, the customFooterContent is inserted at position 0; for a value greater than the current size of the aggregation, the customFooterContent is inserted at the last position
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public insertCustomFooterContent(oCustomFooterContent: sap.m.Button, iIndex: number): sap.m.semantic.SemanticPage;
/**
* Inserts a customHeaderContent into the aggregation {@link #getCustomHeaderContent customHeaderContent}.
* @param {sap.m.Button} oCustomHeaderContent - the customHeaderContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the customHeaderContent should be inserted at; for a negative value of iIndex
, the customHeaderContent is inserted at position 0; for a value greater than the current size of the aggregation, the customHeaderContent is inserted at the last position
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public insertCustomHeaderContent(oCustomHeaderContent: sap.m.Button, iIndex: number): sap.m.semantic.SemanticPage;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getCustomFooterContent customFooterContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Button[]} An array of the removed elements (might be empty)
*/
public removeAllCustomFooterContent(): sap.m.Button[];
/**
* Removes all the controls from the aggregation {@link #getCustomHeaderContent customHeaderContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Button[]} An array of the removed elements (might be empty)
*/
public removeAllCustomHeaderContent(): sap.m.Button[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a customFooterContent from the aggregation {@link #getCustomFooterContent customFooterContent}.
* @param {number|string|sap.m.Button} vCustomFooterContent - The customFooterContent to remove or its index or id
* @returns {sap.m.Button} The removed customFooterContent or null
*/
public removeCustomFooterContent(vCustomFooterContent: number|string|sap.m.Button): sap.m.Button;
/**
* Removes a customHeaderContent from the aggregation {@link #getCustomHeaderContent customHeaderContent}.
* @param {number|string|sap.m.Button} vCustomHeaderContent - The customHeaderContent to remove or its index or id
* @returns {sap.m.Button} The removed customHeaderContent or null
*/
public removeCustomHeaderContent(vCustomHeaderContent: number|string|sap.m.Button): sap.m.Button;
/**
* Sets a new value for property {@link #getEnableScrolling enableScrolling}.
*
* See {@link sap.m.Page#enableScrolling}
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableScrolling - New value for property enableScrolling
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public setEnableScrolling(bEnableScrolling: boolean): sap.m.semantic.SemanticPage;
/**
* Sets a new value for property {@link #getFloatingFooter floatingFooter}.
*
* Determines whether the floating footer behavior is enabled.
* If set to true
, the content is visible when it's underneath the footer.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bFloatingFooter - New value for property floatingFooter
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public setFloatingFooter(bFloatingFooter: boolean): sap.m.semantic.SemanticPage;
/**
* Sets the aggregated {@link #getLandmarkInfo landmarkInfo}.
* @param {sap.m.PageAccessibleLandmarkInfo} oLandmarkInfo - The landmarkInfo to set
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public setLandmarkInfo(oLandmarkInfo: sap.m.PageAccessibleLandmarkInfo): sap.m.semantic.SemanticPage;
/**
* Sets a new value for property {@link #getSemanticRuleSet semanticRuleSet}.
*
* Declares the type of semantic ruleset that will govern the styling and positioning of semantic content.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Classic
.
* @param {sap.m.semantic.SemanticRuleSetType} sSemanticRuleSet - New value for property semanticRuleSet
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public setSemanticRuleSet(sSemanticRuleSet: sap.m.semantic.SemanticRuleSetType): sap.m.semantic.SemanticPage;
/**
* Sets a new value for property {@link #getShowFooter showFooter}.
*
* Hides or shows the page footer
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowFooter - New value for property showFooter
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public setShowFooter(bShowFooter: boolean): sap.m.semantic.SemanticPage;
/**
* Sets a new value for property {@link #getShowNavButton showNavButton}.
*
* See {@link sap.m.Page#showNavButton}
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowNavButton - New value for property showNavButton
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public setShowNavButton(bShowNavButton: boolean): sap.m.semantic.SemanticPage;
/**
* Sets a new value for property {@link #getShowSubHeader showSubHeader}.
*
* See {@link sap.m.Page#showSubHeader}
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowSubHeader - New value for property showSubHeader
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public setShowSubHeader(bShowSubHeader: boolean): sap.m.semantic.SemanticPage;
/**
* Sets the aggregated {@link #getSubHeader subHeader}.
* @param {sap.m.IBar} oSubHeader - The subHeader to set
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public setSubHeader(oSubHeader: sap.m.IBar): sap.m.semantic.SemanticPage;
/**
* Sets a new value for property {@link #getTitle title}.
*
* See {@link sap.m.Page#title}
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.semantic.SemanticPage;
/**
* Sets a new value for property {@link #getTitleLevel titleLevel}.
*
* See {@link sap.m.Page#titleLevel}
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.ui.core.TitleLevel} sTitleLevel - New value for property titleLevel
* @returns {sap.m.semantic.SemanticPage} Reference to this
in order to allow method chaining
*/
public setTitleLevel(sTitleLevel: sap.ui.core.TitleLevel): sap.m.semantic.SemanticPage;
}
/**
* Declares the type of semantic ruleset that will govern the styling and positioning of semantic content.
*/
export enum SemanticRuleSetType {
/**
* The default ruleset type, for which the Share Menu is always in the footer of the page.
*/
Classic = "Classic",
/**
* Offers an optimized user experience, with displaying the Share Menu in the header, rather than the footer, for Fullscreen mode.
*/
Optimized = "Optimized",
}
/**
* A semantic select is a {@link sap.m.Select} eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class SemanticSelect extends sap.m.semantic.SemanticControl {
/**
* Constructor for a new SemanticSelect.
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.ui.core.Item} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.semantic.SemanticSelect} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.ui.core.Item): sap.m.semantic.SemanticSelect;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.semantic.SemanticSelect
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.semantic.SemanticSelect
itself.
*
* See {@link sap.m.Select#event:change}
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.semantic.SemanticSelect
itself
* @returns {sap.m.semantic.SemanticSelect} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.m.semantic.SemanticSelect;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.semantic.SemanticSelect
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.semantic.SemanticSelect
itself.
*
* See {@link sap.m.Select#event:change}
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.semantic.SemanticSelect
itself
* @returns {sap.m.semantic.SemanticSelect} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.m.semantic.SemanticSelect;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.semantic.SemanticSelect} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.m.semantic.SemanticSelect;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.semantic.SemanticSelect} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.semantic.SemanticSelect;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.m.semantic.SemanticSelect
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.semantic.SemanticSelect} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.m.semantic.SemanticSelect;
/**
* Creates a new subclass of class sap.m.semantic.SemanticSelect with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticControl.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.semantic.SemanticSelect} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.m.semantic.SemanticSelect;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* See {@link sap.m.Select#getEnabled}
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets content of aggregation {@link #getItems items}.
*
* See {@link sap.m.Select#getItems}
* @returns {sap.ui.core.Item[]}
*/
public getItems(): sap.ui.core.Item[];
/**
* Returns a metadata object for class sap.m.semantic.SemanticSelect.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* ID of the element which is the current target of the association {@link #getSelectedItem selectedItem}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedItem(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getSelectedKey selectedKey}.
*
* See {@link sap.m.Select#getSelectedKey}
*
* Default value is
.
* @returns {string} Value of property selectedKey
*/
public getSelectedKey(): string;
/**
* Checks for the provided sap.ui.core.Item
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Item} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.core.Item): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.ui.core.Item} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.semantic.SemanticSelect} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.ui.core.Item, iIndex: number): sap.m.semantic.SemanticSelect;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Item[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.ui.core.Item[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.ui.core.Item} vItem - The item to remove or its index or id
* @returns {sap.ui.core.Item} The removed item or null
*/
public removeItem(vItem: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* See {@link sap.m.Select#getEnabled}
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.semantic.SemanticSelect} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.semantic.SemanticSelect;
/**
* Sets the associated {@link #getSelectedItem selectedItem}.
* @param {sap.ui.core.ID|sap.ui.core.Item} oSelectedItem - ID of an element which becomes the new target of this selectedItem association; alternatively, an element instance may be given
* @returns {sap.m.semantic.SemanticSelect} Reference to this
in order to allow method chaining
*/
public setSelectedItem(oSelectedItem: sap.ui.core.ID|sap.ui.core.Item): sap.m.semantic.SemanticSelect;
/**
* Sets a new value for property {@link #getSelectedKey selectedKey}.
*
* See {@link sap.m.Select#getSelectedKey}
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sSelectedKey - New value for property selectedKey
* @returns {sap.m.semantic.SemanticSelect} Reference to this
in order to allow method chaining
*/
public setSelectedKey(sSelectedKey: string): sap.m.semantic.SemanticSelect;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.m.semantic.SemanticSelect} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.m.semantic.SemanticSelect;
}
/**
* A SemanticToggleButton is eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class SemanticToggleButton extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new SemanticToggleButton.
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.SemanticToggleButton with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.SemanticToggleButton.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPressed pressed}.
*
* The property is “true” when the control is toggled. The default state of this property is "false".
*
* Default value is false
.
* @returns {boolean} Value of property pressed
*/
public getPressed(): boolean;
/**
* Sets a new value for property {@link #getPressed pressed}.
*
* The property is “true” when the control is toggled. The default state of this property is "false".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bPressed - New value for property pressed
* @returns {sap.m.semantic.SemanticToggleButton} Reference to this
in order to allow method chaining
*/
public setPressed(bPressed: boolean): sap.m.semantic.SemanticToggleButton;
}
/**
* A SendEmailAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class SendEmailAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new SendEmailAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.SendEmailAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.SendEmailAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A SendMessageAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class SendMessageAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new SendMessageAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.SendMessageAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.SendMessageAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A ShareInJamAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class ShareInJamAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new ShareInJamAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.ShareInJamAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.ShareInJamAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A ShareMenuPage is a {@link sap.m.semantic.SemanticPage} with support for "share" menu in the footer.
*/
export class ShareMenuPage extends sap.m.semantic.SemanticPage {
/**
* Constructor for a new ShareMenuPage
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some customShareMenuContent to the aggregation {@link #getCustomShareMenuContent customShareMenuContent}.
* @param {sap.m.Button} oCustomShareMenuContent - the customShareMenuContent to add; if empty, nothing is inserted
* @returns {sap.m.semantic.ShareMenuPage} Reference to this
in order to allow method chaining
*/
public addCustomShareMenuContent(oCustomShareMenuContent: sap.m.Button): sap.m.semantic.ShareMenuPage;
/**
* Destroys all the customShareMenuContent in the aggregation {@link #getCustomShareMenuContent customShareMenuContent}.
* @returns {sap.m.semantic.ShareMenuPage} Reference to this
in order to allow method chaining
*/
public destroyCustomShareMenuContent(): sap.m.semantic.ShareMenuPage;
/**
* Creates a new subclass of class sap.m.semantic.ShareMenuPage with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticPage.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getCustomShareMenuContent customShareMenuContent}.
*
* Custom share menu buttons
* @returns {sap.m.Button[]}
*/
public getCustomShareMenuContent(): sap.m.Button[];
/**
* Returns a metadata object for class sap.m.semantic.ShareMenuPage.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.m.Button
in the aggregation {@link #getCustomShareMenuContent customShareMenuContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Button} oCustomShareMenuContent - The customShareMenuContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfCustomShareMenuContent(oCustomShareMenuContent: sap.m.Button): number;
/**
* Inserts a customShareMenuContent into the aggregation {@link #getCustomShareMenuContent customShareMenuContent}.
* @param {sap.m.Button} oCustomShareMenuContent - the customShareMenuContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the customShareMenuContent should be inserted at; for a negative value of iIndex
, the customShareMenuContent is inserted at position 0; for a value greater than the current size of the aggregation, the customShareMenuContent is inserted at the last position
* @returns {sap.m.semantic.ShareMenuPage} Reference to this
in order to allow method chaining
*/
public insertCustomShareMenuContent(oCustomShareMenuContent: sap.m.Button, iIndex: number): sap.m.semantic.ShareMenuPage;
/**
* Removes all the controls from the aggregation {@link #getCustomShareMenuContent customShareMenuContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Button[]} An array of the removed elements (might be empty)
*/
public removeAllCustomShareMenuContent(): sap.m.Button[];
/**
* Removes a customShareMenuContent from the aggregation {@link #getCustomShareMenuContent customShareMenuContent}.
* @param {number|string|sap.m.Button} vCustomShareMenuContent - The customShareMenuContent to remove or its index or id
* @returns {sap.m.Button} The removed customShareMenuContent or null
*/
public removeCustomShareMenuContent(vCustomShareMenuContent: number|string|sap.m.Button): sap.m.Button;
}
/**
* A SortAction button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class SortAction extends sap.m.semantic.SemanticButton {
/**
* Constructor for a new SortAction.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.SortAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticButton.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.SortAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A SortSelect button has default semantic-specific properties and is
* eligible for aggregation content of a {@link sap.m.semantic.SemanticPage}.
*/
export class SortSelect extends sap.m.semantic.SemanticSelect {
/**
* Constructor for a new SortSelect.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Custom initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.semantic.SortSelect with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.semantic.SemanticSelect.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.semantic.SortSelect.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
}
/**
* The Shell control can be used as root element of applications. It can contain an App or a SplitApp
control.
* The Shell provides some overarching functionality for the overall application and takes care of visual adaptation, such as a frame around the App, on desktop browser platforms.
*/
export class Shell extends sap.ui.core.Control {
/**
* Constructor for a new Shell.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:logout logout} event of this sap.m.Shell
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Shell
itself.
*
* Fires when the user presses the logout button/link.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Shell
itself
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public attachLogout(fnFunction: Function, oListener?: any): sap.m.Shell;
/**
* Attaches event handler fnFunction
to the {@link #event:logout logout} event of this sap.m.Shell
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Shell
itself.
*
* Fires when the user presses the logout button/link.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Shell
itself
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public attachLogout(oData: any, fnFunction: Function, oListener?: any): sap.m.Shell;
/**
* Destroys the app in the aggregation {@link #getApp app}.
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public destroyApp(): sap.m.Shell;
/**
* Detaches event handler fnFunction
from the {@link #event:logout logout} event of this sap.m.Shell
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public detachLogout(fnFunction: Function, oListener: any): sap.m.Shell;
/**
* Creates a new subclass of class sap.m.Shell with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:logout logout} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
protected fireLogout(mParameters?: any): sap.m.Shell;
/**
* Gets content of aggregation {@link #getApp app}.
*
* A Shell contains an App or a SplitApp (they may be wrapped in a View). Other control types are not allowed.
* @returns {sap.ui.core.Control}
*/
public getApp(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getAppWidthLimited appWidthLimited}.
*
* Determines whether the width of the content (the aggregated App) should be limited or extended to the full screen width.
*
* Default value is true
.
* @returns {boolean} Value of property appWidthLimited
*/
public getAppWidthLimited(): boolean;
/**
* Gets current value of property {@link #getBackgroundColor backgroundColor}.
*
* Defines the background color of the Shell. If set, this color will override the default background defined by the theme. This should only be set when really required.
* Any configured background image will be placed above this colored background.
* Use the backgroundRepeat property to define whether this image should be stretched to cover the complete Shell or whether it should be tiled.
* @returns {sap.ui.core.CSSColor} Value of property backgroundColor
*/
public getBackgroundColor(): sap.ui.core.CSSColor;
/**
* Gets current value of property {@link #getBackgroundImage backgroundImage}.
*
* Defines the background image of the Shell. If set, this image will override the default background defined by the theme. This should only be set when really required.
* This background image will be placed above any color set for the background.
* Use the backgroundRepeat property to define whether this image should be stretched to cover the complete Shell or whether it should be tiled.
* @returns {sap.ui.core.URI} Value of property backgroundImage
*/
public getBackgroundImage(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getBackgroundOpacity backgroundOpacity}.
*
* Defines the opacity of the background image. The opacity can be set between 0 (fully transparent) and 1 (fully opaque).
* This can be used to improve readability of the Shell content by making the background image partly transparent.
*
* Default value is 1
.
* @returns {number} Value of property backgroundOpacity
*/
public getBackgroundOpacity(): number;
/**
* Gets current value of property {@link #getBackgroundRepeat backgroundRepeat}.
*
* Determines whether the background image (if configured) should be proportionally stretched to cover the whole Shell (false, default) or whether it should be tiled (true).
*
* Default value is false
.
* @returns {boolean} Value of property backgroundRepeat
*/
public getBackgroundRepeat(): boolean;
/**
* Gets current value of property {@link #getHeaderRightText headerRightText}.
*
* Defines texts, such as the name of the logged-in user, which should be displayed on the right side of the header (if there is enough space to display the header at all - this only happens on very tall screens (1568px height), otherwise, it is always hidden).
* @returns {string} Value of property headerRightText
*/
public getHeaderRightText(): string;
/**
* Gets current value of property {@link #getHomeIcon homeIcon}.
*
* Sets the icon used for the mobile device home screen and the icon to be used for bookmarks by desktop browsers.
*
* This property should be only set once, and as early as possible. Subsequent calls replace the previous icon settings and may lead to different behavior depending on the browser.
*
* Different image sizes for device home screen need to be given as PNG images, an ICO file needs to be given as desktop browser bookmark icon (other file formats may not work in all browsers).
* The precomposed
flag defines whether there is already a glow effect contained in the home screen images (or whether iOS should add such an effect). The given structure could look like this:
* {
* 'phone':'phone-icon_57x57.png',
* 'phone@2':'phone-retina_114x114.png',
* 'tablet':'tablet-icon_72x72.png',
* 'tablet@2':'tablet-retina_144x144.png',
* 'precomposed':true,
* 'favicon':'favicon.ico'
* }
*
* See jQuery.sap.setIcons() for full documentation.
* @returns {any} Value of property homeIcon
*/
public getHomeIcon(): any;
/**
* Gets current value of property {@link #getLogo logo}.
*
* Defines the logo to be displayed next to the App when the screen is sufficiently large.
* @returns {sap.ui.core.URI} Value of property logo
*/
public getLogo(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.m.Shell.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowLogout showLogout}.
*
* Determines whether the Logout button should be displayed. Currently, this only happens on very tall screens (1568px height), otherwise, it is always hidden.
*
* Default value is true
.
* @returns {boolean} Value of property showLogout
*/
public getShowLogout(): boolean;
/**
* Gets current value of property {@link #getTitle title}.
*
* Defines the application title, which may or may not be displayed outside the actual application, depending on the available screen size.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getTitleLevel titleLevel}.
*
* Defines the semantic level of the title.
*
* This information is used by assistive technologies, such as screen readers to create a hierarchical site map for faster navigation.
* Depending on this setting an HTML h1-h6 element is used.
*
* Default value is H1
.
* @returns {sap.ui.core.TitleLevel} Value of property titleLevel
*/
public getTitleLevel(): sap.ui.core.TitleLevel;
/**
* Sets the aggregated {@link #getApp app}.
* @param {sap.ui.core.Control} oApp - The app to set
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public setApp(oApp: sap.ui.core.Control): sap.m.Shell;
/**
* Sets a new value for property {@link #getAppWidthLimited appWidthLimited}.
*
* Determines whether the width of the content (the aggregated App) should be limited or extended to the full screen width.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bAppWidthLimited - New value for property appWidthLimited
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public setAppWidthLimited(bAppWidthLimited: boolean): sap.m.Shell;
/**
* Sets a new value for property {@link #getBackgroundColor backgroundColor}.
*
* Defines the background color of the Shell. If set, this color will override the default background defined by the theme. This should only be set when really required.
* Any configured background image will be placed above this colored background.
* Use the backgroundRepeat property to define whether this image should be stretched to cover the complete Shell or whether it should be tiled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSColor} sBackgroundColor - New value for property backgroundColor
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public setBackgroundColor(sBackgroundColor: sap.ui.core.CSSColor): sap.m.Shell;
/**
* Sets a new value for property {@link #getBackgroundImage backgroundImage}.
*
* Defines the background image of the Shell. If set, this image will override the default background defined by the theme. This should only be set when really required.
* This background image will be placed above any color set for the background.
* Use the backgroundRepeat property to define whether this image should be stretched to cover the complete Shell or whether it should be tiled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sBackgroundImage - New value for property backgroundImage
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public setBackgroundImage(sBackgroundImage: sap.ui.core.URI): sap.m.Shell;
/**
* Sets a new value for property {@link #getBackgroundOpacity backgroundOpacity}.
*
* Defines the opacity of the background image. The opacity can be set between 0 (fully transparent) and 1 (fully opaque).
* This can be used to improve readability of the Shell content by making the background image partly transparent.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} fBackgroundOpacity - New value for property backgroundOpacity
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public setBackgroundOpacity(fBackgroundOpacity: number): sap.m.Shell;
/**
* Sets a new value for property {@link #getBackgroundRepeat backgroundRepeat}.
*
* Determines whether the background image (if configured) should be proportionally stretched to cover the whole Shell (false, default) or whether it should be tiled (true).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bBackgroundRepeat - New value for property backgroundRepeat
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public setBackgroundRepeat(bBackgroundRepeat: boolean): sap.m.Shell;
/**
* Sets a new value for property {@link #getHeaderRightText headerRightText}.
*
* Defines texts, such as the name of the logged-in user, which should be displayed on the right side of the header (if there is enough space to display the header at all - this only happens on very tall screens (1568px height), otherwise, it is always hidden).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sHeaderRightText - New value for property headerRightText
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public setHeaderRightText(sHeaderRightText: string): sap.m.Shell;
/**
* Sets a new value for property {@link #getHomeIcon homeIcon}.
*
* Sets the icon used for the mobile device home screen and the icon to be used for bookmarks by desktop browsers.
*
* This property should be only set once, and as early as possible. Subsequent calls replace the previous icon settings and may lead to different behavior depending on the browser.
*
* Different image sizes for device home screen need to be given as PNG images, an ICO file needs to be given as desktop browser bookmark icon (other file formats may not work in all browsers).
* The precomposed
flag defines whether there is already a glow effect contained in the home screen images (or whether iOS should add such an effect). The given structure could look like this:
* {
* 'phone':'phone-icon_57x57.png',
* 'phone@2':'phone-retina_114x114.png',
* 'tablet':'tablet-icon_72x72.png',
* 'tablet@2':'tablet-retina_144x144.png',
* 'precomposed':true,
* 'favicon':'favicon.ico'
* }
*
* See jQuery.sap.setIcons() for full documentation.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oHomeIcon - New value for property homeIcon
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public setHomeIcon(oHomeIcon: any): sap.m.Shell;
/**
* Sets a new value for property {@link #getLogo logo}.
*
* Defines the logo to be displayed next to the App when the screen is sufficiently large.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sLogo - New value for property logo
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public setLogo(sLogo: sap.ui.core.URI): sap.m.Shell;
/**
* Sets a new value for property {@link #getShowLogout showLogout}.
*
* Determines whether the Logout button should be displayed. Currently, this only happens on very tall screens (1568px height), otherwise, it is always hidden.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowLogout - New value for property showLogout
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public setShowLogout(bShowLogout: boolean): sap.m.Shell;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Defines the application title, which may or may not be displayed outside the actual application, depending on the available screen size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.Shell;
/**
* Sets a new value for property {@link #getTitleLevel titleLevel}.
*
* Defines the semantic level of the title.
*
* This information is used by assistive technologies, such as screen readers to create a hierarchical site map for faster navigation.
* Depending on this setting an HTML h1-h6 element is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is H1
.
* @param {sap.ui.core.TitleLevel} sTitleLevel - New value for property titleLevel
* @returns {sap.m.Shell} Reference to this
in order to allow method chaining
*/
public setTitleLevel(sTitleLevel: sap.ui.core.TitleLevel): sap.m.Shell;
}
/**
* Enumeration of possible size settings.
*/
export enum Size {
/**
* The size depends on the device it is running on. It is medium size for desktop and tablet and small size for phone.
*/
Auto = "Auto",
/**
* Large size.
*/
L = "L",
/**
* Medium size.
*/
M = "M",
/**
* The width and height of the control are determined by the width and height of the container the control is placed in.
* Please note: it is decided by the control whether or not sap.m.Size.Responsive is supported.
*/
Responsive = "Responsive",
/**
* Small size.
*/
S = "S",
/**
* Extra small size.
*/
XS = "XS",
}
/**
* Overview
*
* A {@link sap.m.Slider} control represents a numerical range and a handle.
* The purpose of the control is to enable visual selection of a value in a continuous numerical range by moving an adjustable handle.
*
* Notes:
* - Only horizontal sliders are possible.
* - The handle can be moved in steps of predefined size. This is done with the
step
property.
* - Setting the property
showAdvancedTooltips
shows an input field above the handle
* - Setting the property
inputsAsTooltips
enables the user to enter a specific value in the handle's tooltip.
*
* Structure
*
* The most important properties of the Slider are:
*
* - min - The minimum value of the slider range
* - max - The maximum value of the slider range
* - value - The current value of the slider
* - progress - Determines if a progress bar will be shown on the slider range
* - step - Determines the increments in which the slider will move
*
* These properties determine the visualization of the tooltips:
*
* - showAdvancedTooltips - Determines if a tooltip should be displayed above the handle
* - inputsAsTooltips - Determines if the tooltip displayed above the slider's handle should include an input field
*
* Usage
*
* The most common usecase is to select values on a continuous numerical scale (e.g. temperature, volume, etc. ).
*
* Responsive Behavior
*
* The sap.m.Slider
control adjusts to the size of its parent container by recalculating and resizing the width of the control.
* You can move the slider handle in several different ways:
*
* - Drag and drop to the desired value
* - Click/tap on the range bar to move the handle to that location
* - Enter the desired value in the input field (if available)
* - Keyboard (Arrow keys, "+" and "-")
*
*/
export class Slider extends sap.ui.core.Control {
/**
* Constructor for a new Slider
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Slider;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.Slider
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Slider
itself.
*
* This event is triggered after the end user finishes interacting, if there is any change.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Slider
itself
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.m.Slider;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.Slider
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Slider
itself.
*
* This event is triggered after the end user finishes interacting, if there is any change.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Slider
itself
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.m.Slider;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.m.Slider
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Slider
itself.
*
* This event is triggered during the dragging period, each time the slider value changes.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Slider
itself
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public attachLiveChange(fnFunction: Function, oListener?: any): sap.m.Slider;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.m.Slider
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Slider
itself.
*
* This event is triggered during the dragging period, each time the slider value changes.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Slider
itself
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public attachLiveChange(oData: any, fnFunction: Function, oListener?: any): sap.m.Slider;
/**
* Destroys the scale in the aggregation {@link #getScale scale}.
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public destroyScale(): sap.m.Slider;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.m.Slider
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.m.Slider;
/**
* Detaches event handler fnFunction
from the {@link #event:liveChange liveChange} event of this sap.m.Slider
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public detachLiveChange(fnFunction: Function, oListener: any): sap.m.Slider;
/**
* Creates a new subclass of class sap.m.Slider with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.m.Slider;
/**
* Fires event {@link #event:liveChange liveChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
protected fireLiveChange(mParameters?: any): sap.m.Slider;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Indicates whether the user can change the value.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getEnableTickmarks enableTickmarks}.
*
* Enables tickmarks visualisation
*
* Default value is false
.
* @returns {boolean} Value of property enableTickmarks
*/
public getEnableTickmarks(): boolean;
/**
* Gets current value of property {@link #getInputsAsTooltips inputsAsTooltips}.
*
* Indicates whether input fields should be used as tooltips for the handles. Note: Setting this option to true
* will only work if showAdvancedTooltips
is set to true
.
*
* Default value is false
.
* @returns {boolean} Value of property inputsAsTooltips
*/
public getInputsAsTooltips(): boolean;
/**
* Gets current value of property {@link #getMax max}.
*
* The maximum value.
*
* Default value is 100
.
* @returns {number} Value of property max
*/
public getMax(): number;
/**
* Returns a metadata object for class sap.m.Slider.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMin min}.
*
* The minimum value.
*
* Default value is 0
.
* @returns {number} Value of property min
*/
public getMin(): number;
/**
* Gets current value of property {@link #getName name}.
*
* The name property to be used in the HTML code for the slider (e.g. for HTML forms that send data to the server via submit).
*
* Default value is
.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets current value of property {@link #getProgress progress}.
*
* Indicate whether a progress bar indicator is shown.
*
* Default value is true
.
* @returns {boolean} Value of property progress
*/
public getProgress(): boolean;
/**
* Gets content of aggregation {@link #getScale scale}.
*
* Scale for visualisation of tickmarks and labels
* @returns {sap.m.IScale}
*/
public getScale(): sap.m.IScale;
/**
* Gets current value of property {@link #getShowAdvancedTooltip showAdvancedTooltip}.
*
* Indicate whether the handle's advanced tooltip is shown. Note: Setting this option to true
* will ignore the value set in showHandleTooltips
. This will cause only the advanced tooltip to be shown.
*
* Default value is false
.
* @returns {boolean} Value of property showAdvancedTooltip
*/
public getShowAdvancedTooltip(): boolean;
/**
* Gets current value of property {@link #getShowHandleTooltip showHandleTooltip}.
*
* Indicate whether the handle tooltip is shown.
*
* Default value is true
.
* @returns {boolean} Value of property showHandleTooltip
*/
public getShowHandleTooltip(): boolean;
/**
* Gets current value of property {@link #getStep step}.
*
* Define the amount of units to change the slider when adjusting by drag and drop.
*
* Defines the size of the slider's selection intervals. (e.g. min = 0, max = 10, step = 5 would result in possible selection of the values 0, 5, 10).
*
* The step must be positive, if a negative number is provided, the default value will be used instead.
* If the width of the slider converted to pixels is less than the range (max - min), the value will be rounded to multiples of the step size.
*
* Default value is 1
.
* @returns {number} Value of property step
*/
public getStep(): number;
/**
* Gets current value of property {@link #getValue value}.
*
* Define the value.
*
* If the value is lower/higher than the allowed minimum/maximum, the value of the properties min
/max
are used instead.
*
* Default value is 0
.
* @returns {number} Value of property value
*/
public getValue(): number;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the control.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Indicates whether the user can change the value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.Slider;
/**
* Sets a new value for property {@link #getEnableTickmarks enableTickmarks}.
*
* Enables tickmarks visualisation
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableTickmarks - New value for property enableTickmarks
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public setEnableTickmarks(bEnableTickmarks: boolean): sap.m.Slider;
/**
* Sets a new value for property {@link #getInputsAsTooltips inputsAsTooltips}.
*
* Indicates whether input fields should be used as tooltips for the handles. Note: Setting this option to true
* will only work if showAdvancedTooltips
is set to true
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bInputsAsTooltips - New value for property inputsAsTooltips
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public setInputsAsTooltips(bInputsAsTooltips: boolean): sap.m.Slider;
/**
* Sets a new value for property {@link #getMax max}.
*
* The maximum value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100
.
* @param {number} fMax - New value for property max
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public setMax(fMax: number): sap.m.Slider;
/**
* Sets a new value for property {@link #getMin min}.
*
* The minimum value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} fMin - New value for property min
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public setMin(fMin: number): sap.m.Slider;
/**
* Sets a new value for property {@link #getName name}.
*
* The name property to be used in the HTML code for the slider (e.g. for HTML forms that send data to the server via submit).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sName - New value for property name
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.m.Slider;
/**
* Sets a new value for property {@link #getProgress progress}.
*
* Indicate whether a progress bar indicator is shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bProgress - New value for property progress
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public setProgress(bProgress: boolean): sap.m.Slider;
/**
* Sets the aggregated {@link #getScale scale}.
* @param {sap.m.IScale} oScale - The scale to set
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public setScale(oScale: sap.m.IScale): sap.m.Slider;
/**
* Sets a new value for property {@link #getShowAdvancedTooltip showAdvancedTooltip}.
*
* Indicate whether the handle's advanced tooltip is shown. Note: Setting this option to true
* will ignore the value set in showHandleTooltips
. This will cause only the advanced tooltip to be shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowAdvancedTooltip - New value for property showAdvancedTooltip
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public setShowAdvancedTooltip(bShowAdvancedTooltip: boolean): sap.m.Slider;
/**
* Sets a new value for property {@link #getShowHandleTooltip showHandleTooltip}.
*
* Indicate whether the handle tooltip is shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowHandleTooltip - New value for property showHandleTooltip
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public setShowHandleTooltip(bShowHandleTooltip: boolean): sap.m.Slider;
/**
* Sets a new value for property {@link #getStep step}.
*
* Define the amount of units to change the slider when adjusting by drag and drop.
*
* Defines the size of the slider's selection intervals. (e.g. min = 0, max = 10, step = 5 would result in possible selection of the values 0, 5, 10).
*
* The step must be positive, if a negative number is provided, the default value will be used instead.
* If the width of the slider converted to pixels is less than the range (max - min), the value will be rounded to multiples of the step size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} fStep - New value for property step
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public setStep(fStep: number): sap.m.Slider;
/**
* Sets the property value
.
*
* Default value is 0
.
* @param {number} fNewValue - new value for property value
.
* @param {any} mOptions
* @returns {sap.m.Slider} this
to allow method chaining.
*/
public setValue(fNewValue: number, mOptions: any): sap.m.Slider;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.Slider} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.Slider;
/**
* Decrements the value by multiplying the step the step
with the given parameter.
* @param {number} iStep - The number of steps the slider goes down.
* @returns {sap.m.Slider} this
to allow method chaining.
*/
public stepDown(iStep?: number): sap.m.Slider;
/**
* Increments the value by multiplying the step
with the given parameter.
* @param {number} iStep - The number of steps the slider goes up.
* @returns {sap.m.Slider} this
to allow method chaining.
*/
public stepUp(iStep?: number): sap.m.Slider;
}
/**
* The control that displays multiple GenericTile controls as changing slides.
*/
export class SlideTile extends sap.ui.core.Control {
/**
* Constructor for a new sap.m.SlideTile control.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some tile to the aggregation {@link #getTiles tiles}.
* @param {sap.m.GenericTile} oTile - the tile to add; if empty, nothing is inserted
* @returns {sap.m.SlideTile} Reference to this
in order to allow method chaining
*/
public addTile(oTile: sap.m.GenericTile): sap.m.SlideTile;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.SlideTile
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SlideTile
itself.
*
* The event is fired when the user chooses the tile. The event is available only in Actions scope.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SlideTile
itself
* @returns {sap.m.SlideTile} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.SlideTile;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.SlideTile
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SlideTile
itself.
*
* The event is fired when the user chooses the tile. The event is available only in Actions scope.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SlideTile
itself
* @returns {sap.m.SlideTile} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.SlideTile;
/**
* Binds aggregation {@link #getTiles tiles} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.SlideTile} Reference to this
in order to allow method chaining
*/
public bindTiles(oBindingInfo: any): sap.m.SlideTile;
/**
* Destroys all the tiles in the aggregation {@link #getTiles tiles}.
* @returns {sap.m.SlideTile} Reference to this
in order to allow method chaining
*/
public destroyTiles(): sap.m.SlideTile;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.SlideTile
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SlideTile} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.SlideTile;
/**
* Creates a new subclass of class sap.m.SlideTile with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SlideTile} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.SlideTile;
/**
* Gets current value of property {@link #getDisplayTime displayTime}.
*
* The time of the slide display in milliseconds.
*
* Default value is 5000
.
* @returns {number} Value of property displayTime
*/
public getDisplayTime(): number;
/**
* Returns a metadata object for class sap.m.SlideTile.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getScope scope}.
*
* Changes the visualization in order to enable additional actions with the SlideTile control.
*
* Default value is Display
.
* @returns {sap.m.GenericTileScope} Value of property scope
*/
public getScope(): sap.m.GenericTileScope;
/**
* Gets content of aggregation {@link #getTiles tiles}.
*
* The set of Generic Tiles to be shown in the control.
* @returns {sap.m.GenericTile[]}
*/
public getTiles(): sap.m.GenericTile[];
/**
* Gets current value of property {@link #getTransitionTime transitionTime}.
*
* The time of the slide changing in milliseconds.
*
* Default value is 500
.
* @returns {number} Value of property transitionTime
*/
public getTransitionTime(): number;
/**
* Checks for the provided sap.m.GenericTile
in the aggregation {@link #getTiles tiles}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.GenericTile} oTile - The tile whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfTile(oTile: sap.m.GenericTile): number;
/**
* Inserts a tile into the aggregation {@link #getTiles tiles}.
* @param {sap.m.GenericTile} oTile - the tile to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the tile should be inserted at; for a negative value of iIndex
, the tile is inserted at position 0; for a value greater than the current size of the aggregation, the tile is inserted at the last position
* @returns {sap.m.SlideTile} Reference to this
in order to allow method chaining
*/
public insertTile(oTile: sap.m.GenericTile, iIndex: number): sap.m.SlideTile;
/**
* Removes all the controls from the aggregation {@link #getTiles tiles}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.GenericTile[]} An array of the removed elements (might be empty)
*/
public removeAllTiles(): sap.m.GenericTile[];
/**
* Removes a tile from the aggregation {@link #getTiles tiles}.
* @param {number|string|sap.m.GenericTile} vTile - The tile to remove or its index or id
* @returns {sap.m.GenericTile} The removed tile or null
*/
public removeTile(vTile: number|string|sap.m.GenericTile): sap.m.GenericTile;
/**
* Sets a new value for property {@link #getDisplayTime displayTime}.
*
* The time of the slide display in milliseconds.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 5000
.
* @param {number} iDisplayTime - New value for property displayTime
* @returns {sap.m.SlideTile} Reference to this
in order to allow method chaining
*/
public setDisplayTime(iDisplayTime: number): sap.m.SlideTile;
/**
* Sets a new value for property {@link #getScope scope}.
*
* Changes the visualization in order to enable additional actions with the SlideTile control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Display
.
* @param {sap.m.GenericTileScope} sScope - New value for property scope
* @returns {sap.m.SlideTile} Reference to this
in order to allow method chaining
*/
public setScope(sScope: sap.m.GenericTileScope): sap.m.SlideTile;
/**
* Sets a new value for property {@link #getTransitionTime transitionTime}.
*
* The time of the slide changing in milliseconds.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 500
.
* @param {number} iTransitionTime - New value for property transitionTime
* @returns {sap.m.SlideTile} Reference to this
in order to allow method chaining
*/
public setTransitionTime(iTransitionTime: number): sap.m.SlideTile;
/**
* Unbinds aggregation {@link #getTiles tiles} from model data.
* @returns {sap.m.SlideTile} Reference to this
in order to allow method chaining
*/
public unbindTiles(): sap.m.SlideTile;
}
/**
* SplitApp is another possible root element of an SAPUI5 mobile application besides {@link sap.m.App}. It contains two NavContainers if running on tablet or desktop, and one on phone.
* The display of master NavContainer depends on the portrait/landscape mode of the device and the mode of SplitApp.
* Structure
* The SplitApp divides the screen into two areas:
*
* - Master area - contains a list of available items where the user can search and filter.
* - Details area - contains a control which shows further details on the item(s) selected from the master view.
*
* Both areas have separate headers and footer bars with navigation and actions.
* Usage
* When to use
*
* - You need to review and process different items quickly with minimal navigation.
*
* When not to use
*
* - You need to offer complex filters for the list of items.
* - You need to see different attributes for each item in the list, and compare these values across items.
* - You want to display a single object. Do not use the master list to display different facets of the same object.
*
* Responsive Behavior
* On narrow screens for phones (or tablet devices in portrait mode), the master list and the details are split into two separate pages.
*
* The user can navigate between the list and details, and see all the available information for each area.
*/
export class SplitApp extends sap.m.SplitContainer {
/**
* Constructor for a new SplitApp.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control A container control that is used to display a master-detail view in an application.
*/
public constructor(sId?: string, mSettings?: any);
/**
* Fires the orientationChange event after SplitApp has reacted to the browser orientationChange event.
*/
protected _onOrientationChange(): void;
/**
* Attaches event handler fnFunction
to the {@link #event:orientationChange orientationChange} event of this sap.m.SplitApp
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitApp
itself.
*
* Fires when orientation (portrait/landscape) is changed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitApp
itself
* @returns {sap.m.SplitApp} Reference to this
in order to allow method chaining
*/
public attachOrientationChange(fnFunction: Function, oListener?: any): sap.m.SplitApp;
/**
* Attaches event handler fnFunction
to the {@link #event:orientationChange orientationChange} event of this sap.m.SplitApp
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitApp
itself.
*
* Fires when orientation (portrait/landscape) is changed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitApp
itself
* @returns {sap.m.SplitApp} Reference to this
in order to allow method chaining
*/
public attachOrientationChange(oData: any, fnFunction: Function, oListener?: any): sap.m.SplitApp;
/**
* Detaches event handler fnFunction
from the {@link #event:orientationChange orientationChange} event of this sap.m.SplitApp
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SplitApp} Reference to this
in order to allow method chaining
*/
public detachOrientationChange(fnFunction: Function, oListener: any): sap.m.SplitApp;
/**
* Creates a new subclass of class sap.m.SplitApp with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.SplitContainer.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:orientationChange orientationChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SplitApp} Reference to this
in order to allow method chaining
*/
protected fireOrientationChange(mParameters?: any): sap.m.SplitApp;
/**
* Gets current value of property {@link #getHomeIcon homeIcon}.
*
* Represents the icon to be displayed on the home screen of iOS devices after the user does "add to home screen".
* Note that only the first attempt to set the homeIcon is executed, subsequent settings are ignored.
* The icon must be in PNG format. The property can either store the URL of one single icon or an object holding icon URLs for the different required sizes.
* Note that if single icon is used for all devices, when scaled, its quality can regress.
* A desktop icon (used for bookmarks and overriding the favicon) can also be configured. This requires an object to be given and the "icon" property of this object then defines the desktop bookmark icon.
* For this icon, PNG is not supported by Internet Explorer. The ICO format is supported by all browsers. ICO is also preferred for this desktop icon setting as the file can contain different images for different resolutions.
*
* One example is:
*
* app.setHomeIcon({
* 'phone':'phone-icon.png',
* 'phone@2':'phone-retina.png',
* 'tablet':'tablet-icon.png',
* 'tablet@2':'tablet-retina.png',
* 'icon':'desktop.ico'
* });
*
* The image size is 57/114 px for the phone and 72/144 px for the tablet.
* If an object is given but one of the sizes is not given, the largest given icon will be used for this size.
*
* On Android, these icons may or may not be used by the device. Chances can be improved by adding glare effect, rounded corners, setting the file name to end with "-precomposed.png", and setting the homeIconPrecomposed property to true.
* @returns {any} Value of property homeIcon
*/
public getHomeIcon(): any;
/**
* Returns a metadata object for class sap.m.SplitApp.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets a new value for property {@link #getHomeIcon homeIcon}.
*
* Represents the icon to be displayed on the home screen of iOS devices after the user does "add to home screen".
* Note that only the first attempt to set the homeIcon is executed, subsequent settings are ignored.
* The icon must be in PNG format. The property can either store the URL of one single icon or an object holding icon URLs for the different required sizes.
* Note that if single icon is used for all devices, when scaled, its quality can regress.
* A desktop icon (used for bookmarks and overriding the favicon) can also be configured. This requires an object to be given and the "icon" property of this object then defines the desktop bookmark icon.
* For this icon, PNG is not supported by Internet Explorer. The ICO format is supported by all browsers. ICO is also preferred for this desktop icon setting as the file can contain different images for different resolutions.
*
* One example is:
*
* app.setHomeIcon({
* 'phone':'phone-icon.png',
* 'phone@2':'phone-retina.png',
* 'tablet':'tablet-icon.png',
* 'tablet@2':'tablet-retina.png',
* 'icon':'desktop.ico'
* });
*
* The image size is 57/114 px for the phone and 72/144 px for the tablet.
* If an object is given but one of the sizes is not given, the largest given icon will be used for this size.
*
* On Android, these icons may or may not be used by the device. Chances can be improved by adding glare effect, rounded corners, setting the file name to end with "-precomposed.png", and setting the homeIconPrecomposed property to true.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oHomeIcon - New value for property homeIcon
* @returns {sap.m.SplitApp} Reference to this
in order to allow method chaining
*/
public setHomeIcon(oHomeIcon: any): sap.m.SplitApp;
}
/**
* The mode of SplitContainer or SplitApp control to show/hide the master area.
*/
export enum SplitAppMode {
/**
* Master area is hidden initially both in portrait and landscape. Master area can be opened by clicking on the top left corner button or swiping right. Swipe is only enabled on mobile devices. Master will keep the open state when changing the orientation of the device.
*/
HideMode = "HideMode",
/**
* Master will be shown inside a Popover when in portrait mode
*/
PopoverMode = "PopoverMode",
/**
* Master will automatically be hidden in portrait mode.
*/
ShowHideMode = "ShowHideMode",
/**
* Master will always be shown but in a compressed version when in portrait mode.
*/
StretchCompressMode = "StretchCompressMode",
}
/**
* SplitContainer maintains two NavContainers if running on tablet or desktop and one NavContainer - on phone.
* The display of the master NavContainer depends on the portrait/landscape mode of the device and the mode of SplitContainer.
*
* NOTE: This control must be rendered as a full screen control in order to make the show/hide master area work properly.
*/
export class SplitContainer extends sap.ui.core.Control {
/**
* Constructor for a new SplitContainer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some detailPage to the aggregation {@link #getDetailPages detailPages}.
* @param {sap.ui.core.Control} oDetailPage - the detailPage to add; if empty, nothing is inserted
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public addDetailPage(oDetailPage: sap.ui.core.Control): sap.m.SplitContainer;
/**
* Adds some masterPage to the aggregation {@link #getMasterPages masterPages}.
* @param {sap.ui.core.Control} oMasterPage - the masterPage to add; if empty, nothing is inserted
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public addMasterPage(oMasterPage: sap.ui.core.Control): sap.m.SplitContainer;
/**
* Adds a content entity either to master area or detail area depending on the master parameter.
*
* The method is provided mainly for providing API consistency between sap.m.SplitContainer and sap.m.App. So that the same code line can be reused.
* @param {sap.ui.core.Control} oPage - The content entities between which this SplitContainer navigates in either master area or detail area depending on the master parameter. These can be of type sap.m.Page, sap.ui.core.View, sap.m.Carousel or any other control with fullscreen/page semantics.
* @param {boolean} bMaster - States if the page should be added to the master area. If it's set to false, the page is added to detail area.
* @returns {sap.m.SplitContainer}
*/
public addPage(oPage: sap.ui.core.Control, bMaster: boolean): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:afterDetailNavigate afterDetailNavigate} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires when navigation between two pages in detail area has completed.
* NOTE: In case of animated transitions this event is fired with some delay after the "navigate" event.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachAfterDetailNavigate(fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:afterDetailNavigate afterDetailNavigate} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires when navigation between two pages in detail area has completed.
* NOTE: In case of animated transitions this event is fired with some delay after the "navigate" event.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachAfterDetailNavigate(oData: any, fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:afterMasterClose afterMasterClose} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires when the master area is fully closed after the animation (if any).
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachAfterMasterClose(fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:afterMasterClose afterMasterClose} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires when the master area is fully closed after the animation (if any).
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachAfterMasterClose(oData: any, fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:afterMasterNavigate afterMasterNavigate} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires when navigation between two pages in master area has completed.
* NOTE: In case of animated transitions this event is fired with some delay after the navigate event.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachAfterMasterNavigate(fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:afterMasterNavigate afterMasterNavigate} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires when navigation between two pages in master area has completed.
* NOTE: In case of animated transitions this event is fired with some delay after the navigate event.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachAfterMasterNavigate(oData: any, fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:afterMasterOpen afterMasterOpen} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires when the master area is fully opened after animation if any.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachAfterMasterOpen(fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:afterMasterOpen afterMasterOpen} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires when the master area is fully opened after animation if any.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachAfterMasterOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeMasterClose beforeMasterClose} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires before the master area is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachBeforeMasterClose(fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeMasterClose beforeMasterClose} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires before the master area is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachBeforeMasterClose(oData: any, fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeMasterOpen beforeMasterOpen} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires before the master area is opened.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachBeforeMasterOpen(fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeMasterOpen beforeMasterOpen} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires before the master area is opened.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachBeforeMasterOpen(oData: any, fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:detailNavigate detailNavigate} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires when navigation between two pages in detail area has been triggered.
* The transition (if any) to the new page has not started yet.
* NOTE: This event can be aborted by the application with preventDefault(), which means that there will be no navigation.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachDetailNavigate(fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:detailNavigate detailNavigate} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires when navigation between two pages in detail area has been triggered.
* The transition (if any) to the new page has not started yet.
* NOTE: This event can be aborted by the application with preventDefault(), which means that there will be no navigation.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachDetailNavigate(oData: any, fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:masterButton masterButton} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires when a Master Button needs to be shown or hidden. This is necessary for custom headers when the SplitContainer control does not handle the placement of the master button automatically.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachMasterButton(fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:masterButton masterButton} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires when a Master Button needs to be shown or hidden. This is necessary for custom headers when the SplitContainer control does not handle the placement of the master button automatically.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachMasterButton(oData: any, fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:masterNavigate masterNavigate} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires when navigation between two pages in master area has been triggered. The transition (if any) to the new page has not started yet.
* This event can be aborted by the application with preventDefault(), which means that there will be no navigation.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachMasterNavigate(fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:masterNavigate masterNavigate} event of this sap.m.SplitContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.SplitContainer
itself.
*
* Fires when navigation between two pages in master area has been triggered. The transition (if any) to the new page has not started yet.
* This event can be aborted by the application with preventDefault(), which means that there will be no navigation.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.SplitContainer
itself
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public attachMasterNavigate(oData: any, fnFunction: Function, oListener?: any): sap.m.SplitContainer;
/**
* Navigates back to the previous detail page found in the history.
* @param {any} oBackData - This optional object can carry any payload data which should be made available to the target page of the back navigation. The event on the target page will contain this data object as backData property. (The original data from the to() navigation will still be available as data property.) In scenarios where the entity triggering the navigation can or should not directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data. For back navigation this can be used, for example, when returning from a detail page to transfer any settings done there. When the transitionParameters object is used, this data object must also be given (either as object or as null) in order to have a proper parameter order.
* @param {any} oTransitionParameter - This optional object can give additional information to the transition function, like the DOM element, which triggered the transition or the desired transition duration. The animation type can NOT be selected here - it is always the inverse of the "to" navigation. In order to use the transitionParameters property, the data property must be used (at least "null" must be given) for a proper parameter order. NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition.
* @returns {sap.m.SplitContainer}
*/
public backDetail(oBackData: any, oTransitionParameter: any): sap.m.SplitContainer;
/**
* Navigates back to the previous master page which is found in the history.
* @param {any} oBackData - This optional object can carry any payload data which should be made available to the target page of the back navigation. The event on the target page will contain this data object as backData property (the original data from the to() navigation will still be available as data property). In scenarios where the entity triggering the navigation can or should not directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data. For back navigation this can be used, for example, when returning from a detail page to transfer any settings done there. When the transitionParameters object is used, this data object must also be given (either as object or as null) in order to have a proper parameter order.
* @param {any} oTransitionParameter - This optional object can give additional information to the transition function, like the DOM element, which triggered the transition or the desired transition duration. The animation type can NOT be selected here - it is always the inverse of the "to" navigation. In order to use the transitionParameters property, the data property must be used (at least "null" must be given) for a proper parameter order. NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition.
* @returns {sap.m.SplitContainer}
*/
public backMaster(oBackData: any, oTransitionParameter: any): sap.m.SplitContainer;
/**
* Navigates back to the nearest previous page in the SplitContainer history with the given ID (if there is no such page among the previous pages, nothing happens).
* The transition effect, which had been used to get to the current page is inverted and used for this navigation.
*
* Calling this navigation method, first triggers the (cancelable) navigate event on the SplitContainer,
* then the beforeHide pseudo event on the source page, beforeFirstShow (if applicable),
* and beforeShow on the target page. Later, after the transition has completed,
* the afterShow pseudo event is triggered on the target page and afterHide - on the page, which has been left.
* The given backData object is available in the beforeFirstShow, beforeShow, and afterShow event objects as data
* property. The original "data" object from the "to" navigation is also available in these event objects.
* @param {string} sPageId - The screen to which is being navigated to. The ID or the control itself can be given.
* @param {any} oBackData - This optional object can carry any payload data which should be made available to the target page of the back navigation. The event on the target page will contain this data object as backData property. (the original data from the to() navigation will still be available as data property). In scenarios, where the entity triggering the navigation can't or shouldn't directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data. For back navigation this can be used, for example, when returning from a detail page to transfer any settings done there. When the transitionParameters object is used, this data object must also be given (either as object or as null) in order to have a proper parameter order.
* @param {any} oTransitionParameters - This optional object can give additional information to the transition function, like the DOM element, which triggered the transition or the desired transition duration. The animation type can NOT be selected here - it is always the inverse of the "to" navigation. In order to use the transitionParameters property, the data property must be used (at least "null" must be given) for a proper parameter order. NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition.
* @returns {sap.m.SplitContainer}
*/
public backToPage(sPageId: string, oBackData: any, oTransitionParameters: any): sap.m.SplitContainer;
/**
* Navigates back to the initial/top level of Detail (this is the element aggregated as initialPage, or the first added element).
* NOTE: If already on the initial page, nothing happens.
* The transition effect which had been used to get to the current page is inverted and used for this navigation.
* @param {any} oBackData - This optional object can carry any payload data which should be made available to the target page of the back navigation. The event on the target page will contain this data object as backData property (the original data from the to() navigation will still be available as data property). In scenarios where the entity triggering the navigation can or should not directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data. For back navigation this can be used, for example, when returning from a detail page to transfer any settings done there. When the transitionParameters object is used, this data object must also be given (either as object or as null) in order to have a proper parameter order.
* @param {any} oTransitionParameter - This optional object can give additional information to the transition function, like the DOM element, which triggered the transition or the desired transition duration. The animation type can NOT be selected here - it is always the inverse of the "to" navigation. In order to use the transitionParameters property, the data property must be used (at least "null" must be given) for a proper parameter order. NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition.
* @returns {sap.ui.core.Control}
*/
public backToTopDetail(oBackData: any, oTransitionParameter: any): sap.ui.core.Control;
/**
* Navigates back to the initial/top level of Master (this is the element aggregated as "initialPage", or the first added element).
* NOTE: If already on the initial page, nothing happens.
* The transition effect which had been used to get to the current page is inverted and used for this navigation.
* @param {any} oBackData - This optional object can carry any payload data which should be made available to the target page of the back navigation. The event on the target page will contain this data object as "backData" property. (The original data from the "to()" navigation will still be available as "data" property.) In scenarios where the entity triggering the navigation can or should not directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data. For back navigation this can be used e.g. when returning from a detail page to transfer any settings done there. When the "transitionParameters" object is used, this "data" object must also be given (either as object or as null) in order to have a proper parameter order.
* @param {any} oTransitionParameter - This optional object can give additional information to the transition function, like the DOM element which triggered the transition or the desired transition duration. The animation type can NOT be selected here - it is always the inverse of the "to" navigation. In order to use the transitionParameters property, the data property must be used (at least "null" must be given) for a proper parameter order. NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition.
* @returns {sap.ui.core.Control}
*/
public backToTopMaster(oBackData: any, oTransitionParameter: any): sap.ui.core.Control;
/**
* Destroys all the detailPages in the aggregation {@link #getDetailPages detailPages}.
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public destroyDetailPages(): sap.m.SplitContainer;
/**
* Destroys all the masterPages in the aggregation {@link #getMasterPages masterPages}.
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public destroyMasterPages(): sap.m.SplitContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:afterDetailNavigate afterDetailNavigate} event of this sap.m.SplitContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public detachAfterDetailNavigate(fnFunction: Function, oListener: any): sap.m.SplitContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:afterMasterClose afterMasterClose} event of this sap.m.SplitContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public detachAfterMasterClose(fnFunction: Function, oListener: any): sap.m.SplitContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:afterMasterNavigate afterMasterNavigate} event of this sap.m.SplitContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public detachAfterMasterNavigate(fnFunction: Function, oListener: any): sap.m.SplitContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:afterMasterOpen afterMasterOpen} event of this sap.m.SplitContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public detachAfterMasterOpen(fnFunction: Function, oListener: any): sap.m.SplitContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeMasterClose beforeMasterClose} event of this sap.m.SplitContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public detachBeforeMasterClose(fnFunction: Function, oListener: any): sap.m.SplitContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeMasterOpen beforeMasterOpen} event of this sap.m.SplitContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public detachBeforeMasterOpen(fnFunction: Function, oListener: any): sap.m.SplitContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:detailNavigate detailNavigate} event of this sap.m.SplitContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public detachDetailNavigate(fnFunction: Function, oListener: any): sap.m.SplitContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:masterButton masterButton} event of this sap.m.SplitContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public detachMasterButton(fnFunction: Function, oListener: any): sap.m.SplitContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:masterNavigate masterNavigate} event of this sap.m.SplitContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public detachMasterNavigate(fnFunction: Function, oListener: any): sap.m.SplitContainer;
/**
* Creates a new subclass of class sap.m.SplitContainer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:afterDetailNavigate afterDetailNavigate} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
protected fireAfterDetailNavigate(mParameters?: any): sap.m.SplitContainer;
/**
* Fires event {@link #event:afterMasterClose afterMasterClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
protected fireAfterMasterClose(mParameters?: any): sap.m.SplitContainer;
/**
* Fires event {@link #event:afterMasterNavigate afterMasterNavigate} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
protected fireAfterMasterNavigate(mParameters?: any): sap.m.SplitContainer;
/**
* Fires event {@link #event:afterMasterOpen afterMasterOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
protected fireAfterMasterOpen(mParameters?: any): sap.m.SplitContainer;
/**
* Fires event {@link #event:beforeMasterClose beforeMasterClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
protected fireBeforeMasterClose(mParameters?: any): sap.m.SplitContainer;
/**
* Fires event {@link #event:beforeMasterOpen beforeMasterOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
protected fireBeforeMasterOpen(mParameters?: any): sap.m.SplitContainer;
/**
* Fires event {@link #event:detailNavigate detailNavigate} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireDetailNavigate(mParameters?: any): boolean;
/**
* Fires event {@link #event:masterButton masterButton} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
protected fireMasterButton(mParameters?: any): sap.m.SplitContainer;
/**
* Fires event {@link #event:masterNavigate masterNavigate} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireMasterNavigate(mParameters?: any): boolean;
/**
* Gets current value of property {@link #getBackgroundColor backgroundColor}.
*
* Determines the background color of the SplitContainer. If set, this color overrides the default one,
* which is defined by the theme (should only be used when really required).
* Any configured background image will be placed above this colored background,
* but any theme adaptation in the Theme Designer will override this setting.
* Use the backgroundRepeat property to define whether this image should be stretched
* to cover the complete SplitContainer or whether it should be tiled.
* @returns {string} Value of property backgroundColor
*/
public getBackgroundColor(): string;
/**
* Gets current value of property {@link #getBackgroundImage backgroundImage}.
*
* Sets the background image of the SplitContainer. When set, this image overrides
* the default background defined by the theme (should only be used when really required).
* This background image will be placed above any color set for the background,
* but any theme adaptation in the Theme Designer will override this image setting.
* Use the backgroundRepeat property to define whether this image should be stretched
* to cover the complete SplitContainer or whether it should be tiled.
* @returns {sap.ui.core.URI} Value of property backgroundImage
*/
public getBackgroundImage(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getBackgroundOpacity backgroundOpacity}.
*
* Defines the opacity of the background image - between 0 (fully transparent) and 1 (fully opaque).
* This can be used to improve the content visibility by making the background image partly transparent.
*
* Default value is 1
.
* @returns {number} Value of property backgroundOpacity
*/
public getBackgroundOpacity(): number;
/**
* Gets current value of property {@link #getBackgroundRepeat backgroundRepeat}.
*
* Defines whether the background image (if configured) is proportionally stretched
* to cover the whole SplitContainer (false) or whether it should be tiled (true).
*
* Default value is false
.
* @returns {boolean} Value of property backgroundRepeat
*/
public getBackgroundRepeat(): boolean;
/**
* Returns the current displayed detail page.
* @returns {sap.ui.core.Control}
*/
public getCurrentDetailPage(): sap.ui.core.Control;
/**
* Returns the current displayed master page.
* @returns {sap.ui.core.Control}
*/
public getCurrentMasterPage(): sap.ui.core.Control;
/**
* Returns the currently displayed page either in master area or in detail area.
* When the parameter is set to true, the current page in master area is returned, otherwise, the current page in detail area is returned.
*
* This method is provided mainly for API consistency between sap.m.SplitContainer and sap.m.App, so that the same code line can be reused.
* @param {boolean} bMaster - States if this function returns the current page in master area. If it's set to false, the current page in detail area will be returned.
* @returns {sap.ui.core.Control}
*/
public getCurrentPage(bMaster: boolean): sap.ui.core.Control;
/**
* Gets current value of property {@link #getDefaultTransitionNameDetail defaultTransitionNameDetail}.
*
* Determines the type of the transition/animation to apply when to() is called without defining the
* transition to use. The default is "slide", other options are "fade", "show", and the names of any registered custom transitions.
*
* Default value is slide
.
* @returns {string} Value of property defaultTransitionNameDetail
*/
public getDefaultTransitionNameDetail(): string;
/**
* Gets current value of property {@link #getDefaultTransitionNameMaster defaultTransitionNameMaster}.
*
* Determines the type of the transition/animation to apply when to() is called, without defining the
* transition to use. The default is "slide", other options are "fade", "show", and the names of any registered custom transitions.
*
* Default value is slide
.
* @returns {string} Value of property defaultTransitionNameMaster
*/
public getDefaultTransitionNameMaster(): string;
/**
* Returns the page with the given ID in detail area. If there's no page that has the given ID, null is returned.
* @param {string} sId - The ID of the page that needs to be fetched.
* @returns {sap.ui.core.Control}
*/
public getDetailPage(sId: string): sap.ui.core.Control;
/**
* Gets content of aggregation {@link #getDetailPages detailPages}.
*
* Determines the content entities, between which the SplitContainer navigates in detail area.
* These can be of type sap.m.Page, sap.ui.core.View, sap.m.Carousel or any other control with fullscreen/page semantics.
* These aggregated controls receive navigation events like {@link sap.m.NavContainerChild#beforeShow beforeShow},
* they are documented in the pseudo interface {@link sap.m.NavContainerChild sap.m.NavContainerChild}.
* @returns {sap.ui.core.Control[]}
*/
public getDetailPages(): sap.ui.core.Control[];
/**
* ID of the element which is the current target of the association {@link #getInitialDetail initialDetail}, or null
.
* @returns {sap.ui.core.ID}
*/
public getInitialDetail(): sap.ui.core.ID;
/**
* ID of the element which is the current target of the association {@link #getInitialMaster initialMaster}, or null
.
* @returns {sap.ui.core.ID}
*/
public getInitialMaster(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getMasterButtonText masterButtonText}.
*
* Determines the text displayed in master button, which has a default value "Navigation".
* This text is only displayed in iOS platform and the icon from the current page in detail area is
* displayed in the master button for the other platforms.
* The master button is shown/hidden depending on the orientation of the device and whether
* the master area is opened or not. SplitContainer manages the show/hide of the master button by itself
* only when the pages added to the detail area are sap.m.Page with built-in header or sap.m.Page
* with built-in header, which is wrapped by one or several sap.ui.core.mvc.View.
* Otherwise, the show/hide of master button needs to be managed by the application.
* @returns {string} Value of property masterButtonText
*/
public getMasterButtonText(): string;
/**
* Gets current value of property {@link #getMasterButtonTooltip masterButtonTooltip}.
*
* Specifies the tooltip of the master button. If the tooltip is not specified,
* the title of the page, which is displayed is the master part, is set as tooltip to the master button.
* @returns {string} Value of property masterButtonTooltip
*/
public getMasterButtonTooltip(): string;
/**
* Returns the page with the given ID in master area (if there's no page that has the given ID, null is returned).
* @param {string} sId - The ID of the page that needs to be fetched
* @returns {sap.ui.core.Control}
*/
public getMasterPage(sId: string): sap.ui.core.Control;
/**
* Gets content of aggregation {@link #getMasterPages masterPages}.
*
* Determines the content entities, between which the SplitContainer navigates in master area.
* These can be of type sap.m.Page, sap.ui.core.View, sap.m.Carousel or any other control with fullscreen/page semantics.
* These aggregated controls receive navigation events like {@link sap.m.NavContainerChild#beforeShow beforeShow},
* they are documented in the pseudo interface {@link sap.m.NavContainerChild sap.m.NavContainerChild}.
* @returns {sap.ui.core.Control[]}
*/
public getMasterPages(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.m.SplitContainer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMode mode}.
*
* Defines whether the master page will always be displayed (in portrait and landscape mode - StretchCompressMode),
* or if it should be hidden when in portrait mode (ShowHideMode). Default is ShowHideMode.
* Other possible values are Hide (Master is always hidden) and Popover (master is displayed in popover).
*
* Default value is ShowHideMode
.
* @returns {sap.m.SplitAppMode} Value of property mode
*/
public getMode(): sap.m.SplitAppMode;
/**
* Returns the page with the given ID from either master area, or detail area depending on the master parameter (if there's no page that has the given ID, null is returned).
* @param {string} sId - The ID of the page that needs to be fetched
* @param {boolean} bMaster - If the page with given ID should be fetched from the master area. If it's set to false, the page will be fetched from detail area.
* @returns {sap.ui.core.Control}
*/
public getPage(sId: string, bMaster: boolean): sap.ui.core.Control;
/**
* Returns the previous page (the page, from which the user drilled down to the current page with to()).
* Note: this is not the page, which the user has seen before, but the page which is the target of the next back() navigation.
* If there is no previous page, "undefined" is returned.
* @param {boolean} bMaster - States if this function returns the previous page in master area. If it's set to false, the previous page in detail area will be returned.
* @returns {sap.ui.core.Control}
*/
public getPreviousPage(bMaster: boolean): sap.ui.core.Control;
/**
* Used to hide the master page when in ShowHideMode and the device is in portrait mode.
* @returns {sap.m.SplitContainer}
*/
public hideMaster(): sap.m.SplitContainer;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getDetailPages detailPages}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oDetailPage - The detailPage whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfDetailPage(oDetailPage: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getMasterPages masterPages}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oMasterPage - The masterPage whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfMasterPage(oMasterPage: sap.ui.core.Control): number;
/**
* Inserts a detailPage into the aggregation {@link #getDetailPages detailPages}.
* @param {sap.ui.core.Control} oDetailPage - the detailPage to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the detailPage should be inserted at; for a negative value of iIndex
, the detailPage is inserted at position 0; for a value greater than the current size of the aggregation, the detailPage is inserted at the last position
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public insertDetailPage(oDetailPage: sap.ui.core.Control, iIndex: number): sap.m.SplitContainer;
/**
* Inserts a masterPage into the aggregation {@link #getMasterPages masterPages}.
* @param {sap.ui.core.Control} oMasterPage - the masterPage to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the masterPage should be inserted at; for a negative value of iIndex
, the masterPage is inserted at position 0; for a value greater than the current size of the aggregation, the masterPage is inserted at the last position
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public insertMasterPage(oMasterPage: sap.ui.core.Control, iIndex: number): sap.m.SplitContainer;
/**
* Inserts the page/control with the specified ID into the navigation history stack of the NavContainer.
*
* This can be used for deep-linking when the user directly reached a drilldown detail page using a bookmark and then wants to navigate up in the drilldown hierarchy.
* Normally, such a back navigation would not be possible as there is no previous page in the SplitContainer's history stack.
* @param {string} sPageId - The ID of the control/page/screen, which is inserted into the history stack. The respective control must be aggregated by the SplitContainer, otherwise this will cause an error.
* @param {string} sTransitionName - The type of the transition/animation, which would have been used to navigate from the (inserted) previous page to the current page. When navigating back, the inverse animation will be applied. This parameter can be omitted; then the default value is "slide" (horizontal movement from the right).
* @param {any} oData - This optional object can carry any payload data which would have been given to the inserted previous page if the user would have done a normal forward navigation to it.
* @returns {sap.m.SplitContainer}
*/
public insertPreviousPage(sPageId: string, sTransitionName: string, oData: any): sap.m.SplitContainer;
/**
* Returns whether master area is currently displayed on the screen.
* In desktop browser or tablet, this method returns true when master area is displayed on the screen, regardless if in portrait or landscape mode.
* On mobile phone devices, this method returns true when the currently displayed page is from the pages, which are added to the master area, otherwise, it returns false.
* @returns {boolean}
*/
public isMasterShown(): boolean;
/**
* Removes all the controls from the aggregation {@link #getDetailPages detailPages}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllDetailPages(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getMasterPages masterPages}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllMasterPages(): sap.ui.core.Control[];
/**
* Removes a detailPage from the aggregation {@link #getDetailPages detailPages}.
* @param {number|string|sap.ui.core.Control} vDetailPage - The detailPage to remove or its index or id
* @returns {sap.ui.core.Control} The removed detailPage or null
*/
public removeDetailPage(vDetailPage: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a masterPage from the aggregation {@link #getMasterPages masterPages}.
* @param {number|string|sap.ui.core.Control} vMasterPage - The masterPage to remove or its index or id
* @returns {sap.ui.core.Control} The removed masterPage or null
*/
public removeMasterPage(vMasterPage: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getBackgroundColor backgroundColor}.
*
* Determines the background color of the SplitContainer. If set, this color overrides the default one,
* which is defined by the theme (should only be used when really required).
* Any configured background image will be placed above this colored background,
* but any theme adaptation in the Theme Designer will override this setting.
* Use the backgroundRepeat property to define whether this image should be stretched
* to cover the complete SplitContainer or whether it should be tiled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sBackgroundColor - New value for property backgroundColor
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public setBackgroundColor(sBackgroundColor: string): sap.m.SplitContainer;
/**
* Sets a new value for property {@link #getBackgroundImage backgroundImage}.
*
* Sets the background image of the SplitContainer. When set, this image overrides
* the default background defined by the theme (should only be used when really required).
* This background image will be placed above any color set for the background,
* but any theme adaptation in the Theme Designer will override this image setting.
* Use the backgroundRepeat property to define whether this image should be stretched
* to cover the complete SplitContainer or whether it should be tiled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sBackgroundImage - New value for property backgroundImage
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public setBackgroundImage(sBackgroundImage: sap.ui.core.URI): sap.m.SplitContainer;
/**
* Sets a new value for property {@link #getBackgroundOpacity backgroundOpacity}.
*
* Defines the opacity of the background image - between 0 (fully transparent) and 1 (fully opaque).
* This can be used to improve the content visibility by making the background image partly transparent.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} fBackgroundOpacity - New value for property backgroundOpacity
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public setBackgroundOpacity(fBackgroundOpacity: number): sap.m.SplitContainer;
/**
* Sets a new value for property {@link #getBackgroundRepeat backgroundRepeat}.
*
* Defines whether the background image (if configured) is proportionally stretched
* to cover the whole SplitContainer (false) or whether it should be tiled (true).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bBackgroundRepeat - New value for property backgroundRepeat
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public setBackgroundRepeat(bBackgroundRepeat: boolean): sap.m.SplitContainer;
/**
* Sets a new value for property {@link #getDefaultTransitionNameDetail defaultTransitionNameDetail}.
*
* Determines the type of the transition/animation to apply when to() is called without defining the
* transition to use. The default is "slide", other options are "fade", "show", and the names of any registered custom transitions.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is slide
.
* @param {string} sDefaultTransitionNameDetail - New value for property defaultTransitionNameDetail
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public setDefaultTransitionNameDetail(sDefaultTransitionNameDetail: string): sap.m.SplitContainer;
/**
* Sets a new value for property {@link #getDefaultTransitionNameMaster defaultTransitionNameMaster}.
*
* Determines the type of the transition/animation to apply when to() is called, without defining the
* transition to use. The default is "slide", other options are "fade", "show", and the names of any registered custom transitions.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is slide
.
* @param {string} sDefaultTransitionNameMaster - New value for property defaultTransitionNameMaster
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public setDefaultTransitionNameMaster(sDefaultTransitionNameMaster: string): sap.m.SplitContainer;
/**
* Sets the associated {@link #getInitialDetail initialDetail}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oInitialDetail - ID of an element which becomes the new target of this initialDetail association; alternatively, an element instance may be given
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public setInitialDetail(oInitialDetail: sap.ui.core.ID|sap.ui.core.Control): sap.m.SplitContainer;
/**
* Sets the associated {@link #getInitialMaster initialMaster}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oInitialMaster - ID of an element which becomes the new target of this initialMaster association; alternatively, an element instance may be given
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public setInitialMaster(oInitialMaster: sap.ui.core.ID|sap.ui.core.Control): sap.m.SplitContainer;
/**
* Sets a new value for property {@link #getMasterButtonText masterButtonText}.
*
* Determines the text displayed in master button, which has a default value "Navigation".
* This text is only displayed in iOS platform and the icon from the current page in detail area is
* displayed in the master button for the other platforms.
* The master button is shown/hidden depending on the orientation of the device and whether
* the master area is opened or not. SplitContainer manages the show/hide of the master button by itself
* only when the pages added to the detail area are sap.m.Page with built-in header or sap.m.Page
* with built-in header, which is wrapped by one or several sap.ui.core.mvc.View.
* Otherwise, the show/hide of master button needs to be managed by the application.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sMasterButtonText - New value for property masterButtonText
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public setMasterButtonText(sMasterButtonText: string): sap.m.SplitContainer;
/**
* Sets a new value for property {@link #getMasterButtonTooltip masterButtonTooltip}.
*
* Specifies the tooltip of the master button. If the tooltip is not specified,
* the title of the page, which is displayed is the master part, is set as tooltip to the master button.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sMasterButtonTooltip - New value for property masterButtonTooltip
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public setMasterButtonTooltip(sMasterButtonTooltip: string): sap.m.SplitContainer;
/**
* Sets a new value for property {@link #getMode mode}.
*
* Defines whether the master page will always be displayed (in portrait and landscape mode - StretchCompressMode),
* or if it should be hidden when in portrait mode (ShowHideMode). Default is ShowHideMode.
* Other possible values are Hide (Master is always hidden) and Popover (master is displayed in popover).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is ShowHideMode
.
* @param {sap.m.SplitAppMode} sMode - New value for property mode
* @returns {sap.m.SplitContainer} Reference to this
in order to allow method chaining
*/
public setMode(sMode: sap.m.SplitAppMode): sap.m.SplitContainer;
/**
* Used to make the master page visible when in ShowHideMode and the device is in portrait mode.
* @returns {sap.m.SplitContainer}
*/
public showMaster(): sap.m.SplitContainer;
/**
* Navigates to the given page inside the SplitContainer.
* The navigation is done inside the master area if the page has been added,
* otherwise, it tries to do the page navigation in the detail area.
* @param {string} sPageId - The screen to which we are navigating to. The ID or the control itself can be given.
* @param {string} sTransitionName - The type of the transition/animation to apply. This parameter can be omitted; then the default value is "slide" (horizontal movement from the right). Other options are: "fade", "flip", and "show" and the names of any registered custom transitions. None of the standard transitions is currently making use of any given transition parameters.
* @param {any} oData - This optional object can carry any payload data which should be made available to the target page. The beforeShow event on the target page will contain this data object as data property. Use case: in scenarios where the entity triggering the navigation can or should not directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data. When the transitionParameters object is used, this "data" object must also be given (either as object or as null) in order to have a proper parameter order.
* @param {any} oTransitionParameters - This optional object can contain additional information for the transition function, like the DOM element which triggered the transition or the desired transition duration. For a proper parameter order, the "data" parameter must be given when the transitionParameters parameter is used (it can be given as "null"). NOTE: It depends on the transition function how the object should be structured and which parameters are actually used to influence the transition. The "show", "slide" and "fade" transitions do not use any parameter.
* @returns {sap.m.SplitContainer}
*/
public to(sPageId: string, sTransitionName: string, oData: any, oTransitionParameters: any): sap.m.SplitContainer;
/**
* Navigates to a given detail page.
* @param {string} sPageId
* @param {string} sTransitionName - The type of the transition/animation to apply. This parameter can be omitted; then the default is "slide" (horizontal movement from the right). Other options are: "fade", "flip", and "show" and the names of any registered custom transitions. None of the standard transitions is currently making use of any given transition parameters.
* @param {any} oData - This optional object can carry any payload data which should be made available to the target page. The beforeShow event on the target page will contain this data object as data property. Use case: in scenarios where the entity triggering the navigation can or should not directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data. When the transitionParameters object is used, this data object must also be given (either as object or as null) in order to have a proper parameter order.
* @param {any} oTransitionParameter - This optional object can contain additional information for the transition function, like the DOM element, which triggered the transition or the desired transition duration. For a proper parameter order, the data parameter must be given when the transitionParameters parameter is used (it can be given as "null"). NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition. The "show", "slide" and "fade" transitions do not use any parameter.
* @returns {sap.m.SplitContainer}
*/
public toDetail(sPageId: string, sTransitionName: string, oData: any, oTransitionParameter: any): sap.m.SplitContainer;
/**
* Navigates to a given master page.
* @param {string} sPageId - The screen to which drilldown should happen. The ID or the control itself can be given.
* @param {string} sTransitionName - The type of the transition/animation to apply. This parameter can be omitted; then the default value is "slide" (horizontal movement from the right). Other options are: "fade", "flip", and "show" and the names of any registered custom transitions. None of the standard transitions is currently making use of any given transition parameters.
* @param {any} oData - Since version 1.7.1. This optional object can carry any payload data which should be made available to the target page. The beforeShow event on the target page will contain this data object as data property. Use case: in scenarios where the entity triggering the navigation can't or shouldn't directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data. When the transitionParameters object is used, this data object must also be given (either as object or as null) in order to have a proper parameter order.
* @param {any} oTransitionParameters - Since version 1.7.1. This optional object can contain additional information for the transition function, like the DOM element, which triggered the transition or the desired transition duration. For a proper parameter order, the data parameter must be given when the transitionParameters parameter is used (it can be given as "null"). NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition. The "show", "slide" and "fade" transitions do not use any parameter.
* @returns {sap.m.SplitContainer}
*/
public toMaster(sPageId: string, sTransitionName: string, oData: any, oTransitionParameters: any): sap.m.SplitContainer;
}
/**
* sap.m.StandardListItem
is a list item providing the most common use cases, e.g. image, title and description.
*/
export class StandardListItem extends sap.m.ListItemBase {
/**
* Constructor for a new StandardListItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.StandardListItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ListItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getActiveIcon activeIcon}.
*
* Defines the icon that is shown while the list item is pressed.
* @returns {sap.ui.core.URI} Value of property activeIcon
*/
public getActiveIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getAdaptTitleSize adaptTitleSize}.
*
* By default, the title size adapts to the available space and gets bigger if the description is empty. If you have list items with and without descriptions, this results in titles with different sizes. In this case, it can be better to switch the size adaption off by setting this property to false
.
*
* Default value is true
.
* @returns {boolean} Value of property adaptTitleSize
*/
public getAdaptTitleSize(): boolean;
/**
* Gets current value of property {@link #getDescription description}.
*
* Defines the additional information for the title.
* Note: This is only visible when the title
property is not empty.
* @returns {string} Value of property description
*/
public getDescription(): string;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Defines the list item icon.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconDensityAware iconDensityAware}.
*
* By default, one or more requests are sent to get the density perfect version of the icon if the given version of the icon doesn't exist on the server.
* Note: If bandwidth is a key factor for the application, set this value to false
.
*
* Default value is true
.
* @returns {boolean} Value of property iconDensityAware
*/
public getIconDensityAware(): boolean;
/**
* Gets current value of property {@link #getIconInset iconInset}.
*
* Defines the indentation of the icon. If set to false
, the icon will not be shown as embedded. Instead it will take the full height of the list item.
*
* Default value is true
.
* @returns {boolean} Value of property iconInset
*/
public getIconInset(): boolean;
/**
* Gets current value of property {@link #getInfo info}.
*
* Defines an additional information text.
* @returns {string} Value of property info
*/
public getInfo(): string;
/**
* Gets current value of property {@link #getInfoState infoState}.
*
* Defines the state of the information text, e.g. Error
, Warning
, Success
.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property infoState
*/
public getInfoState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getInfoTextDirection infoTextDirection}.
*
* Defines the info
directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property infoTextDirection
*/
public getInfoTextDirection(): sap.ui.core.TextDirection;
/**
* Returns a metadata object for class sap.m.StandardListItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTitle title}.
*
* Defines the title of the list item.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getTitleTextDirection titleTextDirection}.
*
* Defines the title
text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property titleTextDirection
*/
public getTitleTextDirection(): sap.ui.core.TextDirection;
/**
* Sets a new value for property {@link #getActiveIcon activeIcon}.
*
* Defines the icon that is shown while the list item is pressed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sActiveIcon - New value for property activeIcon
* @returns {sap.m.StandardListItem} Reference to this
in order to allow method chaining
*/
public setActiveIcon(sActiveIcon: sap.ui.core.URI): sap.m.StandardListItem;
/**
* Sets a new value for property {@link #getAdaptTitleSize adaptTitleSize}.
*
* By default, the title size adapts to the available space and gets bigger if the description is empty. If you have list items with and without descriptions, this results in titles with different sizes. In this case, it can be better to switch the size adaption off by setting this property to false
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bAdaptTitleSize - New value for property adaptTitleSize
* @returns {sap.m.StandardListItem} Reference to this
in order to allow method chaining
*/
public setAdaptTitleSize(bAdaptTitleSize: boolean): sap.m.StandardListItem;
/**
* Sets a new value for property {@link #getDescription description}.
*
* Defines the additional information for the title.
* Note: This is only visible when the title
property is not empty.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sDescription - New value for property description
* @returns {sap.m.StandardListItem} Reference to this
in order to allow method chaining
*/
public setDescription(sDescription: string): sap.m.StandardListItem;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Defines the list item icon.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.StandardListItem} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.StandardListItem;
/**
* Sets a new value for property {@link #getIconDensityAware iconDensityAware}.
*
* By default, one or more requests are sent to get the density perfect version of the icon if the given version of the icon doesn't exist on the server.
* Note: If bandwidth is a key factor for the application, set this value to false
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconDensityAware - New value for property iconDensityAware
* @returns {sap.m.StandardListItem} Reference to this
in order to allow method chaining
*/
public setIconDensityAware(bIconDensityAware: boolean): sap.m.StandardListItem;
/**
* Sets a new value for property {@link #getIconInset iconInset}.
*
* Defines the indentation of the icon. If set to false
, the icon will not be shown as embedded. Instead it will take the full height of the list item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconInset - New value for property iconInset
* @returns {sap.m.StandardListItem} Reference to this
in order to allow method chaining
*/
public setIconInset(bIconInset: boolean): sap.m.StandardListItem;
/**
* Sets a new value for property {@link #getInfo info}.
*
* Defines an additional information text.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sInfo - New value for property info
* @returns {sap.m.StandardListItem} Reference to this
in order to allow method chaining
*/
public setInfo(sInfo: string): sap.m.StandardListItem;
/**
* Sets a new value for property {@link #getInfoState infoState}.
*
* Defines the state of the information text, e.g. Error
, Warning
, Success
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sInfoState - New value for property infoState
* @returns {sap.m.StandardListItem} Reference to this
in order to allow method chaining
*/
public setInfoState(sInfoState: sap.ui.core.ValueState): sap.m.StandardListItem;
/**
* Sets a new value for property {@link #getInfoTextDirection infoTextDirection}.
*
* Defines the info
directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sInfoTextDirection - New value for property infoTextDirection
* @returns {sap.m.StandardListItem} Reference to this
in order to allow method chaining
*/
public setInfoTextDirection(sInfoTextDirection: sap.ui.core.TextDirection): sap.m.StandardListItem;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Defines the title of the list item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.StandardListItem} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.StandardListItem;
/**
* Sets a new value for property {@link #getTitleTextDirection titleTextDirection}.
*
* Defines the title
text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTitleTextDirection - New value for property titleTextDirection
* @returns {sap.m.StandardListItem} Reference to this
in order to allow method chaining
*/
public setTitleTextDirection(sTitleTextDirection: sap.ui.core.TextDirection): sap.m.StandardListItem;
}
/**
* The StandardTile control is displayed in the tile container.
*/
export class StandardTile extends sap.m.Tile {
/**
* Constructor for a new StandardTile.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.StandardTile} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.StandardTile;
/**
* Creates a new subclass of class sap.m.StandardTile with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.Tile.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getActiveIcon activeIcon}.
*
* Defines the active icon of the StandardTile.
* @returns {sap.ui.core.URI} Value of property activeIcon
*/
public getActiveIcon(): sap.ui.core.URI;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Gets the icon of the StandardTile control.
* @returns {any}
*/
public getIcon(): any;
/**
* Gets current value of property {@link #getIconDensityAware iconDensityAware}.
*
* By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
*
* If bandwidth is key for the application, set this value to false.
*
* Default value is true
.
* @returns {boolean} Value of property iconDensityAware
*/
public getIconDensityAware(): boolean;
/**
* Gets current value of property {@link #getInfo info}.
*
* Defines the description of the StandardTile.
* @returns {string} Value of property info
*/
public getInfo(): string;
/**
* Gets current value of property {@link #getInfoState infoState}.
*
* Defines the color of the info text. Possible values are Error, Warning, Success and so on.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property infoState
*/
public getInfoState(): sap.ui.core.ValueState;
/**
* Returns a metadata object for class sap.m.StandardTile.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getNumber number}.
*
* Defines the number field of the StandardTile.
* @returns {string} Value of property number
*/
public getNumber(): string;
/**
* Gets current value of property {@link #getNumberUnit numberUnit}.
*
* Defines the number units qualifier of the StandardTile.
* @returns {string} Value of property numberUnit
*/
public getNumberUnit(): string;
/**
* Gets current value of property {@link #getTitle title}.
*
* Defines the title of the StandardTile.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getType type}.
*
* Defines the type of the StandardTile.
*
* Default value is None
.
* @returns {sap.m.StandardTileType} Value of property type
*/
public getType(): sap.m.StandardTileType;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getActiveIcon activeIcon}.
*
* Defines the active icon of the StandardTile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sActiveIcon - New value for property activeIcon
* @returns {sap.m.StandardTile} Reference to this
in order to allow method chaining
*/
public setActiveIcon(sActiveIcon: sap.ui.core.URI): sap.m.StandardTile;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Defines the icon of the StandardTile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.StandardTile} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.StandardTile;
/**
* Sets a new value for property {@link #getIconDensityAware iconDensityAware}.
*
* By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
*
* If bandwidth is key for the application, set this value to false.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconDensityAware - New value for property iconDensityAware
* @returns {sap.m.StandardTile} Reference to this
in order to allow method chaining
*/
public setIconDensityAware(bIconDensityAware: boolean): sap.m.StandardTile;
/**
* Sets a new value for property {@link #getInfo info}.
*
* Defines the description of the StandardTile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sInfo - New value for property info
* @returns {sap.m.StandardTile} Reference to this
in order to allow method chaining
*/
public setInfo(sInfo: string): sap.m.StandardTile;
/**
* Sets a new value for property {@link #getInfoState infoState}.
*
* Defines the color of the info text. Possible values are Error, Warning, Success and so on.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sInfoState - New value for property infoState
* @returns {sap.m.StandardTile} Reference to this
in order to allow method chaining
*/
public setInfoState(sInfoState: sap.ui.core.ValueState): sap.m.StandardTile;
/**
* Sets a new value for property {@link #getNumber number}.
*
* Defines the number field of the StandardTile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sNumber - New value for property number
* @returns {sap.m.StandardTile} Reference to this
in order to allow method chaining
*/
public setNumber(sNumber: string): sap.m.StandardTile;
/**
* Sets a new value for property {@link #getNumberUnit numberUnit}.
*
* Defines the number units qualifier of the StandardTile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sNumberUnit - New value for property numberUnit
* @returns {sap.m.StandardTile} Reference to this
in order to allow method chaining
*/
public setNumberUnit(sNumberUnit: string): sap.m.StandardTile;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Defines the title of the StandardTile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.StandardTile} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.StandardTile;
/**
* Sets a new value for property {@link #getType type}.
*
* Defines the type of the StandardTile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.m.StandardTileType} sType - New value for property type
* @returns {sap.m.StandardTile} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.m.StandardTileType): sap.m.StandardTile;
}
/**
* Types for StandardTile
*/
export enum StandardTileType {
/**
* Tile representing that something needs to be created
*/
Create = "Create",
/**
* Monitor tile
*/
Monitor = "Monitor",
/**
* Default type
*/
None = "None",
}
/**
* The sap.m.StandardTreeItem
is a tree item providing a title, image, etc.
*/
export class StandardTreeItem extends sap.m.TreeItemBase {
/**
* Constructor for a new StandardTreeItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.StandardTreeItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.TreeItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Defines the tree item icon.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.m.StandardTreeItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTitle title}.
*
* Defines the title of the item.
*
* Default value is
.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Defines the tree item icon.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.StandardTreeItem} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.StandardTreeItem;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Defines the title of the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sTitle - New value for property title
* @returns {sap.m.StandardTreeItem} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.StandardTreeItem;
}
/**
* The StepInput
control allows the user to change the input values with predefined increments (steps).
*/
export class StepInput extends sap.ui.core.Control {
/**
* Constructor for a new StepInput.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.StepInput;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.StepInput;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.StepInput
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.StepInput
itself.
*
* Is fired when one of the following happens:
*
* - the text in the input has changed and the focus leaves the input field or the enter key
* is pressed.
* - One of the decrement or increment buttons is pressed
*
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.StepInput
itself
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.m.StepInput;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.StepInput
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.StepInput
itself.
*
* Is fired when one of the following happens:
*
* - the text in the input has changed and the focus leaves the input field or the enter key
* is pressed.
* - One of the decrement or increment buttons is pressed
*
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.StepInput
itself
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.m.StepInput;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.m.StepInput
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.m.StepInput;
/**
* Creates a new subclass of class sap.m.StepInput with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.m.StepInput;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getDisplayValuePrecision displayValuePrecision}.
*
* Determines the number of digits after the decimal point.
*
* The value should be between 0 (default) and 20.
* In case the value is not valid it will be set to the default value.
*
* Default value is 0
.
* @returns {number} Value of property displayValuePrecision
*/
public getDisplayValuePrecision(): number;
/**
* Gets current value of property {@link #getEditable editable}.
*
* Defines whether the control can be modified by the user or not.
* Note: A user can tab to the non-editable control, highlight it, and copy the text from it.
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Indicates whether the user can interact with the control or not.
* Note: Disabled controls cannot be focused and they are out of the tab-chain.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getLargerStep largerStep}.
*
* Increases/decreases the value with a larger value than the set step only when using the PageUp/PageDown keys.
* Default value is 2 times larger than the set step.
*
* Default value is 2
.
* @returns {number} Value of property largerStep
*/
public getLargerStep(): number;
/**
* Gets current value of property {@link #getMax max}.
*
* Sets the maximum possible value of the defined range.
* @returns {number} Value of property max
*/
public getMax(): number;
/**
* Returns a metadata object for class sap.m.StepInput.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMin min}.
*
* Sets the minimum possible value of the defined range.
* @returns {number} Value of property min
*/
public getMin(): number;
/**
* Gets current value of property {@link #getName name}.
*
* Defines the name of the control for the purposes of form submission.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets current value of property {@link #getPlaceholder placeholder}.
*
* Defines a short hint intended to aid the user with data entry when the control has no value.
* @returns {string} Value of property placeholder
*/
public getPlaceholder(): string;
/**
* Gets current value of property {@link #getRequired required}.
*
* Indicates that user input is required. This property is only needed for accessibility purposes when a single relationship between
* the field and a label (see aggregation labelFor
of sap.m.Label
) cannot be established
* (e.g. one label should label multiple fields).
*
* Default value is false
.
* @returns {boolean} Value of property required
*/
public getRequired(): boolean;
/**
* Gets current value of property {@link #getStep step}.
*
* Increases/decreases the value of the input.
* Note: - The value of the
step
property should not contain more digits after the decimal point than what is set to the displayValuePrecision
property, as it may lead to an increase/decrease that is not visible for the user. For example, if the value
is set to 1.22 and the displayValuePrecision
is set to one digit after the decimal, the user will see 1.2. In this case, if the the value
of the step
property is set to 1.005 and the user selects increase
, the resulting value will increase to 1.2261 but the displayed value will remain as 1.2 as it will be rounded to the first digit after the decimal point. - Depending on what is set for the
value
and the displayValuePrecision
properties, it is possible the displayed value to be rounded to a higher number, for example to 3.0 when the actual value is 2.99.
*
* Default value is 1
.
* @returns {number} Value of property step
*/
public getStep(): number;
/**
* Gets current value of property {@link #getValue value}.
*
* Determines the value of the StepInput
and can be set initially from the app developer.
*
* Default value is 0
.
* @returns {number} Value of property value
*/
public getValue(): number;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Accepts the core enumeration ValueState.type that supports None
, Error
, Warning
and Success
.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Getter for property valueStateText
.
* The text which is shown in the value state message popup.
*
* Default value is empty/undefined
* @returns {string} the value of property valueStateText
*/
public getValueStateText(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the control.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getDisplayValuePrecision displayValuePrecision}.
*
* Determines the number of digits after the decimal point.
*
* The value should be between 0 (default) and 20.
* In case the value is not valid it will be set to the default value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iDisplayValuePrecision - New value for property displayValuePrecision
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public setDisplayValuePrecision(iDisplayValuePrecision: number): sap.m.StepInput;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Defines whether the control can be modified by the user or not.
* Note: A user can tab to the non-editable control, highlight it, and copy the text from it.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.m.StepInput;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Indicates whether the user can interact with the control or not.
* Note: Disabled controls cannot be focused and they are out of the tab-chain.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.StepInput;
/**
* Sets a new value for property {@link #getLargerStep largerStep}.
*
* Increases/decreases the value with a larger value than the set step only when using the PageUp/PageDown keys.
* Default value is 2 times larger than the set step.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 2
.
* @param {number} fLargerStep - New value for property largerStep
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public setLargerStep(fLargerStep: number): sap.m.StepInput;
/**
* Sets a new value for property {@link #getMax max}.
*
* Sets the maximum possible value of the defined range.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} fMax - New value for property max
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public setMax(fMax: number): sap.m.StepInput;
/**
* Sets a new value for property {@link #getMin min}.
*
* Sets the minimum possible value of the defined range.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} fMin - New value for property min
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public setMin(fMin: number): sap.m.StepInput;
/**
* Sets a new value for property {@link #getName name}.
*
* Defines the name of the control for the purposes of form submission.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.m.StepInput;
/**
* Sets a new value for property {@link #getPlaceholder placeholder}.
*
* Defines a short hint intended to aid the user with data entry when the control has no value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sPlaceholder - New value for property placeholder
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public setPlaceholder(sPlaceholder: string): sap.m.StepInput;
/**
* Sets a new value for property {@link #getRequired required}.
*
* Indicates that user input is required. This property is only needed for accessibility purposes when a single relationship between
* the field and a label (see aggregation labelFor
of sap.m.Label
) cannot be established
* (e.g. one label should label multiple fields).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bRequired - New value for property required
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public setRequired(bRequired: boolean): sap.m.StepInput;
/**
* Sets a new value for property {@link #getStep step}.
*
* Increases/decreases the value of the input.
* Note: - The value of the
step
property should not contain more digits after the decimal point than what is set to the displayValuePrecision
property, as it may lead to an increase/decrease that is not visible for the user. For example, if the value
is set to 1.22 and the displayValuePrecision
is set to one digit after the decimal, the user will see 1.2. In this case, if the the value
of the step
property is set to 1.005 and the user selects increase
, the resulting value will increase to 1.2261 but the displayed value will remain as 1.2 as it will be rounded to the first digit after the decimal point. - Depending on what is set for the
value
and the displayValuePrecision
properties, it is possible the displayed value to be rounded to a higher number, for example to 3.0 when the actual value is 2.99.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} fStep - New value for property step
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public setStep(fStep: number): sap.m.StepInput;
/**
* Sets a new value for property {@link #getValue value}.
*
* Determines the value of the StepInput
and can be set initially from the app developer.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} fValue - New value for property value
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public setValue(fValue: number): sap.m.StepInput;
/**
* Sets a new value for property {@link #getValueState valueState}.
*
* Accepts the core enumeration ValueState.type that supports None
, Error
, Warning
and Success
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sValueState - New value for property valueState
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public setValueState(sValueState: sap.ui.core.ValueState): sap.m.StepInput;
/**
* Setter for property valueStateText
.
*
* Default value is empty/undefined
.
* @param {string} sText - New value for property valueStateText
.
* @returns {sap.m.StepInput} this
to allow method chaining
*/
public setValueStateText(sText: string): sap.m.StepInput;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.StepInput} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.StepInput;
}
/**
* Types of string filter operators.
*/
export enum StringFilterOperator {
/**
* Checks if any word in the text starts with the search string.
*/
AnyWordStartsWith = "AnyWordStartsWith",
/**
* Checks if the text contains the search string.
*/
Contains = "Contains",
/**
* Checks if the text is equal with the search string.
*/
Equals = "Equals",
/**
* Checks if the text starts with the search string.
*/
StartsWith = "StartsWith",
}
/**
* Display suggestion list items.
*/
export class SuggestionItem extends sap.ui.core.Item {
/**
* Constructor for a new SuggestionItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.SuggestionItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getDescription description}.
*
* Additional text of type string, optionally to be displayed along with this item.
*
* Default value is
.
* @returns {string} Value of property description
*/
public getDescription(): string;
/**
* Gets current value of property {@link #getIcon icon}.
*
* The icon belonging to this list item instance.
* This can be a URI to an image or an icon font URI.
*
* Default value is
.
* @returns {string} Value of property icon
*/
public getIcon(): string;
/**
* Returns a metadata object for class sap.m.SuggestionItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Return suggestion text. By default, it is the value of the text
property.
*
* Subclasses may override this function.
* @returns {string} suggestion text.
*/
protected getSuggestionText(): string;
/**
* Produces the HTML of the suggestion item and writes it to render-output-buffer.
*
* Subclasses may override this function.
* @param {sap.ui.core.RenderManager} oRenderManager - The RenderManager
* @param {sap.m.SuggestionItem} oItem - The item which should be rendered
* @param {string} sSearch - The search text that should be emphasized
* @param {boolean} bSelected - The item is selected
*/
protected render(oRenderManager: sap.ui.core.RenderManager, oItem: sap.m.SuggestionItem, sSearch: string, bSelected: boolean): void;
/**
* Sets a new value for property {@link #getDescription description}.
*
* Additional text of type string, optionally to be displayed along with this item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sDescription - New value for property description
* @returns {sap.m.SuggestionItem} Reference to this
in order to allow method chaining
*/
public setDescription(sDescription: string): sap.m.SuggestionItem;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* The icon belonging to this list item instance.
* This can be a URI to an image or an icon font URI.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sIcon - New value for property icon
* @returns {sap.m.SuggestionItem} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: string): sap.m.SuggestionItem;
}
/**
* Directions for swipe event.
*/
export enum SwipeDirection {
/**
* Both directions (left to right or right to left)
*/
Both = "Both",
/**
* Swipe from left to right
*/
LeftToRight = "LeftToRight",
/**
* Swipe from right to left.
*/
RightToLeft = "RightToLeft",
}
/**
* A switch is a user interface control on mobile devices that is used for change between binary states. The user can also drag the button handle or tap to change the state.
*/
export class Switch extends sap.ui.core.Control {
/**
* Constructor for a new Switch.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.Switch} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Switch;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.Switch
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Switch
itself.
*
* Triggered when a switch changes the state.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Switch
itself
* @returns {sap.m.Switch} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.m.Switch;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.Switch
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Switch
itself.
*
* Triggered when a switch changes the state.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Switch
itself
* @returns {sap.m.Switch} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.m.Switch;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.m.Switch
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Switch} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.m.Switch;
/**
* Creates a new subclass of class sap.m.Switch with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Switch} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.m.Switch;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getCustomTextOff customTextOff}.
*
* Custom text for the "OFF" state.
*
* "OFF" translated to the current language is the default value.
* Beware that the given text will be cut off if available space is exceeded.
*
* Default value is
.
* @returns {string} Value of property customTextOff
*/
public getCustomTextOff(): string;
/**
* Gets current value of property {@link #getCustomTextOn customTextOn}.
*
* Custom text for the "ON" state.
*
* "ON" translated to the current language is the default value.
* Beware that the given text will be cut off if available space is exceeded.
*
* Default value is
.
* @returns {string} Value of property customTextOn
*/
public getCustomTextOn(): string;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Whether the switch is enabled.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Returns a metadata object for class sap.m.Switch.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* The name to be used in the HTML code for the switch (e.g. for HTML forms that send data to the server via submit).
*
* Default value is
.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets current value of property {@link #getState state}.
*
* A boolean value indicating whether the switch is on or off.
*
* Default value is false
.
* @returns {boolean} Value of property state
*/
public getState(): boolean;
/**
* Gets current value of property {@link #getType type}.
*
* Type of a Switch. Possibles values "Default", "AcceptReject".
*
* Default value is Default
.
* @returns {sap.m.SwitchType} Value of property type
*/
public getType(): sap.m.SwitchType;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getCustomTextOff customTextOff}.
*
* Custom text for the "OFF" state.
*
* "OFF" translated to the current language is the default value.
* Beware that the given text will be cut off if available space is exceeded.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sCustomTextOff - New value for property customTextOff
* @returns {sap.m.Switch} Reference to this
in order to allow method chaining
*/
public setCustomTextOff(sCustomTextOff: string): sap.m.Switch;
/**
* Sets a new value for property {@link #getCustomTextOn customTextOn}.
*
* Custom text for the "ON" state.
*
* "ON" translated to the current language is the default value.
* Beware that the given text will be cut off if available space is exceeded.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sCustomTextOn - New value for property customTextOn
* @returns {sap.m.Switch} Reference to this
in order to allow method chaining
*/
public setCustomTextOn(sCustomTextOn: string): sap.m.Switch;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Whether the switch is enabled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.Switch} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.Switch;
/**
* Sets a new value for property {@link #getName name}.
*
* The name to be used in the HTML code for the switch (e.g. for HTML forms that send data to the server via submit).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sName - New value for property name
* @returns {sap.m.Switch} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.m.Switch;
/**
* Change the switch state between on and off.
* @param {boolean} bState
* @returns {sap.m.Switch} this
to allow method chaining.
*/
public setState(bState: boolean): sap.m.Switch;
/**
* Sets a new value for property {@link #getType type}.
*
* Type of a Switch. Possibles values "Default", "AcceptReject".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Default
.
* @param {sap.m.SwitchType} sType - New value for property type
* @returns {sap.m.Switch} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.m.SwitchType): sap.m.Switch;
}
/**
* Enumaration for different switch types.
*/
export enum SwitchType {
/**
* Switch with accept and reject icons
*/
AcceptReject = "AcceptReject",
/**
* Will show "ON" and "OFF" translated to the current language or the custom text if provided
*/
Default = "Default",
}
/**
* The TabContainer
control represents a collection of tabs with associated content.
*
* The TabContainer
is a full-page container that takes 100% of the parent width and height.
* As the control is expected to occupy the the whole parent, it should be the only child of its parent.
*/
export class TabContainer extends sap.ui.core.Control {
/**
* Constructor for a new TabContainer
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.m.TabContainerItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.m.TabContainerItem): sap.m.TabContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:addNewButtonPress addNewButtonPress} event of this sap.m.TabContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TabContainer
itself.
*
* Fired when Add New Tab
button is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TabContainer
itself
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public attachAddNewButtonPress(fnFunction: Function, oListener?: any): sap.m.TabContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:addNewButtonPress addNewButtonPress} event of this sap.m.TabContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TabContainer
itself.
*
* Fired when Add New Tab
button is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TabContainer
itself
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public attachAddNewButtonPress(oData: any, fnFunction: Function, oListener?: any): sap.m.TabContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:itemClose itemClose} event of this sap.m.TabContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TabContainer
itself.
*
* Fired when an item is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TabContainer
itself
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public attachItemClose(fnFunction: Function, oListener?: any): sap.m.TabContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:itemClose itemClose} event of this sap.m.TabContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TabContainer
itself.
*
* Fired when an item is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TabContainer
itself
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public attachItemClose(oData: any, fnFunction: Function, oListener?: any): sap.m.TabContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelect itemSelect} event of this sap.m.TabContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TabContainer
itself.
*
* Fired when an item is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TabContainer
itself
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public attachItemSelect(fnFunction: Function, oListener?: any): sap.m.TabContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelect itemSelect} event of this sap.m.TabContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TabContainer
itself.
*
* Fired when an item is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TabContainer
itself
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public attachItemSelect(oData: any, fnFunction: Function, oListener?: any): sap.m.TabContainer;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.m.TabContainer;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.TabContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:addNewButtonPress addNewButtonPress} event of this sap.m.TabContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public detachAddNewButtonPress(fnFunction: Function, oListener: any): sap.m.TabContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:itemClose itemClose} event of this sap.m.TabContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public detachItemClose(fnFunction: Function, oListener: any): sap.m.TabContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:itemSelect itemSelect} event of this sap.m.TabContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public detachItemSelect(fnFunction: Function, oListener: any): sap.m.TabContainer;
/**
* Creates a new subclass of class sap.m.TabContainer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:addNewButtonPress addNewButtonPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
protected fireAddNewButtonPress(mParameters?: any): sap.m.TabContainer;
/**
* Fires event {@link #event:itemClose itemClose} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireItemClose(mParameters?: any): boolean;
/**
* Fires event {@link #event:itemSelect itemSelect} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireItemSelect(mParameters?: any): boolean;
/**
* Gets content of aggregation {@link #getItems items}.
*
* The items displayed in the TabContainer
.
* @returns {sap.m.TabContainerItem[]}
*/
public getItems(): sap.m.TabContainerItem[];
/**
* Returns a metadata object for class sap.m.TabContainer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* ID of the element which is the current target of the association {@link #getSelectedItem selectedItem}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedItem(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getShowAddNewButton showAddNewButton}.
*
* Defines whether an Add New Tab
button is displayed in the TabStrip.
*
* Default value is false
.
* @returns {boolean} Value of property showAddNewButton
*/
public getShowAddNewButton(): boolean;
/**
* Checks for the provided sap.m.TabContainerItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.TabContainerItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.m.TabContainerItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.m.TabContainerItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.m.TabContainerItem, iIndex: number): sap.m.TabContainer;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.TabContainerItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.m.TabContainerItem[];
/**
* Removes an item from the aggregation named items
.
* @param {number|string|sap.m.TabContainerItem} vItem - The item to remove or its index or ID
* @returns {sap.m.TabContainerItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.m.TabContainerItem): sap.m.TabContainerItem;
/**
* Sets the associated {@link #getSelectedItem selectedItem}.
* @param {sap.ui.core.ID|sap.m.TabContainerItem} oSelectedItem - ID of an element which becomes the new target of this selectedItem association; alternatively, an element instance may be given
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public setSelectedItem(oSelectedItem: sap.ui.core.ID|sap.m.TabContainerItem): sap.m.TabContainer;
/**
* Sets a new value for property {@link #getShowAddNewButton showAddNewButton}.
*
* Defines whether an Add New Tab
button is displayed in the TabStrip.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowAddNewButton - New value for property showAddNewButton
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public setShowAddNewButton(bShowAddNewButton: boolean): sap.m.TabContainer;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.m.TabContainer} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.m.TabContainer;
}
/**
* An item to be used in a TabContainer.
*/
export class TabContainerItem extends sap.ui.core.Element {
/**
* Constructor for a new TabContainerItem
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.TabContainerItem} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.TabContainerItem;
/**
* Attaches event handler fnFunction
to the {@link #event:itemPropertyChanged itemPropertyChanged} event of this sap.m.TabContainerItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TabContainerItem
itself.
*
* Sends information that some of the properties have changed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TabContainerItem
itself
* @returns {sap.m.TabContainerItem} Reference to this
in order to allow method chaining
*/
public attachItemPropertyChanged(fnFunction: Function, oListener?: any): sap.m.TabContainerItem;
/**
* Attaches event handler fnFunction
to the {@link #event:itemPropertyChanged itemPropertyChanged} event of this sap.m.TabContainerItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TabContainerItem
itself.
*
* Sends information that some of the properties have changed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TabContainerItem
itself
* @returns {sap.m.TabContainerItem} Reference to this
in order to allow method chaining
*/
public attachItemPropertyChanged(oData: any, fnFunction: Function, oListener?: any): sap.m.TabContainerItem;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.TabContainerItem} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.TabContainerItem;
/**
* Detaches event handler fnFunction
from the {@link #event:itemPropertyChanged itemPropertyChanged} event of this sap.m.TabContainerItem
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.TabContainerItem} Reference to this
in order to allow method chaining
*/
public detachItemPropertyChanged(fnFunction: Function, oListener: any): sap.m.TabContainerItem;
/**
* Creates a new subclass of class sap.m.TabContainerItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:itemPropertyChanged itemPropertyChanged} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.TabContainerItem} Reference to this
in order to allow method chaining
*/
protected fireItemPropertyChanged(mParameters?: any): sap.m.TabContainerItem;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content displayed for this item.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getKey key}.
*
* Determines the name of the item. Can be used as input for subsequent actions.
* @returns {string} Value of property key
*/
public getKey(): string;
/**
* Returns a metadata object for class sap.m.TabContainerItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getModified modified}.
*
* Shows if a control is edited (default is false). Items that are marked as modified have a * symbol to indicate that they haven't been saved.
*
* Default value is false
.
* @returns {boolean} Value of property modified
*/
public getModified(): boolean;
/**
* Gets current value of property {@link #getName name}.
*
* Determines the text to be displayed for the item.
*
* Default value is
.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.TabContainerItem} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.TabContainerItem;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getKey key}.
*
* Determines the name of the item. Can be used as input for subsequent actions.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sKey - New value for property key
* @returns {sap.m.TabContainerItem} Reference to this
in order to allow method chaining
*/
public setKey(sKey: string): sap.m.TabContainerItem;
/**
* Sets a new value for property {@link #getModified modified}.
*
* Shows if a control is edited (default is false). Items that are marked as modified have a * symbol to indicate that they haven't been saved.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bModified - New value for property modified
* @returns {sap.m.TabContainerItem} Reference to this
in order to allow method chaining
*/
public setModified(bModified: boolean): sap.m.TabContainerItem;
/**
* Sets a new value for property {@link #getName name}.
*
* Determines the text to be displayed for the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sName - New value for property name
* @returns {sap.m.TabContainerItem} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.m.TabContainerItem;
/**
* Overwrites the method in order to suppress invalidation for some properties.
* @param {string} sName - Property name to be set
* @param {boolean|string|any} vValue - Property value to be set
* @param {boolean} bSuppressInvalidation - Whether invalidation to be suppressed
* @returns {sap.m.TabContainerItem} This instance for chaining
*/
public setProperty(sName: string, vValue: boolean|string|any, bSuppressInvalidation: boolean): sap.m.TabContainerItem;
}
/**
* sap.m.Table
control provides a set of sophisticated and convenience functions for responsive table design.
* To render the sap.m.Table
properly, the order of the columns
aggregation should match with the order of the items cells
aggregation. Also sap.m.Table
requires at least one visible sap.m.Column
in columns
aggregation.
* For mobile devices, the recommended limit of table rows is 100 (based on 4 columns) to assure proper performance. To improve initial rendering on large tables, use the growing
feature.
*/
export class Table extends sap.m.ListBase {
/**
* Constructor for a new Table.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some column to the aggregation {@link #getColumns columns}.
* @param {sap.m.Column} oColumn - the column to add; if empty, nothing is inserted
* @returns {sap.m.Table} Reference to this
in order to allow method chaining
*/
public addColumn(oColumn: sap.m.Column): sap.m.Table;
/**
* Destroys all the columns in the aggregation {@link #getColumns columns}.
* @returns {sap.m.Table} Reference to this
in order to allow method chaining
*/
public destroyColumns(): sap.m.Table;
/**
* Creates a new subclass of class sap.m.Table with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ListBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getBackgroundDesign backgroundDesign}.
*
* Sets the background style of the table. Depending on the theme, you can change the state of the background from Solid
to Translucent
or to Transparent
.
*
* Default value is Translucent
.
* @returns {sap.m.BackgroundDesign} Value of property backgroundDesign
*/
public getBackgroundDesign(): sap.m.BackgroundDesign;
/**
* Getter for aggregation columns.
* @param {boolean} bSort - set true to get the columns in an order that respects personalization settings
* @returns {sap.m.Column[]} columns of the Table
*/
public getColumns(bSort?: boolean): sap.m.Column[];
/**
* Gets current value of property {@link #getFixedLayout fixedLayout}.
*
* Defines the algorithm to be used to layout the table cells, rows, and columns.
* By default, a table is rendered with fixed layout algorithm. This means the horizontal layout only depends on the table's width and the width of the columns, not the contents of the cells. Cells in subsequent rows do not affect column widths. This allows a browser to layout the table faster than the auto table layout since the browser can begin to display the table once the first row has been analyzed.
*
* When this property is set to false
, sap.m.Table
is rendered with auto layout algorithm. This means, the width of the table and its cells depends on the contents of the cells. The column width is set by the widest unbreakable content inside the cells. This can make the rendering slow, since the browser needs to read through all the content in the table before determining the final layout.
* Note: Since sap.m.Table
does not have its own scrollbars, setting fixedLayout
to false can force the table to overflow, which may cause visual problems. It is suggested to use this property when a table has a few columns in wide screens or within the horizontal scroll container (e.g sap.m.Dialog
) to handle overflow.
* In auto layout mode the width
property of sap.m.Column
is taken into account as a minimum width.
*
* Default value is true
.
* @returns {boolean} Value of property fixedLayout
*/
public getFixedLayout(): boolean;
/**
* Returns a metadata object for class sap.m.Table.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowOverlay showOverlay}.
*
* Setting this property to true
will show an overlay on top of the table content and prevents the user interaction with it.
*
* Default value is false
.
* @returns {boolean} Value of property showOverlay
*/
public getShowOverlay(): boolean;
/**
* Checks for the provided sap.m.Column
in the aggregation {@link #getColumns columns}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Column} oColumn - The column whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfColumn(oColumn: sap.m.Column): number;
/**
* Inserts a column into the aggregation {@link #getColumns columns}.
* @param {sap.m.Column} oColumn - the column to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the column should be inserted at; for a negative value of iIndex
, the column is inserted at position 0; for a value greater than the current size of the aggregation, the column is inserted at the last position
* @returns {sap.m.Table} Reference to this
in order to allow method chaining
*/
public insertColumn(oColumn: sap.m.Column, iIndex: number): sap.m.Table;
/**
* Removes all the controls from the aggregation {@link #getColumns columns}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Column[]} An array of the removed elements (might be empty)
*/
public removeAllColumns(): sap.m.Column[];
/**
* Removes a column from the aggregation {@link #getColumns columns}.
* @param {number|string|sap.m.Column} vColumn - The column to remove or its index or id
* @returns {sap.m.Column} The removed column or null
*/
public removeColumn(vColumn: number|string|sap.m.Column): sap.m.Column;
/**
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
*
* Sets the background style of the table. Depending on the theme, you can change the state of the background from Solid
to Translucent
or to Transparent
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Translucent
.
* @param {sap.m.BackgroundDesign} sBackgroundDesign - New value for property backgroundDesign
* @returns {sap.m.Table} Reference to this
in order to allow method chaining
*/
public setBackgroundDesign(sBackgroundDesign: sap.m.BackgroundDesign): sap.m.Table;
/**
* Sets a new value for property {@link #getFixedLayout fixedLayout}.
*
* Defines the algorithm to be used to layout the table cells, rows, and columns.
* By default, a table is rendered with fixed layout algorithm. This means the horizontal layout only depends on the table's width and the width of the columns, not the contents of the cells. Cells in subsequent rows do not affect column widths. This allows a browser to layout the table faster than the auto table layout since the browser can begin to display the table once the first row has been analyzed.
*
* When this property is set to false
, sap.m.Table
is rendered with auto layout algorithm. This means, the width of the table and its cells depends on the contents of the cells. The column width is set by the widest unbreakable content inside the cells. This can make the rendering slow, since the browser needs to read through all the content in the table before determining the final layout.
* Note: Since sap.m.Table
does not have its own scrollbars, setting fixedLayout
to false can force the table to overflow, which may cause visual problems. It is suggested to use this property when a table has a few columns in wide screens or within the horizontal scroll container (e.g sap.m.Dialog
) to handle overflow.
* In auto layout mode the width
property of sap.m.Column
is taken into account as a minimum width.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bFixedLayout - New value for property fixedLayout
* @returns {sap.m.Table} Reference to this
in order to allow method chaining
*/
public setFixedLayout(bFixedLayout: boolean): sap.m.Table;
/**
* Sets a new value for property {@link #getShowOverlay showOverlay}.
*
* Setting this property to true
will show an overlay on top of the table content and prevents the user interaction with it.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowOverlay - New value for property showOverlay
* @returns {sap.m.Table} Reference to this
in order to allow method chaining
*/
public setShowOverlay(bShowOverlay: boolean): sap.m.Table;
}
/**
* Table Personalization Controller
*/
export class TablePersoController extends sap.ui.base.ManagedObject {
/**
* The TablePersoController can be used to connect a table that you want to provide
* a personalization dialog for, with a persistence service such as one provided by
* the unified shell.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - optional id for the new control; generated automatically if no non-empty id is given Note: this can be omitted, no matter whether mSettings
will be given or not!
* @param {any} mSettings - optional map/JSON-object with initial settings for the new component instance
*/
public constructor(sId?: string, mSettings?: any);
/**
* Activates the controller, i.e. tries to retrieve existing persisted
* personalizations, creates a TablePersoDialog for the associated
* table and attaches a close handler to apply the personalizations to
* the table and persist them.
*
* This method should be called when the table to be personalized knows
* its columns. Usually, this is when that table's view has set its model,
* which is typically done in the corresponding controller's init method.
* For example
*
* onInit: function () {
*
* // set explored app's demo model on this sample
* var oModel = new JSONModel(jQuery.sap.getModulePath("sap.ui.demo.mock", "/products.json"));
* var oGroupingModel = new JSONModel({ hasGrouping: false});
* this.getView().setModel(oModel);
* this.getView().setModel(oGroupingModel, 'Grouping');
*
* // init and activate controller
* this._oTPC = new TablePersoController({
* table: this.getView().byId("productsTable"),
* //specify the first part of persistence ids e.g. 'demoApp-productsTable-dimensionsCol'
* componentName: "demoApp",
* persoService: DemoPersoService,
* }).activate();
* }
*
* @returns {sap.m.TablePersoController} the TablePersoController instance.
*/
public activate(): sap.m.TablePersoController;
/**
* Adds some table into the association {@link #getTables tables}.
* @param {sap.ui.core.ID|sap.m.Table} vTable - the tables to add; if empty, nothing is inserted
* @returns {sap.m.TablePersoController} Reference to this
in order to allow method chaining
*/
public addTable(vTable: sap.ui.core.ID|sap.m.Table): sap.m.TablePersoController;
/**
* Applies the personalizations by getting the existing personalizations
* and adjusting to the table.
* @param {sap.m.Table} oTable - the table to be personalized.
*/
public applyPersonalizations(oTable: sap.m.Table): void;
/**
* Attaches event handler fnFunction
to the {@link #event:personalizationsDone personalizationsDone} event of this sap.m.TablePersoController
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TablePersoController
itself.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TablePersoController
itself
* @returns {sap.m.TablePersoController} Reference to this
in order to allow method chaining
*/
public attachPersonalizationsDone(fnFunction: Function, oListener?: any): sap.m.TablePersoController;
/**
* Attaches event handler fnFunction
to the {@link #event:personalizationsDone personalizationsDone} event of this sap.m.TablePersoController
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TablePersoController
itself.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TablePersoController
itself
* @returns {sap.m.TablePersoController} Reference to this
in order to allow method chaining
*/
public attachPersonalizationsDone(oData: any, fnFunction: Function, oListener?: any): sap.m.TablePersoController;
/**
* Destroys the persoService in the aggregation {@link #getPersoService persoService}.
* @returns {sap.m.TablePersoController} Reference to this
in order to allow method chaining
*/
public destroyPersoService(): sap.m.TablePersoController;
/**
* Detaches event handler fnFunction
from the {@link #event:personalizationsDone personalizationsDone} event of this sap.m.TablePersoController
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.TablePersoController} Reference to this
in order to allow method chaining
*/
public detachPersonalizationsDone(fnFunction: Function, oListener: any): sap.m.TablePersoController;
/**
* Do some clean up: remove event delegates, etc
*/
protected exit(): void;
/**
* Creates a new subclass of class sap.m.TablePersoController with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:personalizationsDone personalizationsDone} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.TablePersoController} Reference to this
in order to allow method chaining
*/
protected firePersonalizationsDone(mParameters?: any): sap.m.TablePersoController;
/**
* Gets current value of property {@link #getComponentName componentName}.
*
* Available options for the text direction are LTR and RTL. By default the control inherits the text direction from its parent control.
* @returns {string} Value of property componentName
*/
public getComponentName(): string;
/**
* Gets current value of property {@link #getContentHeight contentHeight}.
*
* Default value is 20rem
.
* @returns {sap.ui.core.CSSSize} Value of property contentHeight
*/
public getContentHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getContentWidth contentWidth}.
* @returns {sap.ui.core.CSSSize} Value of property contentWidth
*/
public getContentWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getHasGrouping hasGrouping}.
*
* Default value is false
.
* @returns {boolean} Value of property hasGrouping
*/
public getHasGrouping(): boolean;
/**
* Returns a metadata object for class sap.m.TablePersoController.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getPersoService persoService}.
* @returns {Object}
*/
public getPersoService(): Object;
/**
* Gets current value of property {@link #getShowResetAll showResetAll}.
*
* Default value is true
.
* @returns {boolean} Value of property showResetAll
*/
public getShowResetAll(): boolean;
/**
* Gets current value of property {@link #getShowSelectAll showSelectAll}.
*
* Default value is true
.
* @returns {boolean} Value of property showSelectAll
*/
public getShowSelectAll(): boolean;
/**
* ID of the element which is the current target of the association {@link #getTable table}, or null
.
* @returns {sap.ui.core.ID}
*/
public getTable(): sap.ui.core.ID;
/**
* Returns a _tablePersoDialog instance if available. It can be NULL if
* the controller has not been activated yet.
*
* This function makes a private aggregate publicly accessable. This is
* necessary for downward compatibility reasons: in the first versions
* of the tablePersoProvider developers still worked with the TablePersoDialog
* directly, which is now not necessary any longer.
* @returns {sap.m.TablePersoDialog} the TablePersoDialog instance.
*/
public getTablePersoDialog(): sap.m.TablePersoDialog;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getTables tables}.
* @returns {sap.ui.core.ID[]}
*/
public getTables(): sap.ui.core.ID[];
/**
* Initializes the TablePersoController instance after creation.
*/
protected init(): void;
/**
* Opens the TablePersoDialog, stores the personalized settings on close,
* modifies the table columns, and sends them to the persistence service
*/
public openDialog(): void;
/**
* Refresh the personalizations: reloads the personalization information from the table perso
* provider, applies it to the controller's table and updates the controller's table perso dialog.
*
* Use case for a 'refresh' call would be that the table which si personalized changed its columns
* during runtime, after personalization has been activated.
*/
public refresh(): void;
/**
* Removes all the controls in the association named {@link #getTables tables}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllTables(): sap.ui.core.ID[];
/**
* Removes an table from the association named {@link #getTables tables}.
* @param {number|sap.ui.core.ID|sap.m.Table} vTable - The table to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed table or null
*/
public removeTable(vTable: number|sap.ui.core.ID|sap.m.Table): sap.ui.core.ID;
/**
* Persist the personalizations
*/
public savePersonalizations(): void;
/**
* Using this method, the first part of tablePerso persistence ids can be
* provided, in case the table's app does not provide that part itself.
*
* If a component name is set using this method, it will be used, regardless of
* whether the table's app has a different component name or not.
* @param {string} sCompName - the new component name.
* @returns {sap.m.TablePersoController} the TablePersoController instance.
*/
public setComponentName(sCompName: string): sap.m.TablePersoController;
/**
* Reflector for the controller's 'contentHeight' property.
* @param {sap.ui.core.CSSSize} sHeight - the new height of the TablePersoDialog.
* @returns {sap.m.TablePersoController} the TablePersoController instance.
*/
public setContentHeight(sHeight: sap.ui.core.CSSSize): sap.m.TablePersoController;
/**
* Reflector for the controller's 'contentWidth' property.
* @param {sap.ui.core.CSSSize} sWidth - the new width of the tablePersoDialog
* @returns {sap.m.TablePersoController} the TablePersoController instance.
*/
public setContentWidth(sWidth: sap.ui.core.CSSSize): sap.m.TablePersoController;
/**
* Reflector for the controller's 'hasGrouping' property.
* @param {boolean} bHasGrouping - is the tablePersoDialog displayed in grouping mode or not.
* @returns {sap.m.TablePersoController} the TablePersoController instance.
*/
public setHasGrouping(bHasGrouping: boolean): sap.m.TablePersoController;
/**
* Sets the aggregated {@link #getPersoService persoService}.
* @param {Object} oPersoService - The persoService to set
* @returns {sap.m.TablePersoController} Reference to this
in order to allow method chaining
*/
public setPersoService(oPersoService: Object): sap.m.TablePersoController;
/**
* Reflector for the controller's 'showResetAll' property.
* @param {boolean} bShowResetAll - is the tablePersoDialog's 'UndoPersonalization' button displayed or not.
* @returns {sap.m.TablePersoController} the TablePersoController instance.
*/
public setShowResetAll(bShowResetAll: boolean): sap.m.TablePersoController;
/**
* Reflector for the controller's 'showSelectAll' property.
* @param {boolean} bShowSelectAll - is the tablePersoDialog's 'Display All' checkbox displayed or not.
* @returns {sap.m.TablePersoController} the TablePersoController instance.
*/
public setShowSelectAll(bShowSelectAll: boolean): sap.m.TablePersoController;
/**
* Sets the associated {@link #getTable table}.
* @param {sap.ui.core.ID|sap.m.Table} oTable - ID of an element which becomes the new target of this table association; alternatively, an element instance may be given
* @returns {sap.m.TablePersoController} Reference to this
in order to allow method chaining
*/
public setTable(oTable: sap.ui.core.ID|sap.m.Table): sap.m.TablePersoController;
}
/**
* Table Personalization Dialog
*/
export class TablePersoDialog extends sap.ui.base.ManagedObject {
/**
* The TablePersoDialog can be used to display and allow modification of personalization settings relating to a Table. It displays the columns of the table that it refers to by using
* - The result of calling sap.m.TablePersoProvider's 'getCaption' callback if it is implemented and delivers a non-null value for a column
* - the column header control's 'text' property if no caption property is available
* - the column header control's 'title' property if neither 'text' nor 'caption' property are available
* - the column id is displayed as last fallback, if none of the above is at hand. In that case, a warning is logged.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - optional id for the new control; generated automatically if no non-empty id is given Note: this can be omitted, no matter whether mSettings
will be given or not!
* @param {any} mSettings - optional map/JSON-object with initial settings for the new component instance
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.m.TablePersoDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TablePersoDialog
itself.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TablePersoDialog
itself
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
public attachCancel(fnFunction: Function, oListener?: any): sap.m.TablePersoDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.m.TablePersoDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TablePersoDialog
itself.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TablePersoDialog
itself
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
public attachCancel(oData: any, fnFunction: Function, oListener?: any): sap.m.TablePersoDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:confirm confirm} event of this sap.m.TablePersoDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TablePersoDialog
itself.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TablePersoDialog
itself
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
public attachConfirm(fnFunction: Function, oListener?: any): sap.m.TablePersoDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:confirm confirm} event of this sap.m.TablePersoDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TablePersoDialog
itself.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TablePersoDialog
itself
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
public attachConfirm(oData: any, fnFunction: Function, oListener?: any): sap.m.TablePersoDialog;
/**
* Destroys the persoService in the aggregation {@link #getPersoService persoService}.
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
public destroyPersoService(): sap.m.TablePersoDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:cancel cancel} event of this sap.m.TablePersoDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
public detachCancel(fnFunction: Function, oListener: any): sap.m.TablePersoDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:confirm confirm} event of this sap.m.TablePersoDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
public detachConfirm(fnFunction: Function, oListener: any): sap.m.TablePersoDialog;
/**
* Creates a new subclass of class sap.m.TablePersoDialog with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:cancel cancel} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
protected fireCancel(mParameters?: any): sap.m.TablePersoDialog;
/**
* Fires event {@link #event:confirm confirm} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
protected fireConfirm(mParameters?: any): sap.m.TablePersoDialog;
/**
* Gets current value of property {@link #getColumnInfoCallback columnInfoCallback}.
* @returns {any} Value of property columnInfoCallback
*/
public getColumnInfoCallback(): any;
/**
* Gets current value of property {@link #getContentHeight contentHeight}.
* @returns {sap.ui.core.CSSSize} Value of property contentHeight
*/
public getContentHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getContentWidth contentWidth}.
* @returns {sap.ui.core.CSSSize} Value of property contentWidth
*/
public getContentWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getHasGrouping hasGrouping}.
* @returns {boolean} Value of property hasGrouping
*/
public getHasGrouping(): boolean;
/**
* Gets current value of property {@link #getInitialColumnState initialColumnState}.
* @returns {any} Value of property initialColumnState
*/
public getInitialColumnState(): any;
/**
* Returns a metadata object for class sap.m.TablePersoDialog.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* ID of the element which is the current target of the association {@link #getPersoDialogFor persoDialogFor}, or null
.
* @returns {sap.ui.core.ID}
*/
public getPersoDialogFor(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getPersoMap persoMap}.
* @returns {any} Value of property persoMap
*/
public getPersoMap(): any;
/**
* Gets content of aggregation {@link #getPersoService persoService}.
*
* Refers to the service for reading and writing the personalization.
* @returns {Object}
*/
public getPersoService(): Object;
/**
* Gets current value of property {@link #getShowResetAll showResetAll}.
* @returns {boolean} Value of property showResetAll
*/
public getShowResetAll(): boolean;
/**
* Gets current value of property {@link #getShowSelectAll showSelectAll}.
* @returns {boolean} Value of property showSelectAll
*/
public getShowSelectAll(): boolean;
/**
* Initializes the TablePersoDialog instance after creation.
*/
protected init(): void;
/**
* Sets the content of the dialog, being list items representing
* the associated table's column settings, and opens the dialog
*/
public open(): void;
/**
* Returns the personalizations made. Currently supports
* a 'columns' property which holds an array of settings,
* one element per column in the associated table. The element
* contains column-specific information as follows: id: column id;
* order: new order; text: the column's header text that was displayed
* in the dialog; visible: visibility (true or false).
* @returns {any} the personalization data
*/
public retrievePersonalizations(): any;
/**
* Sets a new value for property {@link #getColumnInfoCallback columnInfoCallback}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oColumnInfoCallback - New value for property columnInfoCallback
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
public setColumnInfoCallback(oColumnInfoCallback: any): sap.m.TablePersoDialog;
/**
* Sets a new value for property {@link #getContentHeight contentHeight}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sContentHeight - New value for property contentHeight
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
public setContentHeight(sContentHeight: sap.ui.core.CSSSize): sap.m.TablePersoDialog;
/**
* Sets a new value for property {@link #getContentWidth contentWidth}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sContentWidth - New value for property contentWidth
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
public setContentWidth(sContentWidth: sap.ui.core.CSSSize): sap.m.TablePersoDialog;
/**
* Setter to turn on/ switch off TablePersoDialog's grouping mode.
* @param {boolean} bHasGrouping - groping mode on or off.
* @returns {sap.m.TablePersoDialog} the TablePersoDialog instance.
*/
public setHasGrouping(bHasGrouping: boolean): sap.m.TablePersoDialog;
/**
* Sets a new value for property {@link #getInitialColumnState initialColumnState}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oInitialColumnState - New value for property initialColumnState
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
public setInitialColumnState(oInitialColumnState: any): sap.m.TablePersoDialog;
/**
* Sets the associated {@link #getPersoDialogFor persoDialogFor}.
* @param {sap.ui.core.ID|sap.m.Table} oPersoDialogFor - ID of an element which becomes the new target of this persoDialogFor association; alternatively, an element instance may be given
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
public setPersoDialogFor(oPersoDialogFor: sap.ui.core.ID|sap.m.Table): sap.m.TablePersoDialog;
/**
* Sets a new value for property {@link #getPersoMap persoMap}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oPersoMap - New value for property persoMap
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
public setPersoMap(oPersoMap: any): sap.m.TablePersoDialog;
/**
* Sets the aggregated {@link #getPersoService persoService}.
* @param {Object} oPersoService - The persoService to set
* @returns {sap.m.TablePersoDialog} Reference to this
in order to allow method chaining
*/
public setPersoService(oPersoService: Object): sap.m.TablePersoDialog;
/**
* Setter to show/hide TablePersoDialog's 'Undo Personalization' button.
* @param {boolean} bShowResetAll - 'undo Personalization' button visible or not.
* @returns {sap.m.TablePersoDialog} the TablePersoDialog instance.
*/
public setShowResetAll(bShowResetAll: boolean): sap.m.TablePersoDialog;
/**
* Setter to show/hide TablePersoDialog's 'selectAll' checkbox.
* @param {boolean} bShowSelectAll - selectAll checkbox visible or not.
* @returns {sap.m.TablePersoDialog} the TablePersoDialog instance.
*/
public setShowSelectAll(bShowSelectAll: boolean): sap.m.TablePersoDialog;
}
/**
* Table Personalization Provider
*/
export class TablePersoProvider extends sap.ui.base.ManagedObject {
/**
* This is an abstract TablePersoProvider, describing the interface for a real
* TablePersoProvider.
*/
public constructor();
/**
* Removes the personalization bundle
* This must return a jQuery promise (see http://api.jquery.com/promise/)
*/
public delPersData(): void;
/**
* Creates a new subclass of class sap.m.TablePersoProvider with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Callback function which can be used to determine the title of a given column
* within the TablePersoDialog. As a default, the column header controls are
* asked for their 'text' or 'title' property. This works in most cases, for example
* if the header control is an sap.m.Label (has 'text' property) or an sap.m.ObjectListItem
* (has 'title' property).
*
* If the header control used in a column has neither 'text' nor 'title' property, or if you would like to
* display a modified column name for a certain column, this callback function can be used.
*
* If the callback delivers null for a column (which is the default implementation), the default
* texts described above are displayed for that column in the TablePersoDialog.
*
* In case neither the callback delivers null and neither 'text' nor ' title' property are at hand,
* the TablePersoDialog will display the column id and a warning message is logged.
* @param {sap.m.Column} oColumn - column whose caption shall be determined
* @returns {any}
*/
public getCaption(oColumn: sap.m.Column): any;
/**
* Callback function which can be used to determine the group of a given column
* within the TablePersoDialog. As a default, the columns are not assigned to a group.
*
* This information is used to group the columns within the TablePersoDialog if the TablePersoController's
* 'group' flag is set, otherwise, the groups are ignored.
* @param {sap.m.Column} oColumn - column whose group shall be determined
* @returns {any}
*/
public getGroup(oColumn: sap.m.Column): any;
/**
* Returns a metadata object for class sap.m.TablePersoProvider.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Retrieves the personalization bundle.
* This must return a jQuery promise (see http://api.jquery.com/promise/)
* @returns {any}
*/
public getPersData(): any;
/**
* Initializes the TablePersoProvider instance after creation.
*/
protected init(): void;
/**
* Resets user’s personalization for a given table so that ‘getPersData’ will
* deliver its initial state. If no table is specified, all personalizations
* of the currently logged on user are reset.
*
* This must return a jQuery promise (see http://api.jquery.com/promise/)
*/
public resetPersData(): void;
/**
* Stores the personalization bundle, overwriting any
* previous bundle completely
* This must return a jQuery promise (see http://api.jquery.com/promise/)
* @param {any} oBundle
*/
public setPersData(oBundle: any): void;
}
/**
* A dialog to select items in a table containing multiple values and attributes.
* Overview
* The table select dialog helps users select items in a table-like structure with several attributes and values per item. A search fields helps narrow down the results.
* Structure
* The table select dialog consists of the following elements:
*
* - Search field - used to search enter search terms for a specific item.
* - Infobar (optional) - shows additional information for the current selection (i.e. total number of selected items).
* - Content - the table with the items.
* - Footer (optional) - a toolbar for actions.
*
* Table select dialog supports multi-selection when the multiSelect
property is set.
*
* The selected items can be stored for later editing when the rememberSelections
property is set.
* Note: This property has to be set before the dialog is opened.
* Usage
* When to use:
*
* - You need to select one or more items from a comprehensive list that contains multiple attributes or values.
*
* When not to use:
*
* - You need to select one item from a predefined set of options that contains only one value. Use a {@link sap.m.Select switch} control instead.
* - You need to select items within a query-based range. Use a {@link sap.ui.comp.valuehelpdialog.ValueHelpDialog value help} control instead.
* - You need to only filter a set of items. Use a {@link sap.ui.comp.filterbar.FilterBar filter bar} control instead.
*
* Responsive Behavior
*
* - On smaller screens, the columns of the table wrap and build a list that shows all the information.
*
*/
export class TableSelectDialog extends sap.ui.core.Control {
/**
* Sets the binding context for the internal table AND the current control so that both controls can be used with the context.
*/
public _setBindingContext: any;
/**
* Sets the model for the internal table and the current control, so that both controls can be used with data binding.
*/
public _setModel: any;
/**
* Constructor for a new TableSelectDialog.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some column to the aggregation {@link #getColumns columns}.
* @param {sap.m.Column} oColumn - the column to add; if empty, nothing is inserted
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public addColumn(oColumn: sap.m.Column): sap.m.TableSelectDialog;
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.m.ColumnListItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.m.ColumnListItem): sap.m.TableSelectDialog;
/**
* Transfers method to the inner dialog: addStyleClass
* @returns {sap.m.TableSelectDialog} this pointer for chaining
*/
public addStyleClass(): sap.m.TableSelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.m.TableSelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TableSelectDialog
itself.
*
* Fires when the Cancel button is clicked.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TableSelectDialog
itself
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public attachCancel(fnFunction: Function, oListener?: any): sap.m.TableSelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.m.TableSelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TableSelectDialog
itself.
*
* Fires when the Cancel button is clicked.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TableSelectDialog
itself
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public attachCancel(oData: any, fnFunction: Function, oListener?: any): sap.m.TableSelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:confirm confirm} event of this sap.m.TableSelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TableSelectDialog
itself.
*
* Fires when the dialog is confirmed by selecting an item in single-selection mode or by pressing the confirmation button in multi-selection mode. The items being selected are returned as event parameters.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TableSelectDialog
itself
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public attachConfirm(fnFunction: Function, oListener?: any): sap.m.TableSelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:confirm confirm} event of this sap.m.TableSelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TableSelectDialog
itself.
*
* Fires when the dialog is confirmed by selecting an item in single-selection mode or by pressing the confirmation button in multi-selection mode. The items being selected are returned as event parameters.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TableSelectDialog
itself
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public attachConfirm(oData: any, fnFunction: Function, oListener?: any): sap.m.TableSelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.m.TableSelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TableSelectDialog
itself.
*
* Fires when the value of the search field is changed by a user (for example at each key press).
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TableSelectDialog
itself
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public attachLiveChange(fnFunction: Function, oListener?: any): sap.m.TableSelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.m.TableSelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TableSelectDialog
itself.
*
* Fires when the value of the search field is changed by a user (for example at each key press).
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TableSelectDialog
itself
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public attachLiveChange(oData: any, fnFunction: Function, oListener?: any): sap.m.TableSelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.m.TableSelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TableSelectDialog
itself.
*
* Fires when the search button has been clicked on dialog.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TableSelectDialog
itself
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public attachSearch(fnFunction: Function, oListener?: any): sap.m.TableSelectDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.m.TableSelectDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TableSelectDialog
itself.
*
* Fires when the search button has been clicked on dialog.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TableSelectDialog
itself
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public attachSearch(oData: any, fnFunction: Function, oListener?: any): sap.m.TableSelectDialog;
/**
* Forwards aggregations with the name of items or columns to the internal table.
* @param {string} sAggregationName - The name for the binding
* @param {any} oBindingInfo - The configuration parameters for the binding
* @returns {sap.m.TableSelectDialog} this pointer for chaining
*/
public bindAggregation(sAggregationName: string, oBindingInfo: any): sap.m.TableSelectDialog;
/**
* Binds aggregation {@link #getColumns columns} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public bindColumns(oBindingInfo: any): sap.m.TableSelectDialog;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.m.TableSelectDialog;
/**
* Destroys all the columns in the aggregation {@link #getColumns columns}.
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public destroyColumns(): sap.m.TableSelectDialog;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.TableSelectDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:cancel cancel} event of this sap.m.TableSelectDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public detachCancel(fnFunction: Function, oListener: any): sap.m.TableSelectDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:confirm confirm} event of this sap.m.TableSelectDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public detachConfirm(fnFunction: Function, oListener: any): sap.m.TableSelectDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:liveChange liveChange} event of this sap.m.TableSelectDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public detachLiveChange(fnFunction: Function, oListener: any): sap.m.TableSelectDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:search search} event of this sap.m.TableSelectDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public detachSearch(fnFunction: Function, oListener: any): sap.m.TableSelectDialog;
/**
* Creates a new subclass of class sap.m.TableSelectDialog with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:cancel cancel} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
protected fireCancel(mParameters?: any): sap.m.TableSelectDialog;
/**
* Fires event {@link #event:confirm confirm} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
protected fireConfirm(mParameters?: any): sap.m.TableSelectDialog;
/**
* Fires event {@link #event:liveChange liveChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
protected fireLiveChange(mParameters?: any): sap.m.TableSelectDialog;
/**
* Fires event {@link #event:search search} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
protected fireSearch(mParameters?: any): sap.m.TableSelectDialog;
/**
* Gets current busy state.
* @returns {boolean} value of currtent busy state.
*/
public getBusy(): boolean;
/**
* Gets content of aggregation {@link #getColumns columns}.
*
* The columns bindings.
* @returns {sap.m.Column[]}
*/
public getColumns(): sap.m.Column[];
/**
* Retrieves content height of the select dialog {@link sap.m.Dialog}
* @returns {sap.ui.core.CSSSize} sHeight the content height of the internal dialog
*/
public getContentHeight(): sap.ui.core.CSSSize;
/**
* Retrieves content width of the select dialog {@link sap.m.Dialog}
* @returns {sap.ui.core.CSSSize} sWidth the content width of the internal dialog
*/
public getContentWidth(): sap.ui.core.CSSSize;
/**
* Transfers method to the inner dialog: getDomRef
* @returns {HTMLElement} The Element's DOM Element sub DOM Element or null
*/
public getDomRef(): HTMLElement;
/**
* Gets current value of property {@link #getGrowingThreshold growingThreshold}.
*
* Determines the number of items initially displayed in the table.
* @returns {number} Value of property growingThreshold
*/
public getGrowingThreshold(): number;
/**
* Gets content of aggregation {@link #getItems items}.
*
* The items of the table.
* @returns {sap.m.ColumnListItem[]}
*/
public getItems(): sap.m.ColumnListItem[];
/**
* Returns a metadata object for class sap.m.TableSelectDialog.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMultiSelect multiSelect}.
*
* Enables the user to select several options from the table.
*
* Default value is false
.
* @returns {boolean} Value of property multiSelect
*/
public getMultiSelect(): boolean;
/**
* Retrieves the internal List's no data text property
* @returns {string} the current no data text
*/
public getNoDataText(): string;
/**
* Gets current value of property {@link #getRememberSelections rememberSelections}.
*
* Controls whether the dialog clears the selection or not. When the dialog is opened multiple times in the same context to allow for corrections of previous user inputs, set this flag to "true". When the dialog should reset the selection to allow for a new selection each time set it to "false"
* Note: This property must be set before the Dialog is opened to have an effect.
*
* Default value is false
.
* @returns {boolean} Value of property rememberSelections
*/
public getRememberSelections(): boolean;
/**
* Gets current value of property {@link #getTitle title}.
*
* Specifies the title text in the dialog header.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Transfers method to the inner dialog: hasStyleClass
* @returns {boolean} true if the class is set, false otherwise
*/
public hasStyleClass(): boolean;
/**
* Checks for the provided sap.m.Column
in the aggregation {@link #getColumns columns}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Column} oColumn - The column whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfColumn(oColumn: sap.m.Column): number;
/**
* Checks for the provided sap.m.ColumnListItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ColumnListItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.m.ColumnListItem): number;
/**
* Inserts a column into the aggregation {@link #getColumns columns}.
* @param {sap.m.Column} oColumn - the column to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the column should be inserted at; for a negative value of iIndex
, the column is inserted at position 0; for a value greater than the current size of the aggregation, the column is inserted at the last position
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public insertColumn(oColumn: sap.m.Column, iIndex: number): sap.m.TableSelectDialog;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.m.ColumnListItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.m.ColumnListItem, iIndex: number): sap.m.TableSelectDialog;
/**
* Invalidates the dialog instead of this control, as there is no renderer.
*/
protected invalidate(): void;
/**
* Shows the busy state and is called after the renderer is finished.
*/
protected onAfterRendering(): void;
/**
* Opens the internal dialog with a searchfield and a table.
* @param {string} sSearchValue - Value for the search. The table will be automatically trigger the search event if this parameter is set.
* @returns {sap.m.TableSelectDialog} this
to allow method chaining
*/
public open(sSearchValue: string): sap.m.TableSelectDialog;
/**
* Removes all the controls from the aggregation {@link #getColumns columns}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Column[]} An array of the removed elements (might be empty)
*/
public removeAllColumns(): sap.m.Column[];
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ColumnListItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.m.ColumnListItem[];
/**
* Removes a column from the aggregation {@link #getColumns columns}.
* @param {number|string|sap.m.Column} vColumn - The column to remove or its index or id
* @returns {sap.m.Column} The removed column or null
*/
public removeColumn(vColumn: number|string|sap.m.Column): sap.m.Column;
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.m.ColumnListItem} vItem - The item to remove or its index or id
* @returns {sap.m.ColumnListItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.m.ColumnListItem): sap.m.ColumnListItem;
/**
* Transfers method to the inner dialog: removeStyleClass
* @returns {sap.m.TableSelectDialog} this pointer for chaining
*/
public removeStyleClass(): sap.m.TableSelectDialog;
/**
* Enables/Disables busy state.
* @param {boolean} flag - for enabling busy indicator
* @returns {sap.m.TableSelectDialog} this pointer for chaining
*/
public setBusy(flag: boolean): sap.m.TableSelectDialog;
/**
* Sets the busyIndicatorDelay value to the internal table
* @param {number} iValue - Value for the busyIndicatorDelay.
* @returns {sap.m.TableSelectDialog} this pointer for chaining
*/
public setBusyIndicatorDelay(iValue: number): sap.m.TableSelectDialog;
/**
* Sets content height of the select dialog {@link sap.m.Dialog}
* @param {sap.ui.core.CSSSize} sHeight - the new content height value for the dialog
* @returns {sap.m.TableSelectDialog} this pointer for chaining
*/
public setContentHeight(sHeight: sap.ui.core.CSSSize): sap.m.TableSelectDialog;
/**
* Sets content width of the select dialog {@link sap.m.Dialog}
* @param {sap.ui.core.CSSSize} sWidth - the new content width value for the dialog
* @returns {sap.m.TableSelectDialog} this pointer for chaining
*/
public setContentWidth(sWidth: sap.ui.core.CSSSize): sap.m.TableSelectDialog;
/**
* Sets the growing threshold to the internal table
* @param {number} iValue - Value for the table's growing threshold.
* @returns {sap.m.TableSelectDialog} this pointer for chaining
*/
public setGrowingThreshold(iValue: number): sap.m.TableSelectDialog;
/**
* Enables/Disables multi selection mode.
* @param {boolean} bMulti - flag for multi selection mode
* @returns {sap.m.TableSelectDialog} this pointer for chaining
*/
public setMultiSelect(bMulti: boolean): sap.m.TableSelectDialog;
/**
* Sets the no data text of the internal table
* @param {string} sNoDataText - the no data text for the table
*/
public setNoDataText(sNoDataText: string): void;
/**
* Sets a new value for property {@link #getRememberSelections rememberSelections}.
*
* Controls whether the dialog clears the selection or not. When the dialog is opened multiple times in the same context to allow for corrections of previous user inputs, set this flag to "true". When the dialog should reset the selection to allow for a new selection each time set it to "false"
* Note: This property must be set before the Dialog is opened to have an effect.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bRememberSelections - New value for property rememberSelections
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public setRememberSelections(bRememberSelections: boolean): sap.m.TableSelectDialog;
/**
* Sets the title of the internal dialog
* @param {string} sTitle - the title text for the dialog
* @returns {sap.m.TableSelectDialog} this pointer for chaining
*/
public setTitle(sTitle: string): sap.m.TableSelectDialog;
/**
* Transfers method to the inner dialog: toggleStyleClass
* @returns {sap.m.TableSelectDialog} this pointer for chaining
*/
public toggleStyleClass(): sap.m.TableSelectDialog;
/**
* Unbinds aggregation {@link #getColumns columns} from model data.
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public unbindColumns(): sap.m.TableSelectDialog;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.m.TableSelectDialog} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.m.TableSelectDialog;
}
/**
* The sap.m.TabStripSelectList
displays a list of items that allows the user to select an item.
*/
export class TabStripSelectList extends sap.m.SelectList {
/**
* Constructor for a new TabStripSelectList
.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.TabStripSelectList with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.SelectList.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.TabStripSelectList.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Initializes the control.
*/
public init(): void;
}
/**
* The Text
control can be used for embedding longer text paragraphs, that need text wrapping, into your app.
* If the configured text value contains HTML code or script tags, those will be escaped.
* Note: Line breaks (\r\n, \n\r, \r, \n) will always be visualized except when the wrapping
property is set to false
.
*/
export class Text extends sap.ui.core.Control {
/**
* Determines per instance whether line height should be cached or not.
*
* Default value is true.
*/
protected cacheLineHeight: boolean;
/**
* Ellipsis(…) text to indicate more text when clampText function is used.
*
* Can be overwritten with 3dots(...) if fonts do not support this UTF-8 character.
*/
protected ellipsis: string;
/**
* Default line height value as a number when line-height is normal.
*
* This value is required during max-height calculation for the browsers that do not support line-clamping.
* It is better to define line-height in CSS instead of "normal" to get consistent maxLines results since normal line-height
* not only varies from browser to browser but they also vary from one font face to another and can also vary within a given face.
*
* Default value is 1.2
*/
protected normalLineHeight: number;
/**
* Constructor for a new Text.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Binds property {@link #getText text} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a
* detailed description of the possible properties of oBindingInfo
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.Text} Reference to this
in order to allow method chaining
*/
public bindText(oBindingInfo: any): sap.m.Text;
/**
* Sets the max-height to support maxLines property.
* @param {HTMLElement} oDomRef - DOM reference of the text container.
* @returns {number} calculated max height value
*/
protected clampHeight(oDomRef?: HTMLElement): number;
/**
* Clamps the wrapping text according to max lines and returns the found ellipsis position.
*
* Parameters can be used for better performance.
* @param {HTMLElement} oDomRef - DOM reference of the text container.
* @param {number} iStartPos - Start point of the ellipsis search.
* @param {number} iEndPos - End point of the ellipsis search.
* @returns {number|any} Returns found ellipsis position or undefined
*/
protected clampText(oDomRef?: HTMLElement, iStartPos?: number, iEndPos?: number): number|any;
/**
* Creates a new subclass of class sap.m.Text with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Returns the max height according to max lines and line height calculation.
*
* This is not calculated max-height!
* @param {HTMLElement} oDomRef - DOM reference of the text container.
* @returns {number}
*/
protected getClampHeight(oDomRef?: HTMLElement): number;
/**
* Caches and returns the computed line height of the text.
* @param {HTMLElement} oDomRef - DOM reference of the text container.
* @returns {number} returns calculated line-height
*/
protected getLineHeight(oDomRef?: HTMLElement): number;
/**
* Gets current value of property {@link #getMaxLines maxLines}.
*
* Limits the number of lines for wrapping texts.
*
* Note: In multi-line text the overflow will be hidden (ellipsis won't be shown).
* @returns {number} Value of property maxLines
*/
public getMaxLines(): number;
/**
* Returns a metadata object for class sap.m.Text.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* Determines the text to be displayed.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextAlign textAlign}.
*
* Sets the horizontal alignment of the text.
*
* Default value is Begin
.
* @returns {sap.ui.core.TextAlign} Value of property textAlign
*/
public getTextAlign(): sap.ui.core.TextAlign;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Available options for the text direction are LTR and RTL. By default the control inherits the text direction from its parent control.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Returns the text node container's DOM reference.
*
* This can be different from getDomRef when inner wrapper is needed.
* @returns {HTMLElement|null}
*/
protected getTextDomRef(): HTMLElement|null;
/**
* Gets current value of property {@link #getWidth width}.
*
* Sets the width of the Text control. By default, the Text control uses the full width available. Set this property to restrict the width to a custom value.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getWrapping wrapping}.
*
* Enables text wrapping.
*
* Default value is true
.
* @returns {boolean} Value of property wrapping
*/
public getWrapping(): boolean;
/**
* Determines whether max lines should be rendered or not.
* @returns {HTMLElement|null}
*/
protected hasMaxLines(): HTMLElement|null;
/**
* Sets a new value for property {@link #getMaxLines maxLines}.
*
* Limits the number of lines for wrapping texts.
*
* Note: In multi-line text the overflow will be hidden (ellipsis won't be shown).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iMaxLines - New value for property maxLines
* @returns {sap.m.Text} Reference to this
in order to allow method chaining
*/
public setMaxLines(iMaxLines: number): sap.m.Text;
/**
* To prevent from the layout thrashing of the textContent call, this method
* first tries to set the nodeValue of the first child if it exists.
* @param {HTMLElement} oDomRef - DOM reference of the text node container.
* @param {string} sNodeValue - new Node value.
*/
protected static setNodeValue(oDomRef: HTMLElement, sNodeValue?: string): void;
/**
* Sets a new value for property {@link #getText text}.
*
* Determines the text to be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sText - New value for property text
* @returns {sap.m.Text} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.Text;
/**
* Sets a new value for property {@link #getTextAlign textAlign}.
*
* Sets the horizontal alignment of the text.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Begin
.
* @param {sap.ui.core.TextAlign} sTextAlign - New value for property textAlign
* @returns {sap.m.Text} Reference to this
in order to allow method chaining
*/
public setTextAlign(sTextAlign: sap.ui.core.TextAlign): sap.m.Text;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Available options for the text direction are LTR and RTL. By default the control inherits the text direction from its parent control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.Text} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.Text;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Sets the width of the Text control. By default, the Text control uses the full width available. Set this property to restrict the width to a custom value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.Text} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.Text;
/**
* Sets a new value for property {@link #getWrapping wrapping}.
*
* Enables text wrapping.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bWrapping - New value for property wrapping
* @returns {sap.m.Text} Reference to this
in order to allow method chaining
*/
public setWrapping(bWrapping: boolean): sap.m.Text;
/**
* Unbinds property {@link #getText text} from model data.
* @returns {sap.m.Text} Reference to this
in order to allow method chaining
*/
public unbindText(): sap.m.Text;
}
/**
* The sap.m.TextArea
enables multi-line text input.
*/
export class TextArea extends sap.m.InputBase {
/**
* Constructor for a new TextArea.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.m.TextArea
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TextArea
itself.
*
* Is fired whenever the user has modified the text shown on the text area.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TextArea
itself
* @returns {sap.m.TextArea} Reference to this
in order to allow method chaining
*/
public attachLiveChange(fnFunction: Function, oListener?: any): sap.m.TextArea;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.m.TextArea
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TextArea
itself.
*
* Is fired whenever the user has modified the text shown on the text area.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TextArea
itself
* @returns {sap.m.TextArea} Reference to this
in order to allow method chaining
*/
public attachLiveChange(oData: any, fnFunction: Function, oListener?: any): sap.m.TextArea;
/**
* Detaches event handler fnFunction
from the {@link #event:liveChange liveChange} event of this sap.m.TextArea
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.TextArea} Reference to this
in order to allow method chaining
*/
public detachLiveChange(fnFunction: Function, oListener: any): sap.m.TextArea;
/**
* Creates a new subclass of class sap.m.TextArea with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.InputBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:liveChange liveChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.TextArea} Reference to this
in order to allow method chaining
*/
protected fireLiveChange(mParameters?: any): sap.m.TextArea;
/**
* Gets current value of property {@link #getCols cols}.
*
* Defines the visible width of the control, in average character widths.
* Note: The width
property wins over the cols
property, if both are set.
*
* Default value is 20
.
* @returns {number} Value of property cols
*/
public getCols(): number;
/**
* Gets current value of property {@link #getGrowing growing}.
*
* Indicates the ability of the control to automatically grow and shrink dynamically with its content.
* Note: The height
property is ignored, if this property set to true
.
*
* Default value is false
.
* @returns {boolean} Value of property growing
*/
public getGrowing(): boolean;
/**
* Gets current value of property {@link #getGrowingMaxLines growingMaxLines}.
*
* Defines the maximum number of lines that the control can grow.
*
* Default value is 0
.
* @returns {number} Value of property growingMaxLines
*/
public getGrowingMaxLines(): number;
/**
* Gets current value of property {@link #getHeight height}.
*
* Defines the height of the control.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getMaxLength maxLength}.
*
* Defines the maximum number of characters that the value
can be.
*
* Default value is 0
.
* @returns {number} Value of property maxLength
*/
public getMaxLength(): number;
/**
* Returns a metadata object for class sap.m.TextArea.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRows rows}.
*
* Defines the number of visible text lines for the control.
* Note: The height
property wins over the rows
property, if both are set.
*
* Default value is 2
.
* @returns {number} Value of property rows
*/
public getRows(): number;
/**
* Gets current value of property {@link #getShowExceededText showExceededText}.
*
* Determines whether the characters, exceeding the maximum allowed character count, are visible in the input field.
*
* If set to false
the user is not allowed to enter more characters than what is set in the maxLength
property.
* If set to true
the characters exceeding the maxLength
value are selected on paste and the counter below
* the input field displays their number.
*
* Default value is false
.
* @returns {boolean} Value of property showExceededText
*/
public getShowExceededText(): boolean;
/**
* Gets current value of property {@link #getValueLiveUpdate valueLiveUpdate}.
*
* Indicates when the value
property gets updated with the user changes. Setting it to true
updates the value
property whenever the user has modified the text shown on the text area.
*
* Default value is false
.
* @returns {boolean} Value of property valueLiveUpdate
*/
public getValueLiveUpdate(): boolean;
/**
* Gets current value of property {@link #getWrapping wrapping}.
*
* Indicates how the control wraps the text, e.g. Soft
, Hard
, Off
.
*
* Default value is None
.
* @returns {sap.ui.core.Wrapping} Value of property wrapping
*/
public getWrapping(): sap.ui.core.Wrapping;
/**
* Sets a new value for property {@link #getCols cols}.
*
* Defines the visible width of the control, in average character widths.
* Note: The width
property wins over the cols
property, if both are set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 20
.
* @param {number} iCols - New value for property cols
* @returns {sap.m.TextArea} Reference to this
in order to allow method chaining
*/
public setCols(iCols: number): sap.m.TextArea;
/**
* Sets a new value for property {@link #getGrowing growing}.
*
* Indicates the ability of the control to automatically grow and shrink dynamically with its content.
* Note: The height
property is ignored, if this property set to true
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bGrowing - New value for property growing
* @returns {sap.m.TextArea} Reference to this
in order to allow method chaining
*/
public setGrowing(bGrowing: boolean): sap.m.TextArea;
/**
* Sets a new value for property {@link #getGrowingMaxLines growingMaxLines}.
*
* Defines the maximum number of lines that the control can grow.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iGrowingMaxLines - New value for property growingMaxLines
* @returns {sap.m.TextArea} Reference to this
in order to allow method chaining
*/
public setGrowingMaxLines(iGrowingMaxLines: number): sap.m.TextArea;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Defines the height of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.m.TextArea} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.m.TextArea;
/**
* Sets a new value for property {@link #getMaxLength maxLength}.
*
* Defines the maximum number of characters that the value
can be.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iMaxLength - New value for property maxLength
* @returns {sap.m.TextArea} Reference to this
in order to allow method chaining
*/
public setMaxLength(iMaxLength: number): sap.m.TextArea;
/**
* Sets a new value for property {@link #getRows rows}.
*
* Defines the number of visible text lines for the control.
* Note: The height
property wins over the rows
property, if both are set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 2
.
* @param {number} iRows - New value for property rows
* @returns {sap.m.TextArea} Reference to this
in order to allow method chaining
*/
public setRows(iRows: number): sap.m.TextArea;
/**
* Sets a new value for property {@link #getShowExceededText showExceededText}.
*
* Determines whether the characters, exceeding the maximum allowed character count, are visible in the input field.
*
* If set to false
the user is not allowed to enter more characters than what is set in the maxLength
property.
* If set to true
the characters exceeding the maxLength
value are selected on paste and the counter below
* the input field displays their number.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowExceededText - New value for property showExceededText
* @returns {sap.m.TextArea} Reference to this
in order to allow method chaining
*/
public setShowExceededText(bShowExceededText: boolean): sap.m.TextArea;
/**
* Sets a new value for property {@link #getValueLiveUpdate valueLiveUpdate}.
*
* Indicates when the value
property gets updated with the user changes. Setting it to true
updates the value
property whenever the user has modified the text shown on the text area.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bValueLiveUpdate - New value for property valueLiveUpdate
* @returns {sap.m.TextArea} Reference to this
in order to allow method chaining
*/
public setValueLiveUpdate(bValueLiveUpdate: boolean): sap.m.TextArea;
/**
* Sets a new value for property {@link #getWrapping wrapping}.
*
* Indicates how the control wraps the text, e.g. Soft
, Hard
, Off
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.Wrapping} sWrapping - New value for property wrapping
* @returns {sap.m.TextArea} Reference to this
in order to allow method chaining
*/
public setWrapping(sWrapping: sap.ui.core.Wrapping): sap.m.TextArea;
}
/**
* A tile to be displayed in the tile container. Use this
* tile as the base class for specialized tile implementations.
* Use the renderer _addOuterClass methods to add a style class to the main
* surface of the Tile. In this class set the background color, gradients
* or background images.
* Instead of implementing the default render method in the renderer, implement
* your content HTML in the _renderContent method of the specialized tile.
*/
export class Tile extends sap.ui.core.Control {
/**
* Constructor for a new Tile.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.Tile
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Tile
itself.
*
* Tap event is raised if the user taps or clicks the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Tile
itself
* @returns {sap.m.Tile} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.Tile;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.Tile
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Tile
itself.
*
* Tap event is raised if the user taps or clicks the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Tile
itself
* @returns {sap.m.Tile} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.Tile;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.Tile
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Tile} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.Tile;
/**
* Creates a new subclass of class sap.m.Tile with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Tile} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.Tile;
/**
* Returns a metadata object for class sap.m.Tile.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRemovable removable}.
*
* Determines whether the tile is movable within the surrounding tile container. The remove event is fired by the tile container.
*
* Default value is true
.
* @returns {boolean} Value of property removable
*/
public getRemovable(): boolean;
/**
* Sets a new value for property {@link #getRemovable removable}.
*
* Determines whether the tile is movable within the surrounding tile container. The remove event is fired by the tile container.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bRemovable - New value for property removable
* @returns {sap.m.Tile} Reference to this
in order to allow method chaining
*/
public setRemovable(bRemovable: boolean): sap.m.Tile;
}
/**
* A container that arranges same-size tiles nicely on carousel pages.
*/
export class TileContainer extends sap.ui.core.Control {
/**
* Constructor for a new TileContainer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds a Tile to the end of the tiles collection.
* @param {sap.m.Tile} oTile - The tile to add
* @returns {sap.m.TileContainer} this pointer for chaining
*/
public addTile(oTile: sap.m.Tile): sap.m.TileContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:tileAdd tileAdd} event of this sap.m.TileContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TileContainer
itself.
*
* Fires when a Tile is added.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TileContainer
itself
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
public attachTileAdd(fnFunction: Function, oListener?: any): sap.m.TileContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:tileAdd tileAdd} event of this sap.m.TileContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TileContainer
itself.
*
* Fires when a Tile is added.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TileContainer
itself
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
public attachTileAdd(oData: any, fnFunction: Function, oListener?: any): sap.m.TileContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:tileDelete tileDelete} event of this sap.m.TileContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TileContainer
itself.
*
* Fires if a Tile is deleted in Edit mode.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TileContainer
itself
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
public attachTileDelete(fnFunction: Function, oListener?: any): sap.m.TileContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:tileDelete tileDelete} event of this sap.m.TileContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TileContainer
itself.
*
* Fires if a Tile is deleted in Edit mode.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TileContainer
itself
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
public attachTileDelete(oData: any, fnFunction: Function, oListener?: any): sap.m.TileContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:tileMove tileMove} event of this sap.m.TileContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TileContainer
itself.
*
* Fires if a Tile is moved.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TileContainer
itself
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
public attachTileMove(fnFunction: Function, oListener?: any): sap.m.TileContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:tileMove tileMove} event of this sap.m.TileContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.TileContainer
itself.
*
* Fires if a Tile is moved.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.TileContainer
itself
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
public attachTileMove(oData: any, fnFunction: Function, oListener?: any): sap.m.TileContainer;
/**
* Deletes a Tile.
* @param {sap.m.Tile} oTile - The tile to move
* @returns {sap.m.TileContainer} this pointer for chaining
*/
public deleteTile(oTile: sap.m.Tile): sap.m.TileContainer;
/**
* Destroys all the tiles in the aggregation {@link #getTiles tiles}.
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
public destroyTiles(): sap.m.TileContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:tileAdd tileAdd} event of this sap.m.TileContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
public detachTileAdd(fnFunction: Function, oListener: any): sap.m.TileContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:tileDelete tileDelete} event of this sap.m.TileContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
public detachTileDelete(fnFunction: Function, oListener: any): sap.m.TileContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:tileMove tileMove} event of this sap.m.TileContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
public detachTileMove(fnFunction: Function, oListener: any): sap.m.TileContainer;
/**
* Creates a new subclass of class sap.m.TileContainer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:tileAdd tileAdd} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
protected fireTileAdd(mParameters?: any): sap.m.TileContainer;
/**
* Fires event {@link #event:tileDelete tileDelete} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
protected fireTileDelete(mParameters?: any): sap.m.TileContainer;
/**
* Fires event {@link #event:tileMove tileMove} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
protected fireTileMove(mParameters?: any): sap.m.TileContainer;
/**
* Gets current value of property {@link #getAllowAdd allowAdd}.
*
* Determines whether the user is allowed to add Tiles in Edit mode (editable = true).
* @returns {boolean} Value of property allowAdd
*/
public getAllowAdd(): boolean;
/**
* Gets current value of property {@link #getEditable editable}.
*
* Determines whether the TileContainer is editable so you can move, delete or add tiles.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* Defines the height of the TileContainer in px.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.m.TileContainer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the index of the first Tile visible in the current page.
* @returns {number} The index of the first Tile that is visible in the current page
*/
public getPageFirstTileIndex(): number;
/**
* Gets content of aggregation {@link #getTiles tiles}.
*
* The Tiles to be displayed by the TileContainer.
* @returns {sap.m.Tile[]}
*/
public getTiles(): sap.m.Tile[];
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the TileContainer in px.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.m.Tile
in the aggregation {@link #getTiles tiles}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Tile} oTile - The tile whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfTile(oTile: sap.m.Tile): number;
/**
* Inserts a Tile to the given index.
* @param {sap.m.Tile} oTile - The Tile to insert
* @param {number} iIndex - The new Tile position in the tiles aggregation
* @returns {sap.m.TileContainer} this pointer for chaining
*/
public insertTile(oTile: sap.m.Tile, iIndex: number): sap.m.TileContainer;
/**
* Moves a given Tile to the given index.
* @param {sap.m.Tile} vTile - The tile to move
* @param {number} iNewIndex - The new Tile position in the tiles aggregation
* @returns {sap.m.TileContainer} this pointer for chaining
*/
public moveTile(vTile: sap.m.Tile, iNewIndex: number): sap.m.TileContainer;
/**
* Removes all the controls from the aggregation {@link #getTiles tiles}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Tile[]} An array of the removed elements (might be empty)
*/
public removeAllTiles(): sap.m.Tile[];
/**
* Removes a tile from the aggregation {@link #getTiles tiles}.
* @param {number|string|sap.m.Tile} vTile - The tile to remove or its index or id
* @returns {sap.m.Tile} The removed tile or null
*/
public removeTile(vTile: number|string|sap.m.Tile): sap.m.Tile;
/**
* Scrolls to the page where the given Tile or tile index is included.
* Optionally this can be done animated or not. With IE9 the scroll is never animated.
* @param {sap.m.Tile|number} vTile - The Tile or tile index to be scrolled into view
* @param {boolean} bAnimated - Whether the scroll should be animated
* @param {any} aVisibleTiles
*/
public scrollIntoView(vTile: sap.m.Tile|number, bAnimated: boolean, aVisibleTiles: any): void;
/**
* Scrolls one page to the left.
*/
public scrollLeft(): void;
/**
* Scrolls one page to the right.
*/
public scrollRight(): void;
/**
* Sets a new value for property {@link #getAllowAdd allowAdd}.
*
* Determines whether the user is allowed to add Tiles in Edit mode (editable = true).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bAllowAdd - New value for property allowAdd
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
public setAllowAdd(bAllowAdd: boolean): sap.m.TileContainer;
/**
* Sets the editable property to the TileContainer, allowing to move icons.
* This is currently also set with a long tap.
* @param {boolean} bValue - Whether the container is in edit mode or not
* @returns {sap.m.TileContainer} this pointer for chaining
*/
public setEditable(bValue: boolean): sap.m.TileContainer;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Defines the height of the TileContainer in px.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.m.TileContainer;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the TileContainer in px.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.TileContainer} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.TileContainer;
}
/**
* This control is used within the GenericTile control.
*/
export class TileContent extends sap.ui.core.Control {
/**
* Constructor for a new sap.m.TileContent control.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Binds aggregation {@link #getContent content} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.TileContent} Reference to this
in order to allow method chaining
*/
public bindContent(oBindingInfo: any): sap.m.TileContent;
/**
* Destroys the content in the aggregation {@link #getContent content}.
* @returns {sap.m.TileContent} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.TileContent;
/**
* Creates a new subclass of class sap.m.TileContent with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The switchable view that depends on the tile type.
* @returns {sap.ui.core.Control}
*/
public getContent(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getDisabled disabled}.
*
* Disables control if true.
*
* Default value is false
.
* @returns {boolean} Value of property disabled
*/
public getDisabled(): boolean;
/**
* Gets current value of property {@link #getFooter footer}.
*
* The footer text of the tile.
* @returns {string} Value of property footer
*/
public getFooter(): string;
/**
* Gets current value of property {@link #getFooterColor footerColor}.
*
* The semantic color of the footer.
*
* Default value is Neutral
.
* @returns {sap.m.ValueColor} Value of property footerColor
*/
public getFooterColor(): sap.m.ValueColor;
/**
* Gets current value of property {@link #getFrameType frameType}.
*
* The frame type: 1x1 or 2x1.
*
* Default value is Auto
.
* @returns {sap.m.FrameType} Value of property frameType
*/
public getFrameType(): sap.m.FrameType;
/**
* Returns a metadata object for class sap.m.TileContent.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSize size}.
*
* Updates the size of the tile. If it is not set, then the default size is applied based on the device tile.
*
* Default value is Auto
.
* @returns {sap.m.Size} Value of property size
*/
public getSize(): sap.m.Size;
/**
* Gets current value of property {@link #getUnit unit}.
*
* The percent sign, the currency symbol, or the unit of measure.
* @returns {string} Value of property unit
*/
public getUnit(): string;
/**
* Sets the aggregated {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - The content to set
* @returns {sap.m.TileContent} Reference to this
in order to allow method chaining
*/
public setContent(oContent: sap.ui.core.Control): sap.m.TileContent;
/**
* Sets a new value for property {@link #getDisabled disabled}.
*
* Disables control if true.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bDisabled - New value for property disabled
* @returns {sap.m.TileContent} Reference to this
in order to allow method chaining
*/
public setDisabled(bDisabled: boolean): sap.m.TileContent;
/**
* Sets a new value for property {@link #getFooter footer}.
*
* The footer text of the tile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sFooter - New value for property footer
* @returns {sap.m.TileContent} Reference to this
in order to allow method chaining
*/
public setFooter(sFooter: string): sap.m.TileContent;
/**
* Sets a new value for property {@link #getFooterColor footerColor}.
*
* The semantic color of the footer.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Neutral
.
* @param {sap.m.ValueColor} sFooterColor - New value for property footerColor
* @returns {sap.m.TileContent} Reference to this
in order to allow method chaining
*/
public setFooterColor(sFooterColor: sap.m.ValueColor): sap.m.TileContent;
/**
* Sets a new value for property {@link #getFrameType frameType}.
*
* The frame type: 1x1 or 2x1.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.m.FrameType} sFrameType - New value for property frameType
* @returns {sap.m.TileContent} Reference to this
in order to allow method chaining
*/
public setFrameType(sFrameType: sap.m.FrameType): sap.m.TileContent;
/**
* Setter for protected property to enable or disable content rendering. This function does not invalidate the control.
* @param {boolean} value - Determines whether the control's content is rendered or not
* @returns {sap.m.TileContent} this To allow method chaining
*/
protected setRenderContent(value: boolean): sap.m.TileContent;
/**
* Setter for protected property to enable or disable footer rendering. This function does not invalidate the control.
* @param {boolean} value - Determines whether the control's footer is rendered or not
* @returns {sap.m.TileContent} this to allow method chaining
*/
protected setRenderFooter(value: boolean): sap.m.TileContent;
/**
* Sets a new value for property {@link #getSize size}.
*
* Updates the size of the tile. If it is not set, then the default size is applied based on the device tile.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.m.Size} sSize - New value for property size
* @returns {sap.m.TileContent} Reference to this
in order to allow method chaining
*/
public setSize(sSize: sap.m.Size): sap.m.TileContent;
/**
* Sets a new value for property {@link #getUnit unit}.
*
* The percent sign, the currency symbol, or the unit of measure.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sUnit - New value for property unit
* @returns {sap.m.TileContent} Reference to this
in order to allow method chaining
*/
public setUnit(sUnit: string): sap.m.TileContent;
/**
* Unbinds aggregation {@link #getContent content} from model data.
* @returns {sap.m.TileContent} Reference to this
in order to allow method chaining
*/
public unbindContent(): sap.m.TileContent;
}
/**
* A single-field input control that enables the users to fill time related input fields.
*
* Overview
*
* The TimePicker
control enables the users to fill time related input
* fields using touch, mouse, or keyboard input.
*
* Usage
*
* Use this control if you want the user to select a time. If you want the user to
* select a duration (1 hour), use the {@link sap.m.Select} control instead.
*
* The user can enter a date by:
*
* - Using the
TimePicker
dropdown that opens in a popup
* - Typing it in directly in the input field
*
* On app level, there are two options to provide value for the
* TimePicker
- as a string to the value
property or as a
* JavaScript Date object to the dateValue
property (only one of these
* properties should be used at a time):
*
* - Use the
value
property if you want to bind the
* TimePicker
to a model using the
* sap.ui.model.type.Time
* - Use the
value
property if the date is provided as a string from
* the backend or inside the app (for example, as ABAP type DATS field)
* - Use the
dateValue
property if the date is already provided as a
* JavaScript Date object or you want to work with a JavaScript Date object
*
* Formatting
*
* All formatting and parsing of values from and to strings is done using the
* {@link sap.ui.core.format.DateFormat}. If a value is entered by typing it into
* the input field, it must fit to the used time format and locale.
*
* Supported format options are pattern-based on Unicode LDML Date Format notation.
* See {@link http://unicode.org/reports/tr35/#Date_Field_Symbol_Table}
*
* A time format must be specified, otherwise the default "HH:mm:ss a" will be
* used. For example, if the valueFormat
is "HH-mm-ss a", the
* displayFormat
is "HH:mm:ss a", and the used locale is English, a
* valid value string is "10-30-15 AM", which leads to an output of "10:30:15 AM".
*
* If no placeholder is set to the TimePicker
, the used
* displayFormat
is displayed as a placeholder. If another placeholder
* is needed, it must be set.
*
* Note: If the string does NOT match the displayFormat
* (from user input) or the valueFormat
(on app level), the
* {@link sap.ui.core.format.DateFormat} makes an attempt to parse it based on the
* locale settings. For more information, see the respective documentation in the
* API Reference.
*
* Responsive behavior
*
* The TimePicker
is responsive and fully adapts to all device types.
* For larger screens, such as tablet or desktop, it opens as a popover. For
* mobile devices, it opens in full screen.
*/
export class TimePicker extends sap.m.MaskInput {
/**
* Constructor for a new TimePicker
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.TimePicker with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.MaskInput.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires change event to attached listeners.
*
* Expects following event parameters:
*
* - value parameter of type
string
- the new value of the input
* - valid parameter of type
boolean
- indicator for a valid time
*
* @param {{ [key: string]: any }} mArguments - The arguments to pass along with the event
* @returns {sap.m.TimePicker} this
to allow method chaining
*/
protected fireChange(mArguments?: { [key: string]: any }): sap.m.TimePicker;
/**
* Fires the change event for the listeners
* @param {string} sValue - value of the input.
* @param {Object} oParams - extra event parameters.
*/
protected fireChangeEvent(sValue: string, oParams?: Object): void;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getDateValue dateValue}.
*
* Holds a reference to a JavaScript Date Object. The value
(string)
* property will be set according to it. Alternatively, if the value
* and valueFormat
pair properties are supplied instead,
* the dateValue
will be instantiated according to the parsed
* value
.
* @returns {any} Value of property dateValue
*/
public getDateValue(): any;
/**
* Gets current value of property {@link #getDisplayFormat displayFormat}.
*
* Determines the format, displayed in the input field and the picker sliders.
*
* The default value is the browser's medium time format locale setting
* {@link sap.ui.core.LocaleData#getTimePattern}.
* If data binding with type {@link sap.ui.model.type.Time} or {@link sap.ui.model.odata.type.Time}
* is used for the value
property, the displayFormat
property
* is ignored as the information is provided from the binding itself.
* @returns {string} Value of property displayFormat
*/
public getDisplayFormat(): string;
/**
* Gets current value of property {@link #getLocaleId localeId}.
*
* Defines the locale used to parse string values representing time.
*
* Determines the locale, used to interpret the string, supplied by the
* value
property.
* Example: AM in the string "09:04 AM" is locale (language) dependent.
* The format comes from the browser language settings if not set explicitly.
* Used in combination with 12 hour valueFormat
containing 'a', which
* stands for day period string.
* Default value is taken from browser's locale setting.
* @returns {string} Value of property localeId
*/
public getLocaleId(): string;
/**
* Returns a metadata object for class sap.m.TimePicker.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinutesStep minutesStep}.
*
* Sets the minutes slider step.
* The minutes slider is populated only by multiples of the step.
*
* Default value is 1
.
* @returns {number} Value of property minutesStep
*/
public getMinutesStep(): number;
/**
* Gets current value of property {@link #getSecondsStep secondsStep}.
*
* Sets the seconds slider step.
* The seconds slider is populated only by multiples of the step.
*
* Default value is 1
.
* @returns {number} Value of property secondsStep
*/
public getSecondsStep(): number;
/**
* Gets current value of property {@link #getTitle title}.
*
* Displays the text of the general picker label and is read by screen readers.
* It is visible only on phone.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getValueFormat valueFormat}.
*
* Determines the format of the value property.
*
* The default value is the browser's medium time format locale setting
* {@link sap.ui.core.LocaleData#getTimePattern}.
* If data binding with type {@link sap.ui.model.type.Time} or {@link sap.ui.model.odata.type.Time}
* is used for the value
property, the valueFormat
property
* is ignored as the information is provided from the binding itself.
* @returns {string} Value of property valueFormat
*/
public getValueFormat(): string;
/**
* Initializes the control.
*/
public init(): void;
/**
* Called after the picker closes.
*/
public onAfterClose(): void;
/**
* Called after the picker appears.
*/
public onAfterOpen(): void;
/**
* Called before the picker appears.
*/
public onBeforeOpen(): void;
/**
* Sets the dateValue
JavaScript date object.
*
* Recommended usage is when value
is not set, as they are mutually exclusive.
* @param {Date} oDate - New date object
* @returns {sap.m.TimePicker|Error} this instance, used for chaining
*/
public setDateValue(oDate: Date): sap.m.TimePicker|Error;
/**
* Sets the displayFormat
.
* @param {string} sDisplayFormat - The format of the string inside the input
* @returns {sap.m.TimePicker} this instance, used for chaining
*/
public setDisplayFormat(sDisplayFormat: string): sap.m.TimePicker;
/**
* Sets the locale of the control.
*
* Used for parsing and formatting the time values in languages different than English.
* Necessary for translation and auto-complete of the day periods, such as AM and PM.
* @param {string} sLocaleId - A locale identifier like 'en_US'
* @returns {sap.m.TimePicker} this instance, used for chaining
*/
public setLocaleId(sLocaleId: string): sap.m.TimePicker;
/**
* Sets the minutes slider step.
* @param {number} iStep - The step used to generate values for the minutes slider
* @returns {sap.m.TimePicker} this
*/
public setMinutesStep(iStep: number): sap.m.TimePicker;
/**
* Sets the seconds slider step.
* @param {number} iStep - The step used to generate values for the seconds slider
* @returns {sap.m.TimePicker} this
*/
public setSecondsStep(iStep: number): sap.m.TimePicker;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Displays the text of the general picker label and is read by screen readers.
* It is visible only on phone.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.m.TimePicker} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.TimePicker;
/**
* Sets tooltip of the control.
* @param {string|sap.ui.core.TooltipBase} vTooltip
*/
public setTooltip(vTooltip: string|sap.ui.core.TooltipBase): void;
/**
* Sets the valueFormat
property.
* @param {string} sValueFormat - The format of strings that are set as value to the control
* @returns {sap.m.TimePicker} this instance, used for chaining
*/
public setValueFormat(sValueFormat: string): sap.m.TimePicker;
}
/**
* The Title control represents a single line of text with explicit header / title semantics.
*/
export class Title extends sap.ui.core.Control {
/**
* Constructor for a new Title control.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.Title with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getLevel level}.
*
* Defines the semantic level of the title.
* This information is e.g. used by assistive technologies like screenreaders to create a hierarchical site map for faster navigation.
* Depending on this setting either an HTML h1-h6 element is used or when using level Auto
no explicit level information is written (HTML5 header element).
* This property does not influence the style of the control. Use the property titleStyle
for this purpose instead.
*
* Default value is Auto
.
* @returns {sap.ui.core.TitleLevel} Value of property level
*/
public getLevel(): sap.ui.core.TitleLevel;
/**
* Returns a metadata object for class sap.m.Title.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* Defines the text which should be displayed as a title.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextAlign textAlign}.
*
* Defines the alignment of the text within the title. Note: This property only has an effect if the overall width of the title control is
* larger than the displayed text.
*
* Default value is Initial
.
* @returns {sap.ui.core.TextAlign} Value of property textAlign
*/
public getTextAlign(): sap.ui.core.TextAlign;
/**
* ID of the element which is the current target of the association {@link #getTitle title}, or null
.
* @returns {sap.ui.core.ID}
*/
public getTitle(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getTitleStyle titleStyle}.
*
* Defines the style of the title.
* When using the Auto
styling, the appearance of the title depends on the current position of the title (e.g. inside a Toolbar
).
* This default behavior can be overridden by setting a different style explicitly.
* The actual appearance of the title and the different styles always depends on the theme being used.
*
* Default value is Auto
.
* @returns {sap.ui.core.TitleLevel} Value of property titleStyle
*/
public getTitleStyle(): sap.ui.core.TitleLevel;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the title.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getLevel level}.
*
* Defines the semantic level of the title.
* This information is e.g. used by assistive technologies like screenreaders to create a hierarchical site map for faster navigation.
* Depending on this setting either an HTML h1-h6 element is used or when using level Auto
no explicit level information is written (HTML5 header element).
* This property does not influence the style of the control. Use the property titleStyle
for this purpose instead.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.ui.core.TitleLevel} sLevel - New value for property level
* @returns {sap.m.Title} Reference to this
in order to allow method chaining
*/
public setLevel(sLevel: sap.ui.core.TitleLevel): sap.m.Title;
/**
* Sets a new value for property {@link #getText text}.
*
* Defines the text which should be displayed as a title.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.m.Title} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.Title;
/**
* Sets a new value for property {@link #getTextAlign textAlign}.
*
* Defines the alignment of the text within the title. Note: This property only has an effect if the overall width of the title control is
* larger than the displayed text.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Initial
.
* @param {sap.ui.core.TextAlign} sTextAlign - New value for property textAlign
* @returns {sap.m.Title} Reference to this
in order to allow method chaining
*/
public setTextAlign(sTextAlign: sap.ui.core.TextAlign): sap.m.Title;
/**
* Sets the associated {@link #getTitle title}.
* @param {sap.ui.core.ID|sap.ui.core.Title} oTitle - ID of an element which becomes the new target of this title association; alternatively, an element instance may be given
* @returns {sap.m.Title} Reference to this
in order to allow method chaining
*/
public setTitle(oTitle: sap.ui.core.ID|sap.ui.core.Title): sap.m.Title;
/**
* Sets a new value for property {@link #getTitleStyle titleStyle}.
*
* Defines the style of the title.
* When using the Auto
styling, the appearance of the title depends on the current position of the title (e.g. inside a Toolbar
).
* This default behavior can be overridden by setting a different style explicitly.
* The actual appearance of the title and the different styles always depends on the theme being used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.ui.core.TitleLevel} sTitleStyle - New value for property titleStyle
* @returns {sap.m.Title} Reference to this
in order to allow method chaining
*/
public setTitleStyle(sTitleStyle: sap.ui.core.TitleLevel): sap.m.Title;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the title.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.Title} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.Title;
}
/**
* The ToggleButton Control is a Button that can be toggled between pressed and normal state
*/
export class ToggleButton extends sap.m.Button {
/**
* Constructor for a new ToggleButton.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.ToggleButton with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.Button.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Returns a metadata object for class sap.m.ToggleButton.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPressed pressed}.
*
* The property is “true” when the control is toggled. The default state of this property is "false".
*
* Default value is false
.
* @returns {boolean} Value of property pressed
*/
public getPressed(): boolean;
/**
* Sets a new value for property {@link #getPressed pressed}.
*
* The property is “true” when the control is toggled. The default state of this property is "false".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bPressed - New value for property pressed
* @returns {sap.m.ToggleButton} Reference to this
in order to allow method chaining
*/
public setPressed(bPressed: boolean): sap.m.ToggleButton;
}
/**
* Overview
* Tokens are small items of information (similar to tags) that mainly serve to visualize previously selected items.
* Tokens are manipulated by a {@link sap.m.Tokenizer Tokenizer}.
* Structure
* The tokens store single text items or sometimes key-value pairs, such as "John Miller (ID1234567)".
* Each token also contains a delete icon, which is invisible if the token is in edit mode.
*
* Usage
* When to use:
* Tokens can only be used with the Tokenizer as a container.
*/
export class Token {
/**
* Constructor for a new Token.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Token;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Token;
/**
* Attaches event handler fnFunction
to the {@link #event:delete delete} event of this sap.m.Token
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Token
itself.
*
* This event is fired if the user clicks the token's delete icon.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Token
itself
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public attachDelete(fnFunction: Function, oListener?: any): sap.m.Token;
/**
* Attaches event handler fnFunction
to the {@link #event:delete delete} event of this sap.m.Token
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Token
itself.
*
* This event is fired if the user clicks the token's delete icon.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Token
itself
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public attachDelete(oData: any, fnFunction: Function, oListener?: any): sap.m.Token;
/**
* Attaches event handler fnFunction
to the {@link #event:deselect deselect} event of this sap.m.Token
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Token
itself.
*
* This event is fired when the token gets deselected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Token
itself
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public attachDeselect(fnFunction: Function, oListener?: any): sap.m.Token;
/**
* Attaches event handler fnFunction
to the {@link #event:deselect deselect} event of this sap.m.Token
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Token
itself.
*
* This event is fired when the token gets deselected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Token
itself
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public attachDeselect(oData: any, fnFunction: Function, oListener?: any): sap.m.Token;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.Token
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Token
itself.
*
* This event is fired when the user clicks on the token.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Token
itself
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.Token;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.Token
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Token
itself.
*
* This event is fired when the user clicks on the token.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Token
itself
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.Token;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.Token
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Token
itself.
*
* This event is fired when the token gets selected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Token
itself
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.m.Token;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.m.Token
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Token
itself.
*
* This event is fired when the token gets selected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Token
itself
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.m.Token;
/**
* Detaches event handler fnFunction
from the {@link #event:delete delete} event of this sap.m.Token
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public detachDelete(fnFunction: Function, oListener: any): sap.m.Token;
/**
* Detaches event handler fnFunction
from the {@link #event:deselect deselect} event of this sap.m.Token
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public detachDeselect(fnFunction: Function, oListener: any): sap.m.Token;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.Token
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.Token;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.m.Token
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.m.Token;
/**
* Creates a new subclass of class sap.m.Token with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:delete delete} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
protected fireDelete(mParameters?: any): sap.m.Token;
/**
* Fires event {@link #event:deselect deselect} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
protected fireDeselect(mParameters?: any): sap.m.Token;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.Token;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.m.Token;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEditable editable}.
*
* Indicates the editable status of the token. If it is set to true
, token displays a delete icon.
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getKey key}.
*
* Key of the token.
*
* Default value is
.
* @returns {string} Value of property key
*/
public getKey(): string;
/**
* Returns a metadata object for class sap.m.Token.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSelected selected}.
*
* Indicates the current selection status of the token.
*
* Default value is false
.
* @returns {boolean} Value of property selected
*/
public getSelected(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* Displayed text of the token.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* This property specifies the text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets the editable status of the token.
* @param {boolean} bEditable - Indicates if the token is editable.
* @returns {sap.m.Token} this for chaining
*/
public setEditable(bEditable: boolean): sap.m.Token;
/**
* Sets a new value for property {@link #getKey key}.
*
* Key of the token.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sKey - New value for property key
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public setKey(sKey: string): sap.m.Token;
/**
* Sets the selection status of the token.
* @param {boolean} bSelected - Indicates if the token is selected.
* @returns {sap.m.Token} this for chaining
*/
public setSelected(bSelected: boolean): sap.m.Token;
/**
* Sets a new value for property {@link #getText text}.
*
* Displayed text of the token.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sText - New value for property text
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.m.Token;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* This property specifies the text directionality with enumerated options. By default, the control inherits text direction from the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.m.Token} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.m.Token;
}
/**
* Overview
* A tokenizer is a container for {@link sap.m.Token Tokens}. It also handles all actions associated with the tokens like adding, deleting, selecting and editing.
* Structure
* The tokens are stored in the tokens
aggregation.
* The tokenizer can determine, by setting the editable
property, whether the tokens in it are editable.
* Still the Token itself can determine if it is editable
. This allows you to have non-editable Tokens in an editable Tokenizer.
*
* Usage
* When to use:
* The tokenizer can only be used as part of {@link sap.m.MultiComboBox MultiComboBox},{@link sap.m.MultiInput MultiInput} or {@link sap.ui.comp.valuehelpdialog.ValueHelpDialog ValueHelpDialog}
*/
export class Tokenizer {
/**
* Constructor for a new Tokenizer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Function removes all selected tokens
* @returns {sap.m.Tokenizer} - this for chaining
*/
public _removeSelectedTokens(): sap.m.Tokenizer;
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.m.Tokenizer} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Tokenizer;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.Tokenizer} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Tokenizer;
/**
* Adds some token to the aggregation {@link #getTokens tokens}.
* @param {sap.m.Token} oToken - the token to add; if empty, nothing is inserted
* @returns {sap.m.Tokenizer} Reference to this
in order to allow method chaining
*/
public addToken(oToken: sap.m.Token): sap.m.Tokenizer;
/**
* Function validates the given text and adds a new token if validation was successful
* @param {any} oParameters - parameter bag containing following fields: {sap.m.String} text - the source text {sap.m.Token} [optional] token - a suggested token {object} [optional] suggestionObject - any object used to find the suggested token {function} [optional] validationCallback - callback which gets called after validation has finished
*/
public addValidateToken(oParameters: any): void;
/**
* Function adds a validation callback called before any new token gets added to the tokens aggregation
* @param {Function} fValidator
*/
public addValidator(fValidator: Function): void;
/**
* Attaches event handler fnFunction
to the {@link #event:tokenChange tokenChange} event of this sap.m.Tokenizer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Tokenizer
itself.
*
* fired when the tokens aggregation changed (add / remove token)
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Tokenizer
itself
* @returns {sap.m.Tokenizer} Reference to this
in order to allow method chaining
*/
public attachTokenChange(fnFunction: Function, oListener?: any): sap.m.Tokenizer;
/**
* Attaches event handler fnFunction
to the {@link #event:tokenChange tokenChange} event of this sap.m.Tokenizer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Tokenizer
itself.
*
* fired when the tokens aggregation changed (add / remove token)
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Tokenizer
itself
* @returns {sap.m.Tokenizer} Reference to this
in order to allow method chaining
*/
public attachTokenChange(oData: any, fnFunction: Function, oListener?: any): sap.m.Tokenizer;
/**
* Attaches event handler fnFunction
to the {@link #event:tokenUpdate tokenUpdate} event of this sap.m.Tokenizer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Tokenizer
itself.
*
* Fired when the tokens aggregation changed (add / remove token)
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Tokenizer
itself
* @returns {sap.m.Tokenizer} Reference to this
in order to allow method chaining
*/
public attachTokenUpdate(fnFunction: Function, oListener?: any): sap.m.Tokenizer;
/**
* Attaches event handler fnFunction
to the {@link #event:tokenUpdate tokenUpdate} event of this sap.m.Tokenizer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Tokenizer
itself.
*
* Fired when the tokens aggregation changed (add / remove token)
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Tokenizer
itself
* @returns {sap.m.Tokenizer} Reference to this
in order to allow method chaining
*/
public attachTokenUpdate(oData: any, fnFunction: Function, oListener?: any): sap.m.Tokenizer;
/**
* Destroys all the tokens in the aggregation {@link #getTokens tokens}.
* @returns {sap.m.Tokenizer} Reference to this
in order to allow method chaining
*/
public destroyTokens(): sap.m.Tokenizer;
/**
* Detaches event handler fnFunction
from the {@link #event:tokenChange tokenChange} event of this sap.m.Tokenizer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Tokenizer} Reference to this
in order to allow method chaining
*/
public detachTokenChange(fnFunction: Function, oListener: any): sap.m.Tokenizer;
/**
* Detaches event handler fnFunction
from the {@link #event:tokenUpdate tokenUpdate} event of this sap.m.Tokenizer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Tokenizer} Reference to this
in order to allow method chaining
*/
public detachTokenUpdate(fnFunction: Function, oListener: any): sap.m.Tokenizer;
/**
* Creates a new subclass of class sap.m.Tokenizer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:tokenChange tokenChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Tokenizer} Reference to this
in order to allow method chaining
*/
protected fireTokenChange(mParameters?: any): sap.m.Tokenizer;
/**
* Fires event {@link #event:tokenUpdate tokenUpdate} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Tokenizer} Reference to this
in order to allow method chaining
*/
protected fireTokenUpdate(mParameters?: any): sap.m.Tokenizer;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEditable editable}.
*
* true if tokens shall be editable otherwise false
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Returns a metadata object for class sap.m.Tokenizer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Function returns the internally used scroll delegate
* @returns {sap.ui.core.delegate.ScrollEnablement}
*/
public getScrollDelegate(): sap.ui.core.delegate.ScrollEnablement;
/**
* Function returns the tokens' width
* @returns {any} the complete tokens' width
*/
public getScrollWidth(): any;
/**
* Function returns all currently selected tokens
* @returns {sap.m.Token[]} - array of selected tokens or empty array
*/
public getSelectedTokens(): sap.m.Token[];
/**
* Gets content of aggregation {@link #getTokens tokens}.
*
* the currently displayed tokens
* @returns {sap.m.Token[]}
*/
public getTokens(): sap.m.Token[];
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the Tokenizer.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.m.Token
in the aggregation {@link #getTokens tokens}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Token} oToken - The token whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfToken(oToken: sap.m.Token): number;
/**
* Inserts a token into the aggregation {@link #getTokens tokens}.
* @param {sap.m.Token} oToken - the token to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the token should be inserted at; for a negative value of iIndex
, the token is inserted at position 0; for a value greater than the current size of the aggregation, the token is inserted at the last position
* @returns {sap.m.Tokenizer} Reference to this
in order to allow method chaining
*/
public insertToken(oToken: sap.m.Token, iIndex: number): sap.m.Tokenizer;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getTokens tokens}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Token[]} An array of the removed elements (might be empty)
*/
public removeAllTokens(): sap.m.Token[];
/**
* Function removes all validation callbacks
*/
public removeAllValidators(): void;
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a token from the aggregation {@link #getTokens tokens}.
* @param {number|string|sap.m.Token} vToken - The token to remove or its index or id
* @returns {sap.m.Token} The removed token or null
*/
public removeToken(vToken: number|string|sap.m.Token): sap.m.Token;
/**
* Function removes a validation callback
* @param {Function} fValidator
*/
public removeValidator(fValidator: Function): void;
/**
* Function scrolls the tokens to the end
*/
public scrollToEnd(): void;
/**
* Function scrolls the tokens to the start
*/
public scrollToStart(): void;
/**
* Function selects all tokens
* @param {boolean} optional - bSelect - true for selecting, false for deselecting
* @returns {sap.m.Tokenizer} - this for chaining
*/
public selectAllTokens(optional?: boolean): sap.m.Tokenizer;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* true if tokens shall be editable otherwise false
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.m.Tokenizer} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.m.Tokenizer;
/**
* Function sets the tokenizer's width in pixels
* @param {number} nWidth - the new width in pixels
*/
public setPixelWidth(nWidth: number): void;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the Tokenizer.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.Tokenizer} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.Tokenizer;
}
/**
* The Toolbar control is a horizontal container that is most commonly used to display buttons, labels, selects and various other input controls.
*
* By default, Toolbar items are shrinkable if they have percent-based width (e.g. Input, Slider) or implement the {@link sap.ui.core.IShrinkable} interface (e.g. Text, Label). This behavior can be overridden by providing {@link sap.m.ToolbarLayoutData} for the Toolbar items.
*
* Note: It is recommended that you use {@link sap.m.OverflowToolbar} over Toolbar, unless you want to avoid overflow in favor of shrinking.
*/
export class Toolbar extends sap.ui.core.Control {
/**
* Sets classes according to the context of the page. Possible contexts are header, footer and subheader.
*/
protected _applyContextClassFor: any;
/**
* Sets HTML tag according to the context of the page. Possible contexts are header, footer and subheader.
*/
protected _applyTag: any;
/**
* Sets classes and HTML tag according to the context of the page. Possible contexts are header, footer, subheader
*/
protected applyTagAndContextClassFor: any;
/**
* Gets the HTML tag of the root domref
*/
protected getHTMLTag: any;
/**
* Returns if the bar is sensitive to the container context. Implementation of the IBar interface
*/
protected isContextSensitive: any;
/**
* Sets the HTML tag of the root domref
*/
protected setHTMLTag: any;
/**
* Constructor for a new Toolbar.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.m.Toolbar} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.m.Toolbar;
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.Toolbar} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.Toolbar;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.Toolbar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Toolbar
itself.
*
* Fired when the user clicks on the toolbar, if the Active property is set to "true".
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Toolbar
itself
* @returns {sap.m.Toolbar} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.m.Toolbar;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.m.Toolbar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Toolbar
itself.
*
* Fired when the user clicks on the toolbar, if the Active property is set to "true".
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Toolbar
itself
* @returns {sap.m.Toolbar} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.m.Toolbar;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.Toolbar} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.Toolbar;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.m.Toolbar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Toolbar} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.m.Toolbar;
/**
* Creates a new subclass of class sap.m.Toolbar with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Toolbar} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.m.Toolbar;
/**
* Gets current value of property {@link #getActive active}.
*
* Indicates that the whole toolbar is clickable. The Press event is fired only if Active is set to true.
* Note: This property should be used when there are no interactive controls inside the toolbar and the toolbar itself is meant to be interactive.
*
* Default value is false
.
* @returns {boolean} Value of property active
*/
public getActive(): boolean;
/**
* Returns the currently applied design property of the Toolbar.
* @returns {sap.m.ToolbarDesign}
*/
protected getActiveDesign(): sap.m.ToolbarDesign;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content of the toolbar.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getDesign design}.
*
* Defines the toolbar design.
* Note: Design settings are theme-dependent. They also determine the default height of the toolbar.
*
* Default value is Auto
.
* @returns {sap.m.ToolbarDesign} Value of property design
*/
public getDesign(): sap.m.ToolbarDesign;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Sets the enabled property of all controls defined in the content aggregation.
* Note: This property does not apply to the toolbar itself, but rather to its items.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* Defines the height of the control.
* Note: By default, the Height property depends on the used theme and the Design property.
*
* Default value is
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.m.Toolbar.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the first sap.m.Title control instance inside the toolbar for the accessibility
* @returns {sap.m.Title|any}
*/
protected getTitleControl(): sap.m.Title|any;
/**
* Returns the first sap.m.Title control id inside the toolbar for the accessibility
* @returns {string}
*/
protected getTitleId(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the control.
* By default, Toolbar is a block element. If the the width is not explicitly set, the control will assume its natural size.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.Toolbar} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.Toolbar;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getActive active}.
*
* Indicates that the whole toolbar is clickable. The Press event is fired only if Active is set to true.
* Note: This property should be used when there are no interactive controls inside the toolbar and the toolbar itself is meant to be interactive.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bActive - New value for property active
* @returns {sap.m.Toolbar} Reference to this
in order to allow method chaining
*/
public setActive(bActive: boolean): sap.m.Toolbar;
/**
* Sets a new value for property {@link #getDesign design}.
*
* Defines the toolbar design.
* Note: Design settings are theme-dependent. They also determine the default height of the toolbar.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.m.ToolbarDesign} sDesign - New value for property design
* @returns {sap.m.Toolbar} Reference to this
in order to allow method chaining
*/
public setDesign(sDesign: sap.m.ToolbarDesign): sap.m.Toolbar;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Sets the enabled property of all controls defined in the content aggregation.
* Note: This property does not apply to the toolbar itself, but rather to its items.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.m.Toolbar} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.m.Toolbar;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Defines the height of the control.
* Note: By default, the Height property depends on the used theme and the Design property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.m.Toolbar} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.m.Toolbar;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the control.
* By default, Toolbar is a block element. If the the width is not explicitly set, the control will assume its natural size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.Toolbar} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.Toolbar;
}
/**
* Types of the Toolbar Design.
*/
export enum ToolbarDesign {
/**
* The toolbar can be inserted into other controls and if the design is "Auto" then it inherits the design from parent control.
*/
Auto = "Auto",
/**
* The toolbar appears smaller than the regular size to show information(e.g: text, icon).
*/
Info = "Info",
/**
* The toolbar has a solid background. Its content will be rendered in a standard way.
*/
Solid = "Solid",
/**
* The toolbar and its content will be displayed transparent.
*/
Transparent = "Transparent",
}
/**
* Defines layout data for the toolbar items.
*/
export class ToolbarLayoutData extends sap.ui.core.LayoutData {
/**
* Constructor for a new ToolbarLayoutData.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.ToolbarLayoutData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.LayoutData.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getMaxWidth maxWidth}.
*
* Sets the maximum width of the toolbar item.
* @returns {sap.ui.core.CSSSize} Value of property maxWidth
*/
public getMaxWidth(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.m.ToolbarLayoutData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinWidth minWidth}.
*
* Sets the minimum width of the toolbar item.
* @returns {sap.ui.core.CSSSize} Value of property minWidth
*/
public getMinWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getShrinkable shrinkable}.
*
* Determines whether the control, when in a toolbar, is shrinkable or not. For controls with fixed width (100px, 5rem, etc...) this property is ignored.
*
* Note: Nested layout controls should not be shrinkable.
*
* Default value is false
.
* @returns {boolean} Value of property shrinkable
*/
public getShrinkable(): boolean;
/**
* Sets a new value for property {@link #getMaxWidth maxWidth}.
*
* Sets the maximum width of the toolbar item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sMaxWidth - New value for property maxWidth
* @returns {sap.m.ToolbarLayoutData} Reference to this
in order to allow method chaining
*/
public setMaxWidth(sMaxWidth: sap.ui.core.CSSSize): sap.m.ToolbarLayoutData;
/**
* Sets a new value for property {@link #getMinWidth minWidth}.
*
* Sets the minimum width of the toolbar item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sMinWidth - New value for property minWidth
* @returns {sap.m.ToolbarLayoutData} Reference to this
in order to allow method chaining
*/
public setMinWidth(sMinWidth: sap.ui.core.CSSSize): sap.m.ToolbarLayoutData;
/**
* Sets a new value for property {@link #getShrinkable shrinkable}.
*
* Determines whether the control, when in a toolbar, is shrinkable or not. For controls with fixed width (100px, 5rem, etc...) this property is ignored.
*
* Note: Nested layout controls should not be shrinkable.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShrinkable - New value for property shrinkable
* @returns {sap.m.ToolbarLayoutData} Reference to this
in order to allow method chaining
*/
public setShrinkable(bShrinkable: boolean): sap.m.ToolbarLayoutData;
}
/**
* Creates a visual separator (theme dependent: padding, margin, line) between the preceding and succeeding toolbar item.
*/
export class ToolbarSeparator extends sap.ui.core.Control {
/**
* Constructor for a new ToolbarSeparator.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.ToolbarSeparator with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.ToolbarSeparator.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* This control can be used to add horizontal space between toolbar items.
* Note: ToolbarLayoutData should not be used with this control.
*/
export class ToolbarSpacer extends sap.ui.core.Control {
/**
* Flexible Spacer Class Name
*/
protected static flexClass: any;
/**
* Constructor for a new ToolbarSpacer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.ToolbarSpacer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.ToolbarSpacer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the horizontal space.
* Note: Empty("") value makes the space flexible which means it covers the remaining space between toolbar items.
* This feature can be used to push next item to the edge of the toolbar.
*
* Default value is
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the horizontal space.
* Note: Empty("") value makes the space flexible which means it covers the remaining space between toolbar items.
* This feature can be used to push next item to the edge of the toolbar.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.ToolbarSpacer} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.ToolbarSpacer;
}
/**
* Touch helper.
*/
namespace touch {
/**
* Given a list of touches, count the number of touches related with the given element.
* @param {TouchList} oTouchList - The list of touch objects to search.
* @param {JQuery|Element|string} vElement - A jQuery element or an element reference or an element id.
* @returns {number} The number of touches related with the given element.
*/
function countContained(oTouchList: TouchList, vElement: JQuery|Element|string): number;
/**
* Given a list of touch objects, find the touch that matches the given one.
* @param {TouchList} oTouchList - The list of touch objects to search.
* @param {Touch|number} oTouch - A touch object to find or a Touch.identifier that uniquely identifies the current finger in the touch session.
* @returns {any|any} The touch matching if any.
*/
function find(oTouchList: TouchList, oTouch: Touch|number): any|any;
}
/**
* The Tree
control provides a tree structure for displaying data in a hierarchy.
* Note: Growing feature is not supported by Tree
.
*/
export class Tree extends sap.m.ListBase {
/**
* Constructor for a new Tree.
* @param {string} sId - ID for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Collapses all nodes.
* @returns {sap.m.Tree} A reference to the Tree control
*/
public collapseAll(): sap.m.Tree;
/**
* Defines the level to which the tree is expanded.
* The function can be used to define the initial expanding state. An alternative way to define the initial expanding state is to set the parameter numberOfExpandedLevels
of the binding.
*
* Example:
*
* oTree.bindItems({
* path: "...",
* parameters: {
* numberOfExpandedLevels: 1
* }
* });
*
* @param {number} iLevel - The level to which the data is expanded
* @returns {sap.m.Tree} A reference to the Tree control
*/
public expandToLevel(iLevel: number): sap.m.Tree;
/**
* Creates a new subclass of class sap.m.Tree with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ListBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.Tree.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* The enableBusyIndicator
property is not supported for control Tree
.
* @returns {sap.m.Tree}
*/
public setEnableBusyIndicator(): sap.m.Tree;
/**
* The growing
property is not supported for control Tree
.
* @returns {sap.m.Tree}
*/
public setGrowing(): sap.m.Tree;
/**
* The growingDirection
property is not supported for control Tree
.
* @returns {sap.m.Tree}
*/
public setGrowingDirection(): sap.m.Tree;
/**
* The growingScrollToLoad
property is not supported for control Tree
.
* @returns {sap.m.Tree}
*/
public setGrowingScrollToLoad(): sap.m.Tree;
/**
* The growingThreshold
property is not supported for control Tree
.
* @returns {sap.m.Tree}
*/
public setGrowingThreshold(): sap.m.Tree;
/**
* The growingTriggerText
property is not supported for control Tree
.
* @returns {sap.m.Tree}
*/
public setGrowingTriggerText(): sap.m.Tree;
}
/**
* The sap.m.TreeItemBase
contains the basic features of all specific tree items.
*/
export class TreeItemBase extends sap.m.ListItemBase {
/**
* Constructor for a new TreeItemBase.
* @param {string} sId - ID for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.TreeItemBase with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ListItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets the expanding information of the node.
* @returns {boolean}
*/
public getExpanded(): boolean;
/**
* Gets the context of the node.
* @returns {Object}
*/
public getItemNodeContext(): Object;
/**
* Gets the node level in the hierarchy.
* @returns {number}
*/
public getLevel(): number;
/**
* Returns a metadata object for class sap.m.TreeItemBase.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets the parent node control.
* @returns {sap.m.TreeItemBase|any}
*/
public getParentNode(): sap.m.TreeItemBase|any;
/**
* Gets the context of the parent node control.
* @returns {Object}
*/
public getParentNodeContext(): Object;
/**
* Determines if the node is a leaf.
* @returns {boolean}
*/
public isLeaf(): boolean;
/**
* Checks if the node is the top level node.
* @returns {boolean}
*/
public isTopLevel(): boolean;
}
/**
* This control allows you to upload single or multiple files from your devices (desktop, tablet or phone) and attach them to the application.
*
* The consuming application needs to take into account that the consistency checks of the model during the upload of the file need to be performed, for example, if the user is editing or deleting a file.
*/
export class UploadCollection extends sap.ui.core.Control {
/**
* Constructor for a new UploadCollection.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some headerParameter to the aggregation {@link #getHeaderParameters headerParameters}.
* @param {sap.m.UploadCollectionParameter} oHeaderParameter - the headerParameter to add; if empty, nothing is inserted
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public addHeaderParameter(oHeaderParameter: sap.m.UploadCollectionParameter): sap.m.UploadCollection;
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.m.UploadCollectionItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.m.UploadCollectionItem): sap.m.UploadCollection;
/**
* Adds some parameter to the aggregation {@link #getParameters parameters}.
* @param {sap.m.UploadCollectionParameter} oParameter - the parameter to add; if empty, nothing is inserted
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public addParameter(oParameter: sap.m.UploadCollectionParameter): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeUploadStarts beforeUploadStarts} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered before the actual upload starts. An event is fired per file. All the necessary header parameters should be set here.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachBeforeUploadStarts(fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeUploadStarts beforeUploadStarts} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered before the actual upload starts. An event is fired per file. All the necessary header parameters should be set here.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachBeforeUploadStarts(oData: any, fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered when files are selected in the FileUploader dialog. Applications can set parameters and headerParameters which will be dispatched to the embedded FileUploader control.
* Limitation: parameters and headerParameters are not supported by Internet Explorer 9.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered when files are selected in the FileUploader dialog. Applications can set parameters and headerParameters which will be dispatched to the embedded FileUploader control.
* Limitation: parameters and headerParameters are not supported by Internet Explorer 9.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:fileDeleted fileDeleted} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered when an uploaded attachment is selected and the Delete button is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachFileDeleted(fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:fileDeleted fileDeleted} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered when an uploaded attachment is selected and the Delete button is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachFileDeleted(oData: any, fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:filenameLengthExceed filenameLengthExceed} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered when the name of a chosen file is longer than the value specified with the maximumFilenameLength property (only if provided by the application).
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachFilenameLengthExceed(fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:filenameLengthExceed filenameLengthExceed} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered when the name of a chosen file is longer than the value specified with the maximumFilenameLength property (only if provided by the application).
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachFilenameLengthExceed(oData: any, fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:fileRenamed fileRenamed} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered when the file name is changed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachFileRenamed(fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:fileRenamed fileRenamed} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered when the file name is changed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachFileRenamed(oData: any, fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:fileSizeExceed fileSizeExceed} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered when the file size of an uploaded file is exceeded (only if the maxFileSize property was provided by the application).
* This event is not supported by Internet Explorer 9.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachFileSizeExceed(fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:fileSizeExceed fileSizeExceed} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered when the file size of an uploaded file is exceeded (only if the maxFileSize property was provided by the application).
* This event is not supported by Internet Explorer 9.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachFileSizeExceed(oData: any, fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChange selectionChange} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* Fires when selection is changed via user interaction inside the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachSelectionChange(fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChange selectionChange} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* Fires when selection is changed via user interaction inside the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachSelectionChange(oData: any, fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:typeMissmatch typeMissmatch} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered when the file type or the MIME type don't match the permitted types (only if the fileType property or the mimeType property are provided by the application).
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachTypeMissmatch(fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:typeMissmatch typeMissmatch} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered when the file type or the MIME type don't match the permitted types (only if the fileType property or the mimeType property are provided by the application).
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachTypeMissmatch(oData: any, fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:uploadComplete uploadComplete} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered as soon as the upload request is completed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachUploadComplete(fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:uploadComplete uploadComplete} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered as soon as the upload request is completed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachUploadComplete(oData: any, fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:uploadTerminated uploadTerminated} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered as soon as the upload request was terminated by the user.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachUploadTerminated(fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Attaches event handler fnFunction
to the {@link #event:uploadTerminated uploadTerminated} event of this sap.m.UploadCollection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.UploadCollection
itself.
*
* The event is triggered as soon as the upload request was terminated by the user.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.UploadCollection
itself
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public attachUploadTerminated(oData: any, fnFunction: Function, oListener?: any): sap.m.UploadCollection;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.m.UploadCollection;
/**
* Destroys all the headerParameters in the aggregation {@link #getHeaderParameters headerParameters}.
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public destroyHeaderParameters(): sap.m.UploadCollection;
/**
* Destroys the infoToolbar in the aggregation {@link #getInfoToolbar infoToolbar}.
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public destroyInfoToolbar(): sap.m.UploadCollection;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.UploadCollection;
/**
* Destroys all the parameters in the aggregation {@link #getParameters parameters}.
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public destroyParameters(): sap.m.UploadCollection;
/**
* Destroys the toolbar in the aggregation {@link #getToolbar toolbar}.
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public destroyToolbar(): sap.m.UploadCollection;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeUploadStarts beforeUploadStarts} event of this sap.m.UploadCollection
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public detachBeforeUploadStarts(fnFunction: Function, oListener: any): sap.m.UploadCollection;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.m.UploadCollection
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.m.UploadCollection;
/**
* Detaches event handler fnFunction
from the {@link #event:fileDeleted fileDeleted} event of this sap.m.UploadCollection
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public detachFileDeleted(fnFunction: Function, oListener: any): sap.m.UploadCollection;
/**
* Detaches event handler fnFunction
from the {@link #event:filenameLengthExceed filenameLengthExceed} event of this sap.m.UploadCollection
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public detachFilenameLengthExceed(fnFunction: Function, oListener: any): sap.m.UploadCollection;
/**
* Detaches event handler fnFunction
from the {@link #event:fileRenamed fileRenamed} event of this sap.m.UploadCollection
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public detachFileRenamed(fnFunction: Function, oListener: any): sap.m.UploadCollection;
/**
* Detaches event handler fnFunction
from the {@link #event:fileSizeExceed fileSizeExceed} event of this sap.m.UploadCollection
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public detachFileSizeExceed(fnFunction: Function, oListener: any): sap.m.UploadCollection;
/**
* Detaches event handler fnFunction
from the {@link #event:selectionChange selectionChange} event of this sap.m.UploadCollection
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public detachSelectionChange(fnFunction: Function, oListener: any): sap.m.UploadCollection;
/**
* Detaches event handler fnFunction
from the {@link #event:typeMissmatch typeMissmatch} event of this sap.m.UploadCollection
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public detachTypeMissmatch(fnFunction: Function, oListener: any): sap.m.UploadCollection;
/**
* Detaches event handler fnFunction
from the {@link #event:uploadComplete uploadComplete} event of this sap.m.UploadCollection
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public detachUploadComplete(fnFunction: Function, oListener: any): sap.m.UploadCollection;
/**
* Detaches event handler fnFunction
from the {@link #event:uploadTerminated uploadTerminated} event of this sap.m.UploadCollection
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public detachUploadTerminated(fnFunction: Function, oListener: any): sap.m.UploadCollection;
/**
* Downloads the given item.
* This function delegates to {sap.m.UploadCollectionItem.download}.
* @param {sap.m.UploadCollectionItem} uploadCollectionItem - The item to download. This parameter is mandatory.
* @param {boolean} askForLocation - Decides whether to ask for a location to download or not.
* @returns {boolean} True if the download has started successfully. False if the download couldn't be started.
*/
public downloadItem(uploadCollectionItem: sap.m.UploadCollectionItem, askForLocation: boolean): boolean;
/**
* Creates a new subclass of class sap.m.UploadCollection with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:beforeUploadStarts beforeUploadStarts} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
protected fireBeforeUploadStarts(mParameters?: any): sap.m.UploadCollection;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.m.UploadCollection;
/**
* Fires event {@link #event:fileDeleted fileDeleted} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
protected fireFileDeleted(mParameters?: any): sap.m.UploadCollection;
/**
* Fires event {@link #event:filenameLengthExceed filenameLengthExceed} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
protected fireFilenameLengthExceed(mParameters?: any): sap.m.UploadCollection;
/**
* Fires event {@link #event:fileRenamed fileRenamed} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
protected fireFileRenamed(mParameters?: any): sap.m.UploadCollection;
/**
* Fires event {@link #event:fileSizeExceed fileSizeExceed} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
protected fireFileSizeExceed(mParameters?: any): sap.m.UploadCollection;
/**
* Fires event {@link #event:selectionChange selectionChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
protected fireSelectionChange(mParameters?: any): sap.m.UploadCollection;
/**
* Fires event {@link #event:typeMissmatch typeMissmatch} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
protected fireTypeMissmatch(mParameters?: any): sap.m.UploadCollection;
/**
* Fires event {@link #event:uploadComplete uploadComplete} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
protected fireUploadComplete(mParameters?: any): sap.m.UploadCollection;
/**
* Fires event {@link #event:uploadTerminated uploadTerminated} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
protected fireUploadTerminated(mParameters?: any): sap.m.UploadCollection;
/**
* Gets current value of property {@link #getFileType fileType}.
*
* Defines the allowed file types for the upload.
* The chosen files will be checked against an array of file types.
* If at least one file does not fit the file type requirements, the upload is prevented. Example: ["jpg", "png", "bmp"].
* @returns {string[]} Value of property fileType
*/
public getFileType(): string[];
/**
* Gets content of aggregation {@link #getHeaderParameters headerParameters}.
*
* Specifies the header parameters for the FileUploader that are submitted only with XHR requests.
* Header parameters are not supported by Internet Explorer 8 and 9.
* @returns {sap.m.UploadCollectionParameter[]}
*/
public getHeaderParameters(): sap.m.UploadCollectionParameter[];
/**
* Gets content of aggregation {@link #getInfoToolbar infoToolbar}.
*
* Specifies the info toolbar for filtering information. Sorting information will not displayed.
* @returns {sap.m.Toolbar}
*/
public getInfoToolbar(): sap.m.Toolbar;
/**
* Gets current value of property {@link #getInstantUpload instantUpload}.
*
* If false, no upload is triggered when a file is selected. In addition, if a file was selected, a new FileUploader instance is created to ensure that multiple files from multiple folders can be chosen.
*
* Default value is true
.
* @returns {boolean} Value of property instantUpload
*/
public getInstantUpload(): boolean;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Uploaded items.
* @returns {sap.m.UploadCollectionItem[]}
*/
public getItems(): sap.m.UploadCollectionItem[];
/**
* Gets current value of property {@link #getMaximumFilenameLength maximumFilenameLength}.
*
* Specifies the maximum length of a file name.
* If the maximum file name length is exceeded, the corresponding event 'filenameLengthExceed' is triggered.
* @returns {number} Value of property maximumFilenameLength
*/
public getMaximumFilenameLength(): number;
/**
* Gets current value of property {@link #getMaximumFileSize maximumFileSize}.
*
* Specifies a file size limit in megabytes that prevents the upload if at least one file exceeds the limit.
* This property is not supported by Internet Explorer 8 and 9.
* @returns {number} Value of property maximumFileSize
*/
public getMaximumFileSize(): number;
/**
* Returns a metadata object for class sap.m.UploadCollection.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMimeType mimeType}.
*
* Defines the allowed MIME types of files to be uploaded.
* The chosen files will be checked against an array of MIME types.
* If at least one file does not fit the MIME type requirements, the upload is prevented.
* This property is not supported by Internet Explorer 8 and 9. Example: mimeType ["image/png", "image/jpeg"].
* @returns {string[]} Value of property mimeType
*/
public getMimeType(): string[];
/**
* Gets current value of property {@link #getMode mode}.
*
* Defines the selection mode of the control (e.g. None, SingleSelect, MultiSelect, SingleSelectLeft, SingleSelectMaster).
* Since the UploadCollection reacts like a list for attachments, the API is close to the ListBase Interface.
* sap.m.ListMode.Delete mode is not supported and will be automatically set to sap.m.ListMode.None.
* In addition, if instant upload is set to false the mode sap.m.ListMode.MultiSelect is not supported and will be automatically set to sap.m.ListMode.None.
*
* Default value is None
.
* @returns {sap.m.ListMode} Value of property mode
*/
public getMode(): sap.m.ListMode;
/**
* Gets current value of property {@link #getMultiple multiple}.
*
* Lets the user select multiple files from the same folder and then upload them.
* Internet Explorer 8 and 9 do not support this property.
* Please note that the various operating systems for mobile devices can react differently to the property so that fewer upload functions may be available in some cases.
*
* If multiple property is set to false, the control shows an error message if more than one file is chosen for drag & drop.
*
* Default value is false
.
* @returns {boolean} Value of property multiple
*/
public getMultiple(): boolean;
/**
* Gets current value of property {@link #getNoDataDescription noDataDescription}.
*
* Allows you to set your own text for the 'No data' description label.
* @returns {string} Value of property noDataDescription
*/
public getNoDataDescription(): string;
/**
* Gets current value of property {@link #getNoDataText noDataText}.
*
* Allows you to set your own text for the 'No data' text label.
* @returns {string} Value of property noDataText
*/
public getNoDataText(): string;
/**
* Gets current value of property {@link #getNumberOfAttachmentsText numberOfAttachmentsText}.
*
* Sets the title text in the toolbar of the list of attachments.
* To show as well the number of attachments in brackets like the default text does. The number of attachments could be retrieved via "getItems().length".
* If a new title is set, the default is deactivated.
* The default value is set to language-dependent "Attachments (n)".
* @returns {string} Value of property numberOfAttachmentsText
*/
public getNumberOfAttachmentsText(): string;
/**
* Gets content of aggregation {@link #getParameters parameters}.
*
* Specifies the parameters for the FileUploader that are rendered as a hidden input field.
* @returns {sap.m.UploadCollectionParameter[]}
*/
public getParameters(): sap.m.UploadCollectionParameter[];
/**
* Gets current value of property {@link #getSameFilenameAllowed sameFilenameAllowed}.
*
* Allows the user to use the same name for a file when editing the file name. 'Same name' refers to an already existing file name in the list.
*
* Default value is false
.
* @returns {boolean} Value of property sameFilenameAllowed
*/
public getSameFilenameAllowed(): boolean;
/**
* Returns selected UploadCollectionItem.
* @returns {sap.m.UploadCollectionItem} selected item
*/
public getSelectedItem(): sap.m.UploadCollectionItem;
/**
* Returns an array containing the selected UploadCollectionItems.
* @returns {sap.m.UploadCollectionItem[]} array with selected items
*/
public getSelectedItems(): sap.m.UploadCollectionItem[];
/**
* Gets current value of property {@link #getShowSeparators showSeparators}.
*
* Defines whether separators are shown between list items.
*
* Default value is All
.
* @returns {sap.m.ListSeparators} Value of property showSeparators
*/
public getShowSeparators(): sap.m.ListSeparators;
/**
* Gets current value of property {@link #getTerminationEnabled terminationEnabled}.
*
* If true, the button that is used to terminate the instant file upload gets visible.
* The button normally appears when a file is being uploaded.
*
* Default value is true
.
* @returns {boolean} Value of property terminationEnabled
*/
public getTerminationEnabled(): boolean;
/**
* Gets content of aggregation {@link #getToolbar toolbar}.
*
* Specifies the toolbar.
* @returns {sap.m.OverflowToolbar}
*/
public getToolbar(): sap.m.OverflowToolbar;
/**
* Gets current value of property {@link #getUploadButtonInvisible uploadButtonInvisible}.
*
* If true, the button used for uploading files is invisible.
*
* Default value is false
.
* @returns {boolean} Value of property uploadButtonInvisible
*/
public getUploadButtonInvisible(): boolean;
/**
* Gets current value of property {@link #getUploadEnabled uploadEnabled}.
*
* Enables the upload of a file.
*
* Default value is true
.
* @returns {boolean} Value of property uploadEnabled
*/
public getUploadEnabled(): boolean;
/**
* Gets current value of property {@link #getUploadUrl uploadUrl}.
*
* Specifies the URL where the uploaded files have to be stored.
*
* Default value is ../../../upload
.
* @returns {string} Value of property uploadUrl
*/
public getUploadUrl(): string;
/**
* Checks for the provided sap.m.UploadCollectionParameter
in the aggregation {@link #getHeaderParameters headerParameters}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.UploadCollectionParameter} oHeaderParameter - The headerParameter whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfHeaderParameter(oHeaderParameter: sap.m.UploadCollectionParameter): number;
/**
* Checks for the provided sap.m.UploadCollectionItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.UploadCollectionItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.m.UploadCollectionItem): number;
/**
* Checks for the provided sap.m.UploadCollectionParameter
in the aggregation {@link #getParameters parameters}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.UploadCollectionParameter} oParameter - The parameter whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfParameter(oParameter: sap.m.UploadCollectionParameter): number;
/**
* Inserts a headerParameter into the aggregation {@link #getHeaderParameters headerParameters}.
* @param {sap.m.UploadCollectionParameter} oHeaderParameter - the headerParameter to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the headerParameter should be inserted at; for a negative value of iIndex
, the headerParameter is inserted at position 0; for a value greater than the current size of the aggregation, the headerParameter is inserted at the last position
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public insertHeaderParameter(oHeaderParameter: sap.m.UploadCollectionParameter, iIndex: number): sap.m.UploadCollection;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.m.UploadCollectionItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.m.UploadCollectionItem, iIndex: number): sap.m.UploadCollection;
/**
* Inserts a parameter into the aggregation {@link #getParameters parameters}.
* @param {sap.m.UploadCollectionParameter} oParameter - the parameter to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the parameter should be inserted at; for a negative value of iIndex
, the parameter is inserted at position 0; for a value greater than the current size of the aggregation, the parameter is inserted at the last position
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public insertParameter(oParameter: sap.m.UploadCollectionParameter, iIndex: number): sap.m.UploadCollection;
/**
* Opens the FileUploader dialog. When an UploadCollectionItem is provided, this method can be used to update a file with a new version.
* In this case, the upload progress can be sequenced using the events: beforeUploadStarts, uploadComplete and uploadTerminated. For this use,
* multiple properties from the UploadCollection have to be set to false. If no UploadCollectionItem is provided, only the dialog opens
* and no further configuration of the UploadCollection is needed.
* @param {sap.m.UploadCollectionItem} item - The item to update with a new version. This parameter is mandatory.
* @returns {sap.m.UploadCollection} To ensure method chaining, return the UploadCollection.
*/
public openFileDialog(item: sap.m.UploadCollectionItem): sap.m.UploadCollection;
/**
* Removes all the controls from the aggregation {@link #getHeaderParameters headerParameters}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.UploadCollectionParameter[]} An array of the removed elements (might be empty)
*/
public removeAllHeaderParameters(): sap.m.UploadCollectionParameter[];
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.UploadCollectionItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.m.UploadCollectionItem[];
/**
* Removes all the controls from the aggregation {@link #getParameters parameters}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.UploadCollectionParameter[]} An array of the removed elements (might be empty)
*/
public removeAllParameters(): sap.m.UploadCollectionParameter[];
/**
* Removes a headerParameter from the aggregation {@link #getHeaderParameters headerParameters}.
* @param {number|string|sap.m.UploadCollectionParameter} vHeaderParameter - The headerParameter to remove or its index or id
* @returns {sap.m.UploadCollectionParameter} The removed headerParameter or null
*/
public removeHeaderParameter(vHeaderParameter: number|string|sap.m.UploadCollectionParameter): sap.m.UploadCollectionParameter;
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.m.UploadCollectionItem} vItem - The item to remove or its index or id
* @returns {sap.m.UploadCollectionItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.m.UploadCollectionItem): sap.m.UploadCollectionItem;
/**
* Removes a parameter from the aggregation {@link #getParameters parameters}.
* @param {number|string|sap.m.UploadCollectionParameter} vParameter - The parameter to remove or its index or id
* @returns {sap.m.UploadCollectionParameter} The removed parameter or null
*/
public removeParameter(vParameter: number|string|sap.m.UploadCollectionParameter): sap.m.UploadCollectionParameter;
/**
* Select all items in "MultiSelection" mode.
* @returns {sap.m.UploadCollection} The current UploadCollection
*/
public selectAll(): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getFileType fileType}.
*
* Defines the allowed file types for the upload.
* The chosen files will be checked against an array of file types.
* If at least one file does not fit the file type requirements, the upload is prevented. Example: ["jpg", "png", "bmp"].
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string[]} sFileType - New value for property fileType
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setFileType(sFileType: string[]): sap.m.UploadCollection;
/**
* Sets the aggregated {@link #getInfoToolbar infoToolbar}.
* @param {sap.m.Toolbar} oInfoToolbar - The infoToolbar to set
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setInfoToolbar(oInfoToolbar: sap.m.Toolbar): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getInstantUpload instantUpload}.
*
* If false, no upload is triggered when a file is selected. In addition, if a file was selected, a new FileUploader instance is created to ensure that multiple files from multiple folders can be chosen.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bInstantUpload - New value for property instantUpload
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setInstantUpload(bInstantUpload: boolean): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getMaximumFilenameLength maximumFilenameLength}.
*
* Specifies the maximum length of a file name.
* If the maximum file name length is exceeded, the corresponding event 'filenameLengthExceed' is triggered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iMaximumFilenameLength - New value for property maximumFilenameLength
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setMaximumFilenameLength(iMaximumFilenameLength: number): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getMaximumFileSize maximumFileSize}.
*
* Specifies a file size limit in megabytes that prevents the upload if at least one file exceeds the limit.
* This property is not supported by Internet Explorer 8 and 9.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} fMaximumFileSize - New value for property maximumFileSize
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setMaximumFileSize(fMaximumFileSize: number): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getMimeType mimeType}.
*
* Defines the allowed MIME types of files to be uploaded.
* The chosen files will be checked against an array of MIME types.
* If at least one file does not fit the MIME type requirements, the upload is prevented.
* This property is not supported by Internet Explorer 8 and 9. Example: mimeType ["image/png", "image/jpeg"].
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string[]} sMimeType - New value for property mimeType
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setMimeType(sMimeType: string[]): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getMode mode}.
*
* Defines the selection mode of the control (e.g. None, SingleSelect, MultiSelect, SingleSelectLeft, SingleSelectMaster).
* Since the UploadCollection reacts like a list for attachments, the API is close to the ListBase Interface.
* sap.m.ListMode.Delete mode is not supported and will be automatically set to sap.m.ListMode.None.
* In addition, if instant upload is set to false the mode sap.m.ListMode.MultiSelect is not supported and will be automatically set to sap.m.ListMode.None.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.m.ListMode} sMode - New value for property mode
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setMode(sMode: sap.m.ListMode): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getMultiple multiple}.
*
* Lets the user select multiple files from the same folder and then upload them.
* Internet Explorer 8 and 9 do not support this property.
* Please note that the various operating systems for mobile devices can react differently to the property so that fewer upload functions may be available in some cases.
*
* If multiple property is set to false, the control shows an error message if more than one file is chosen for drag & drop.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bMultiple - New value for property multiple
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setMultiple(bMultiple: boolean): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getNoDataDescription noDataDescription}.
*
* Allows you to set your own text for the 'No data' description label.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sNoDataDescription - New value for property noDataDescription
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setNoDataDescription(sNoDataDescription: string): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getNoDataText noDataText}.
*
* Allows you to set your own text for the 'No data' text label.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sNoDataText - New value for property noDataText
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setNoDataText(sNoDataText: string): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getNumberOfAttachmentsText numberOfAttachmentsText}.
*
* Sets the title text in the toolbar of the list of attachments.
* To show as well the number of attachments in brackets like the default text does. The number of attachments could be retrieved via "getItems().length".
* If a new title is set, the default is deactivated.
* The default value is set to language-dependent "Attachments (n)".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sNumberOfAttachmentsText - New value for property numberOfAttachmentsText
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setNumberOfAttachmentsText(sNumberOfAttachmentsText: string): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getSameFilenameAllowed sameFilenameAllowed}.
*
* Allows the user to use the same name for a file when editing the file name. 'Same name' refers to an already existing file name in the list.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSameFilenameAllowed - New value for property sameFilenameAllowed
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setSameFilenameAllowed(bSameFilenameAllowed: boolean): sap.m.UploadCollection;
/**
* Selects or deselects the given list item.
* @param {sap.m.UploadCollectionItem} uploadCollectionItem - The item whose selection to be changed. This parameter is mandatory.
* @param {boolean} select - Sets selected status of the item. Default value is true.
* @returns {sap.m.UploadCollection} The current UploadCollection
*/
public setSelectedItem(uploadCollectionItem: sap.m.UploadCollectionItem, select: boolean): sap.m.UploadCollection;
/**
* Sets an UploadCollectionItem to be selected by id. In single mode, the method removes the previous selection.
* @param {string} id - The id of the item whose selection to be changed.
* @param {boolean} select - Sets selected status of the item. Default value is true.
* @returns {sap.m.UploadCollection} The current UploadCollection
*/
public setSelectedItemById(id: string, select: boolean): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getShowSeparators showSeparators}.
*
* Defines whether separators are shown between list items.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is All
.
* @param {sap.m.ListSeparators} sShowSeparators - New value for property showSeparators
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setShowSeparators(sShowSeparators: sap.m.ListSeparators): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getTerminationEnabled terminationEnabled}.
*
* If true, the button that is used to terminate the instant file upload gets visible.
* The button normally appears when a file is being uploaded.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bTerminationEnabled - New value for property terminationEnabled
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setTerminationEnabled(bTerminationEnabled: boolean): sap.m.UploadCollection;
/**
* Sets the aggregated {@link #getToolbar toolbar}.
* @param {sap.m.OverflowToolbar} oToolbar - The toolbar to set
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setToolbar(oToolbar: sap.m.OverflowToolbar): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getUploadButtonInvisible uploadButtonInvisible}.
*
* If true, the button used for uploading files is invisible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bUploadButtonInvisible - New value for property uploadButtonInvisible
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setUploadButtonInvisible(bUploadButtonInvisible: boolean): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getUploadEnabled uploadEnabled}.
*
* Enables the upload of a file.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bUploadEnabled - New value for property uploadEnabled
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setUploadEnabled(bUploadEnabled: boolean): sap.m.UploadCollection;
/**
* Sets a new value for property {@link #getUploadUrl uploadUrl}.
*
* Specifies the URL where the uploaded files have to be stored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is ../../../upload
.
* @param {string} sUploadUrl - New value for property uploadUrl
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public setUploadUrl(sUploadUrl: string): sap.m.UploadCollection;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.m.UploadCollection} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.m.UploadCollection;
/**
* Starts the upload for all selected files.
*/
public upload(): void;
}
/**
* Items provide information about the uploaded files.
*/
export class UploadCollectionItem extends sap.ui.core.Element {
/**
* Constructor for a new UploadCollectionItem
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, will be generated automatically if no ID is provided.
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some attribute to the aggregation {@link #getAttributes attributes}.
* @param {sap.m.ObjectAttribute} oAttribute - the attribute to add; if empty, nothing is inserted
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public addAttribute(oAttribute: sap.m.ObjectAttribute): sap.m.UploadCollectionItem;
/**
* Adds some marker to the aggregation {@link #getMarkers markers}.
* @param {sap.m.ObjectMarker} oMarker - the marker to add; if empty, nothing is inserted
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public addMarker(oMarker: sap.m.ObjectMarker): sap.m.UploadCollectionItem;
/**
* Adds some status to the aggregation {@link #getStatuses statuses}.
* @param {sap.m.ObjectStatus} oStatus - the status to add; if empty, nothing is inserted
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public addStatus(oStatus: sap.m.ObjectStatus): sap.m.UploadCollectionItem;
/**
* Binds aggregation {@link #getAttributes attributes} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public bindAttributes(oBindingInfo: any): sap.m.UploadCollectionItem;
/**
* Binds aggregation {@link #getMarkers markers} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public bindMarkers(oBindingInfo: any): sap.m.UploadCollectionItem;
/**
* Binds aggregation {@link #getStatuses statuses} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public bindStatuses(oBindingInfo: any): sap.m.UploadCollectionItem;
/**
* Destroys all the attributes in the aggregation {@link #getAttributes attributes}.
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public destroyAttributes(): sap.m.UploadCollectionItem;
/**
* Destroys all the markers in the aggregation {@link #getMarkers markers}.
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public destroyMarkers(): sap.m.UploadCollectionItem;
/**
* Destroys all the statuses in the aggregation {@link #getStatuses statuses}.
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public destroyStatuses(): sap.m.UploadCollectionItem;
/**
* Downloads the item.
* The sap.ui.core.util.File method is used here. For further details on this method, see {sap.ui.core.util.File.save}.
* @param {boolean} askForLocation - Decides whether to ask for a location to download or not.
*/
public download(askForLocation: boolean): void;
/**
* Creates a new subclass of class sap.m.UploadCollectionItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAriaLabelForPicture ariaLabelForPicture}.
*
* Aria label for the icon (or for the image).
* @returns {string} Value of property ariaLabelForPicture
*/
public getAriaLabelForPicture(): string;
/**
* Gets content of aggregation {@link #getAttributes attributes}.
*
* Attributes of an uploaded item, for example, 'Uploaded By', 'Uploaded On', 'File Size'
* attributes are displayed after an item has been uploaded.
* Additionally, the Active property of sap.m.ObjectAttribute is supported.
* Note that if one of the deprecated properties contributor, fileSize or UploadedDate is filled in addition to this attribute, two attributes with the same title
* are displayed as these properties get displayed as an attribute.
* Example: An application passes the property ‘contributor’ with the value ‘A’ and the aggregation attributes ‘contributor’: ‘B’. As a result, the attributes
* ‘contributor’:’A’ and ‘contributor’:’B’ are displayed. To make sure the title does not appear twice, check if one of the properties is filled.
* @returns {sap.m.ObjectAttribute[]}
*/
public getAttributes(): sap.m.ObjectAttribute[];
/**
* Gets current value of property {@link #getContributor contributor}.
*
* Specifies the name of the user who uploaded the file.
* @returns {string} Value of property contributor
*/
public getContributor(): string;
/**
* Gets current value of property {@link #getDocumentId documentId}.
*
* Specifies a unique identifier of the file (created by the application).
* @returns {string} Value of property documentId
*/
public getDocumentId(): string;
/**
* Gets current value of property {@link #getEnableDelete enableDelete}.
*
* Enables/Disables the Delete button.
* If the value is true, the Delete button is enabled and the delete function can be used.
* If the value is false, the delete function is not available.
*
* Default value is true
.
* @returns {boolean} Value of property enableDelete
*/
public getEnableDelete(): boolean;
/**
* Gets current value of property {@link #getEnableEdit enableEdit}.
*
* Enables/Disables the Edit button.
* If the value is true, the Edit button is enabled and the edit function can be used.
* If the value is false, the edit function is not available.
*
* Default value is true
.
* @returns {boolean} Value of property enableEdit
*/
public getEnableEdit(): boolean;
/**
* Gets current value of property {@link #getFileName fileName}.
*
* Specifies the name of the uploaded file.
* @returns {string} Value of property fileName
*/
public getFileName(): string;
/**
* Gets current value of property {@link #getFileSize fileSize}.
*
* Specifies the size of the uploaded file (in megabytes).
* @returns {number} Value of property fileSize
*/
public getFileSize(): number;
/**
* ID of the element which is the current target of the association {@link #getFileUploader fileUploader}, or null
.
* @returns {sap.ui.core.ID}
*/
public getFileUploader(): sap.ui.core.ID;
/**
* Gets content of aggregation {@link #getMarkers markers}.
*
* Markers of an uploaded item
* Markers will be displayed after an item has been uploaded
* But not in Edit mode
* @returns {sap.m.ObjectMarker[]}
*/
public getMarkers(): sap.m.ObjectMarker[];
/**
* Returns a metadata object for class sap.m.UploadCollectionItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMimeType mimeType}.
*
* Specifies the MIME type of the file.
* @returns {string} Value of property mimeType
*/
public getMimeType(): string;
/**
* Gets current value of property {@link #getSelected selected}.
*
* Defines the selected state of the UploadCollectionItem.
*
* Default value is false
.
* @returns {boolean} Value of property selected
*/
public getSelected(): boolean;
/**
* Gets content of aggregation {@link #getStatuses statuses}.
*
* Statuses of an uploaded item
* Statuses will be displayed after an item has been uploaded
* @returns {sap.m.ObjectStatus[]}
*/
public getStatuses(): sap.m.ObjectStatus[];
/**
* Gets current value of property {@link #getThumbnailUrl thumbnailUrl}.
*
* Specifies the URL where the thumbnail of the file is located.
* @returns {string} Value of property thumbnailUrl
*/
public getThumbnailUrl(): string;
/**
* Gets current value of property {@link #getUploadedDate uploadedDate}.
*
* Specifies the date on which the file was uploaded.
* The application has to define the date format.
* @returns {string} Value of property uploadedDate
*/
public getUploadedDate(): string;
/**
* Gets current value of property {@link #getUrl url}.
*
* Specifies the URL where the file is located.
* If the application doesn't provide a value for this property, the icon and the file name of the UploadCollectionItem are not clickable.
* @returns {string} Value of property url
*/
public getUrl(): string;
/**
* Gets current value of property {@link #getVisibleDelete visibleDelete}.
*
* Show/Hide the Delete button.
* If the value is true, the Delete button is visible.
* If the value is false, the Delete button is not visible.
*
* Default value is true
.
* @returns {boolean} Value of property visibleDelete
*/
public getVisibleDelete(): boolean;
/**
* Gets current value of property {@link #getVisibleEdit visibleEdit}.
*
* Show/Hide the Edit button.
* If the value is true, the Edit button is visible.
* If the value is false, the Edit button is not visible.
*
* Default value is true
.
* @returns {boolean} Value of property visibleEdit
*/
public getVisibleEdit(): boolean;
/**
* Checks for the provided sap.m.ObjectAttribute
in the aggregation {@link #getAttributes attributes}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ObjectAttribute} oAttribute - The attribute whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAttribute(oAttribute: sap.m.ObjectAttribute): number;
/**
* Checks for the provided sap.m.ObjectMarker
in the aggregation {@link #getMarkers markers}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ObjectMarker} oMarker - The marker whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfMarker(oMarker: sap.m.ObjectMarker): number;
/**
* Checks for the provided sap.m.ObjectStatus
in the aggregation {@link #getStatuses statuses}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ObjectStatus} oStatus - The status whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfStatus(oStatus: sap.m.ObjectStatus): number;
/**
* Inserts a attribute into the aggregation {@link #getAttributes attributes}.
* @param {sap.m.ObjectAttribute} oAttribute - the attribute to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the attribute should be inserted at; for a negative value of iIndex
, the attribute is inserted at position 0; for a value greater than the current size of the aggregation, the attribute is inserted at the last position
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public insertAttribute(oAttribute: sap.m.ObjectAttribute, iIndex: number): sap.m.UploadCollectionItem;
/**
* Inserts a marker into the aggregation {@link #getMarkers markers}.
* @param {sap.m.ObjectMarker} oMarker - the marker to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the marker should be inserted at; for a negative value of iIndex
, the marker is inserted at position 0; for a value greater than the current size of the aggregation, the marker is inserted at the last position
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public insertMarker(oMarker: sap.m.ObjectMarker, iIndex: number): sap.m.UploadCollectionItem;
/**
* Inserts a status into the aggregation {@link #getStatuses statuses}.
* @param {sap.m.ObjectStatus} oStatus - the status to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the status should be inserted at; for a negative value of iIndex
, the status is inserted at position 0; for a value greater than the current size of the aggregation, the status is inserted at the last position
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public insertStatus(oStatus: sap.m.ObjectStatus, iIndex: number): sap.m.UploadCollectionItem;
/**
* Removes all the controls from the aggregation {@link #getAttributes attributes}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ObjectAttribute[]} An array of the removed elements (might be empty)
*/
public removeAllAttributes(): sap.m.ObjectAttribute[];
/**
* Removes all the controls from the aggregation {@link #getMarkers markers}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ObjectMarker[]} An array of the removed elements (might be empty)
*/
public removeAllMarkers(): sap.m.ObjectMarker[];
/**
* Removes all the controls from the aggregation {@link #getStatuses statuses}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ObjectStatus[]} An array of the removed elements (might be empty)
*/
public removeAllStatuses(): sap.m.ObjectStatus[];
/**
* Removes a attribute from the aggregation {@link #getAttributes attributes}.
* @param {number|string|sap.m.ObjectAttribute} vAttribute - The attribute to remove or its index or id
* @returns {sap.m.ObjectAttribute} The removed attribute or null
*/
public removeAttribute(vAttribute: number|string|sap.m.ObjectAttribute): sap.m.ObjectAttribute;
/**
* Removes a marker from the aggregation {@link #getMarkers markers}.
* @param {number|string|sap.m.ObjectMarker} vMarker - The marker to remove or its index or id
* @returns {sap.m.ObjectMarker} The removed marker or null
*/
public removeMarker(vMarker: number|string|sap.m.ObjectMarker): sap.m.ObjectMarker;
/**
* Removes a status from the aggregation {@link #getStatuses statuses}.
* @param {number|string|sap.m.ObjectStatus} vStatus - The status to remove or its index or id
* @returns {sap.m.ObjectStatus} The removed status or null
*/
public removeStatus(vStatus: number|string|sap.m.ObjectStatus): sap.m.ObjectStatus;
/**
* Sets a new value for property {@link #getAriaLabelForPicture ariaLabelForPicture}.
*
* Aria label for the icon (or for the image).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAriaLabelForPicture - New value for property ariaLabelForPicture
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public setAriaLabelForPicture(sAriaLabelForPicture: string): sap.m.UploadCollectionItem;
/**
* Setter of the deprecated contributor property. The property is mapped to the aggregation attributes.
*/
public setContributor(): void;
/**
* Sets a new value for property {@link #getDocumentId documentId}.
*
* Specifies a unique identifier of the file (created by the application).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sDocumentId - New value for property documentId
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public setDocumentId(sDocumentId: string): sap.m.UploadCollectionItem;
/**
* Sets a new value for property {@link #getEnableDelete enableDelete}.
*
* Enables/Disables the Delete button.
* If the value is true, the Delete button is enabled and the delete function can be used.
* If the value is false, the delete function is not available.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableDelete - New value for property enableDelete
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public setEnableDelete(bEnableDelete: boolean): sap.m.UploadCollectionItem;
/**
* Sets a new value for property {@link #getEnableEdit enableEdit}.
*
* Enables/Disables the Edit button.
* If the value is true, the Edit button is enabled and the edit function can be used.
* If the value is false, the edit function is not available.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableEdit - New value for property enableEdit
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public setEnableEdit(bEnableEdit: boolean): sap.m.UploadCollectionItem;
/**
* Sets a new value for property {@link #getFileName fileName}.
*
* Specifies the name of the uploaded file.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sFileName - New value for property fileName
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public setFileName(sFileName: string): sap.m.UploadCollectionItem;
/**
* Setter of the deprecated fileSize property. The property is mapped to the aggregation attributes.
*/
public setFileSize(): void;
/**
* Sets the associated {@link #getFileUploader fileUploader}.
* @param {sap.ui.core.ID|sap.ui.unified.FileUploader} oFileUploader - ID of an element which becomes the new target of this fileUploader association; alternatively, an element instance may be given
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public setFileUploader(oFileUploader: sap.ui.core.ID|sap.ui.unified.FileUploader): sap.m.UploadCollectionItem;
/**
* Sets a new value for property {@link #getMimeType mimeType}.
*
* Specifies the MIME type of the file.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sMimeType - New value for property mimeType
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public setMimeType(sMimeType: string): sap.m.UploadCollectionItem;
/**
* Setter of the selected property.
* @param {boolean} selected - value to set on Selected property
* @returns {sap.m.UploadCollectionItem} The current UploadCollectionItem
*/
public setSelected(selected: boolean): sap.m.UploadCollectionItem;
/**
* Sets a new value for property {@link #getThumbnailUrl thumbnailUrl}.
*
* Specifies the URL where the thumbnail of the file is located.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sThumbnailUrl - New value for property thumbnailUrl
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public setThumbnailUrl(sThumbnailUrl: string): sap.m.UploadCollectionItem;
/**
* Setter of the deprecated uploadedDate property. The property is mapped to the aggregation attributes.
*/
public setUploadedDate(): void;
/**
* Sets a new value for property {@link #getUrl url}.
*
* Specifies the URL where the file is located.
* If the application doesn't provide a value for this property, the icon and the file name of the UploadCollectionItem are not clickable.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sUrl - New value for property url
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public setUrl(sUrl: string): sap.m.UploadCollectionItem;
/**
* Sets a new value for property {@link #getVisibleDelete visibleDelete}.
*
* Show/Hide the Delete button.
* If the value is true, the Delete button is visible.
* If the value is false, the Delete button is not visible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisibleDelete - New value for property visibleDelete
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public setVisibleDelete(bVisibleDelete: boolean): sap.m.UploadCollectionItem;
/**
* Sets a new value for property {@link #getVisibleEdit visibleEdit}.
*
* Show/Hide the Edit button.
* If the value is true, the Edit button is visible.
* If the value is false, the Edit button is not visible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisibleEdit - New value for property visibleEdit
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public setVisibleEdit(bVisibleEdit: boolean): sap.m.UploadCollectionItem;
/**
* Unbinds aggregation {@link #getAttributes attributes} from model data.
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public unbindAttributes(): sap.m.UploadCollectionItem;
/**
* Unbinds aggregation {@link #getMarkers markers} from model data.
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public unbindMarkers(): sap.m.UploadCollectionItem;
/**
* Unbinds aggregation {@link #getStatuses statuses} from model data.
* @returns {sap.m.UploadCollectionItem} Reference to this
in order to allow method chaining
*/
public unbindStatuses(): sap.m.UploadCollectionItem;
}
/**
* Represents a parameter for the UploadCollection.
*/
export class UploadCollectionParameter extends sap.ui.core.Element {
/**
* Constructor for a new UploadCollectionParameter.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.UploadCollectionParameter with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.UploadCollectionParameter.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* Specifies the name of the parameter.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets current value of property {@link #getValue value}.
*
* Specifies the value of the parameter.
* @returns {string} Value of property value
*/
public getValue(): string;
/**
* Sets a new value for property {@link #getName name}.
*
* Specifies the name of the parameter.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.m.UploadCollectionParameter} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.m.UploadCollectionParameter;
/**
* Sets a new value for property {@link #getValue value}.
*
* Specifies the value of the parameter.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sValue - New value for property value
* @returns {sap.m.UploadCollectionParameter} Reference to this
in order to allow method chaining
*/
public setValue(sValue: string): sap.m.UploadCollectionParameter;
}
/**
* This control needs to be used when you would like to create a customizable toolbar for the UploadCollection. Always a FileUploader instance is
* required in the toolbar, the FileUploader will be placed in the position defined by the application.
*/
export class UploadCollectionToolbarPlaceholder extends sap.ui.core.Control {
/**
* Constructor for a new UploadCollectionToolbarPlaceholder.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.UploadCollectionToolbarPlaceholder with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.UploadCollectionToolbarPlaceholder.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* URL(Uniform Resource Locator) Helper.
*
* This helper can be used to trigger a native application (e.g. email, sms, phone) from the browser.
* That means we are restricted of browser or application implementation. e.g.
*
* - Some browsers do not let you to pass more than 2022 characters in the URL
* - MAPI (Outlook) limit is 2083, max. path under Internet Explorer it is 2048
* - Different Internet Explorer versions have a different limitation (IE9 approximately 1000 characters)
* - MS mail app under Windows 8 cuts mail links after approximately 100 characters
* - Safari gets a confirmation from user before opening a native application and can block other triggers if the user cancels it
* - Some mail applications(Outlook) do not respect all encodings(e.g. Cyrillic texts are not encoded correctly)
*
*
* Note: all the given limitation lengths are for encoded text(e.g space character will be encoded to "%20").
*/
namespace URLHelper {
/**
* Adds an event registration for redirect.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {Object} oListener - The object, that wants to be notified, when the event occurs.
* @returns {Object} sap.m.URLHelper instance
*/
function attachRedirect(fnFunction: Function, oListener?: Object): Object;
/**
* Detach already registered redirect event.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {Object} oListener - The object, that wants to be notified, when the event occurs.
* @returns {Object} sap.m.URLHelper instance
*/
function detachRedirect(fnFunction: Function, oListener?: Object): Object;
/**
* Builds Email URI from given parameter.
* Trims spaces from email addresses.
* @param {string} sEmail - Destination email address
* @param {string} sSubject - Subject of the email address
* @param {string} sBody - Default message text
* @param {string} sCC - Carbon Copy email address
* @param {string} sBCC - Blind carbon copy email address
* @returns {string} Email URI scheme
*/
function normalizeEmail(sEmail?: string, sSubject?: string, sBody?: string, sCC?: string, sBCC?: string): string;
/**
* Sanitizes the given telephone number and returns SMS URI scheme.
* @param {string} sTel - Telephone number
* @returns {string} SMS URI scheme
*/
function normalizeSms(sTel?: string): string;
/**
* Sanitizes the given telephone number and returns a telephone URI scheme.
* @param {string} sTel - Telephone number
* @returns {string} Telephone URI scheme
*/
function normalizeTel(sTel?: string): string;
/**
* Redirects to the given URL.
* This method fires "redirect" event before opening the URL.
* @param {string} sURL - Uniform resource locator
* @param {boolean} bNewWindow - Opens URL in a new browser window or tab. Please note that, opening a new window/tab can be ignored by browsers(e.g. on Windows Phone) or by popup blockers. NOTE: On Windows Phone the URL will be enforced to open in the same window if opening in a new window/tab fails (because of a known system restriction on cross-window communications). Use sap.m.Link instead (with blank target) if you necessarily need to open URL in a new window.
*/
function redirect(sURL: string, bNewWindow?: boolean): void;
/**
* Trigger email application to send email.
* Trims spaces from email addresses.
* @param {string} sEmail - Destination email address
* @param {string} sSubject - Subject of the email address
* @param {string} sBody - Default message text
* @param {string} sCC - Carbon Copy email address
* @param {string} sBCC - Blind carbon copy email address
*/
function triggerEmail(sEmail?: string, sSubject?: string, sBody?: string, sCC?: string, sBCC?: string): void;
/**
* Trigger SMS application to send SMS to given telephone number.
* @param {string} sTel - Telephone number
*/
function triggerSms(sTel?: string): void;
/**
* Trigger telephone to call given telephone number.
* @param {string} sTel - Telephone number
*/
function triggerTel(sTel?: string): void;
}
/**
* Enumeration of possible value color settings.
*/
export enum ValueColor {
/**
* Critical value color.
*/
Critical = "Critical",
/**
* Error value color.
*/
Error = "Error",
/**
* Good value color.
*/
Good = "Good",
/**
* Neutral value color.
*/
Neutral = "Neutral",
}
/**
* A string type that represents CSS color values, sap.m.ValueColor or less parameter values.
* Allowed values are {@link sap.ui.core.CSSColor}, {@link sap.m.ValueColor} and {String} as a less parameter name.
* In case the less parameter color cannot be determined, the validation failed. You need to check if less parameters are supported on control level.
* An empty string is also allowed and has the same effect as setting no color.
*/
namespace ValueCSSColor {
}
/**
* The VBox control builds the container for a vertical flexible box layout. VBox is a convenience control, as it is just a specialized FlexBox control.
*
* Note: Be sure to check the renderType
setting to avoid issues due to browser inconsistencies.
*/
export class VBox extends sap.m.FlexBox {
/**
* Constructor for a new VBox.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.m.VBox with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.FlexBox.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.m.VBox.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Types for the placement of message popover control.
*/
export enum VerticalPlacementType {
/**
* Popover will be placed at the bottom of the reference control.
*/
Bottom = "Bottom",
/**
* Popover will be placed at the top of the reference control.
*/
Top = "Top",
/**
* Popover will be placed at the top or bottom of the reference control.
*/
Vertical = "Vertical",
}
/**
* The ViewSettingsCustomItem control is used for modelling custom filters in the ViewSettingsDialog.
*/
export class ViewSettingsCustomItem extends sap.m.ViewSettingsItem {
/**
* Constructor for a new ViewSettingsCustomItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a clone of the ViewSettingsCustomItem instance.
* @param {string} sIdSuffix - a suffix to be appended to the cloned object id
* @param {string[]} aLocalIds - an array of local IDs within the cloned hierarchy (internally used)
* @param {Object} oOptions - configuration object
* @returns {sap.ui.base.ManagedObject} reference to the newly created clone
*/
protected clone(sIdSuffix?: string, aLocalIds?: string[], oOptions?: Object): sap.ui.base.ManagedObject;
/**
* Destroys the customControl in the aggregation {@link #getCustomControl customControl}.
* @returns {sap.m.ViewSettingsCustomItem} Reference to this
in order to allow method chaining
*/
public destroyCustomControl(): sap.m.ViewSettingsCustomItem;
/**
* Creates a new subclass of class sap.m.ViewSettingsCustomItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ViewSettingsItem.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Internally the control is handled as a managed object instead of an aggregation
* because this control is sometimes aggregated in other controls like a popover or a dialog.
* @returns {sap.ui.core.Control} oControl a control used for filtering purposes
*/
public getCustomControl(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getFilterCount filterCount}.
*
* The number of currently active filters for this custom filter item. It will be displayed in the filter list of the ViewSettingsDialog to represent the filter state of the custom control.
*
* Default value is 0
.
* @returns {number} Value of property filterCount
*/
public getFilterCount(): number;
/**
* Returns a metadata object for class sap.m.ViewSettingsCustomItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Internally the control is handled as a managed object instead of an aggregation
* as this control is sometimes aggregated in other controls like a popover or a dialog.
* @param {sap.ui.core.Control} oControl - A control used for filtering purposes
* @returns {sap.m.ViewSettingsCustomItem} this pointer for chaining
*/
public setCustomControl(oControl: sap.ui.core.Control): sap.m.ViewSettingsCustomItem;
/**
* Sets the filterCount without invalidating the control as it is never rendered directly.
* @param {number} iValue - The new value for property filterCount
* @returns {sap.m.ViewSettingsItem} this pointer for chaining
*/
public setFilterCount(iValue: number): sap.m.ViewSettingsItem;
}
/**
* The ViewSettingsCustomTab control is used for adding custom tabs in the ViewSettingsDialog.
*/
export class ViewSettingsCustomTab extends sap.ui.core.Item {
/**
* Constructor for a new ViewSettingsCustomTab.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.ViewSettingsCustomTab} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.ViewSettingsCustomTab;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.ViewSettingsCustomTab} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.ViewSettingsCustomTab;
/**
* Creates a new subclass of class sap.m.ViewSettingsCustomTab with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content of this Custom tab
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getIcon icon}.
*
* Custom tab button icon
*
* Default value is sap-icon://competitor
.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.m.ViewSettingsCustomTab.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets or creates the sap.m.Button instance for the custom tab.
* @param {any} oOptions
* @returns {sap.m.Button}
*/
public getTabButton(oOptions: any): sap.m.Button;
/**
* Gets current value of property {@link #getTitle title}.
*
* Custom tab title
*
* Default value is
.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.ViewSettingsCustomTab} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.ViewSettingsCustomTab;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Custom tab button icon
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is sap-icon://competitor
.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.ViewSettingsCustomTab} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.ViewSettingsCustomTab;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Custom tab title
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sTitle - New value for property title
* @returns {sap.m.ViewSettingsCustomTab} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.ViewSettingsCustomTab;
}
/**
* Helps the user to sort, filter, or group data within a (master) {@link sap.m.List} or a
* {@link sap.m.Table}. The dialog is triggered by icon buttons in the table toolbar. Each
* button shows a dropdown list icon.
*
* Overview
*
* The ViewSettingsDialog
is a composite control,
* consisting of a modal {@link sap.m.Popover} and several internal lists.
* There are three different tabs (Sort, Group, Filter) in the dialog that can be
* activated by filling the respective associations. If only one association is
* filled, the other tabs are automatically hidden. The selected options can be used
* to create sorters and filters for the table.
*
* Note: If the app does not offer all three sorting, filtering, and grouping
* functionalities, but only one of these (such as sort), we recommend placing the
* icon button directly in the toolbar. Do not place sort, filter, or group buttons in
* the footer toolbar if they refer to a table. Place group, sort, and filter buttons
* in the footer toolbar if they refer to a master list.
*
* Usage
*
* When to use?
* - If you need to allow the user to sort line items in a manageable list or
* table (up to 20 columns)
* - If you need to offer custom filter settings in a manageable list or table
* (up to 20 columns)
* - If you need to allow the user to group line items in a manageable list or
* table (up to 20 columns)
*
* When not to use?
* - If you have complex tables (more than 20 columns)
* - If you need to rearrange columns within your table (use the
* {@link sap.m.TablePersoDialog} instead)
* - If you need very specific sort, filter, or column sorting options within
* complex tables (use the {@link sap.m.P13nDialog} instead)
*
* Responsive behavior
*
* The popover dialog appears as a modal window on desktop and tablet screen sizes,
* but full screen on smartphones.
*/
export class ViewSettingsDialog extends sap.ui.core.Control {
/**
* Constructor for a new ViewSettingsDialog
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Overwrites the aggregation setter in order to have ID validation logic as some strings
* are reserved for the predefined tabs.
* @param {any} oCustomTab - The custom tab to be added
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public addCustomTab(oCustomTab: any): sap.m.ViewSettingsDialog;
/**
* Adds some filterItem to the aggregation {@link #getFilterItems filterItems}.
* @param {sap.m.ViewSettingsItem} oFilterItem - the filterItem to add; if empty, nothing is inserted
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public addFilterItem(oFilterItem: sap.m.ViewSettingsItem): sap.m.ViewSettingsDialog;
/**
* Adds a group item and sets the association to reflect the selected state.
* @param {sap.m.ViewSettingsItem} oItem - The item to be added to the group items
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public addGroupItem(oItem: sap.m.ViewSettingsItem): sap.m.ViewSettingsDialog;
/**
* Adds a preset filter item and sets the association to reflect the selected state.
* @param {sap.m.ViewSettingsItem} oItem - The selected item or a string with the key
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public addPresetFilterItem(oItem: sap.m.ViewSettingsItem): sap.m.ViewSettingsDialog;
/**
* Adds a sort item and sets the association to reflect the selected state.
* @param {sap.m.ViewSettingsItem} oItem - The item to be added to the aggregation
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public addSortItem(oItem: sap.m.ViewSettingsItem): sap.m.ViewSettingsDialog;
/**
* Forward method to the inner dialog method: addStyleClass.
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public addStyleClass(): sap.m.ViewSettingsDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.m.ViewSettingsDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ViewSettingsDialog
itself.
*
* Called when the Cancel button is pressed. It can be used to set the state of custom filter controls.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ViewSettingsDialog
itself
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public attachCancel(fnFunction: Function, oListener?: any): sap.m.ViewSettingsDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.m.ViewSettingsDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ViewSettingsDialog
itself.
*
* Called when the Cancel button is pressed. It can be used to set the state of custom filter controls.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ViewSettingsDialog
itself
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public attachCancel(oData: any, fnFunction: Function, oListener?: any): sap.m.ViewSettingsDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:confirm confirm} event of this sap.m.ViewSettingsDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ViewSettingsDialog
itself.
*
* Indicates that the user has pressed the OK button and the selected sort, group, and filter settings should be applied to the data on this page.
* Note: Custom tabs are not converted to event parameters automatically. For custom tabs, you have to read the state of your controls inside the callback of this event.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ViewSettingsDialog
itself
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public attachConfirm(fnFunction: Function, oListener?: any): sap.m.ViewSettingsDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:confirm confirm} event of this sap.m.ViewSettingsDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ViewSettingsDialog
itself.
*
* Indicates that the user has pressed the OK button and the selected sort, group, and filter settings should be applied to the data on this page.
* Note: Custom tabs are not converted to event parameters automatically. For custom tabs, you have to read the state of your controls inside the callback of this event.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ViewSettingsDialog
itself
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public attachConfirm(oData: any, fnFunction: Function, oListener?: any): sap.m.ViewSettingsDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:filterDetailPageOpened filterDetailPageOpened} event of this sap.m.ViewSettingsDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ViewSettingsDialog
itself.
*
* Fired when the filter detail page is opened.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ViewSettingsDialog
itself
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public attachFilterDetailPageOpened(fnFunction: Function, oListener?: any): sap.m.ViewSettingsDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:filterDetailPageOpened filterDetailPageOpened} event of this sap.m.ViewSettingsDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ViewSettingsDialog
itself.
*
* Fired when the filter detail page is opened.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ViewSettingsDialog
itself
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public attachFilterDetailPageOpened(oData: any, fnFunction: Function, oListener?: any): sap.m.ViewSettingsDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:resetFilters resetFilters} event of this sap.m.ViewSettingsDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ViewSettingsDialog
itself.
*
* Called when the reset filters button is pressed. It can be used to clear the state of custom filter controls.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ViewSettingsDialog
itself
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public attachResetFilters(fnFunction: Function, oListener?: any): sap.m.ViewSettingsDialog;
/**
* Attaches event handler fnFunction
to the {@link #event:resetFilters resetFilters} event of this sap.m.ViewSettingsDialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ViewSettingsDialog
itself.
*
* Called when the reset filters button is pressed. It can be used to clear the state of custom filter controls.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ViewSettingsDialog
itself
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public attachResetFilters(oData: any, fnFunction: Function, oListener?: any): sap.m.ViewSettingsDialog;
/**
* Binds aggregation {@link #getCustomTabs customTabs} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public bindCustomTabs(oBindingInfo: any): sap.m.ViewSettingsDialog;
/**
* Binds aggregation {@link #getFilterItems filterItems} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public bindFilterItems(oBindingInfo: any): sap.m.ViewSettingsDialog;
/**
* Binds aggregation {@link #getGroupItems groupItems} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public bindGroupItems(oBindingInfo: any): sap.m.ViewSettingsDialog;
/**
* Binds aggregation {@link #getPresetFilterItems presetFilterItems} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public bindPresetFilterItems(oBindingInfo: any): sap.m.ViewSettingsDialog;
/**
* Binds aggregation {@link #getSortItems sortItems} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public bindSortItems(oBindingInfo: any): sap.m.ViewSettingsDialog;
/**
* Destroys all the customTabs in the aggregation {@link #getCustomTabs customTabs}.
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public destroyCustomTabs(): sap.m.ViewSettingsDialog;
/**
* Destroys all the filterItems in the aggregation {@link #getFilterItems filterItems}.
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public destroyFilterItems(): sap.m.ViewSettingsDialog;
/**
* Destroys all the groupItems in the aggregation {@link #getGroupItems groupItems}.
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public destroyGroupItems(): sap.m.ViewSettingsDialog;
/**
* Destroys all the presetFilterItems in the aggregation {@link #getPresetFilterItems presetFilterItems}.
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public destroyPresetFilterItems(): sap.m.ViewSettingsDialog;
/**
* Destroys all the sortItems in the aggregation {@link #getSortItems sortItems}.
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public destroySortItems(): sap.m.ViewSettingsDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:cancel cancel} event of this sap.m.ViewSettingsDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public detachCancel(fnFunction: Function, oListener: any): sap.m.ViewSettingsDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:confirm confirm} event of this sap.m.ViewSettingsDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public detachConfirm(fnFunction: Function, oListener: any): sap.m.ViewSettingsDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:filterDetailPageOpened filterDetailPageOpened} event of this sap.m.ViewSettingsDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public detachFilterDetailPageOpened(fnFunction: Function, oListener: any): sap.m.ViewSettingsDialog;
/**
* Detaches event handler fnFunction
from the {@link #event:resetFilters resetFilters} event of this sap.m.ViewSettingsDialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public detachResetFilters(fnFunction: Function, oListener: any): sap.m.ViewSettingsDialog;
/**
* Creates a new subclass of class sap.m.ViewSettingsDialog with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:cancel cancel} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
protected fireCancel(mParameters?: any): sap.m.ViewSettingsDialog;
/**
* Fires event {@link #event:confirm confirm} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
protected fireConfirm(mParameters?: any): sap.m.ViewSettingsDialog;
/**
* Fires event {@link #event:filterDetailPageOpened filterDetailPageOpened} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
protected fireFilterDetailPageOpened(mParameters?: any): sap.m.ViewSettingsDialog;
/**
* Fires event {@link #event:resetFilters resetFilters} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
protected fireResetFilters(mParameters?: any): sap.m.ViewSettingsDialog;
/**
* Gets content of aggregation {@link #getCustomTabs customTabs}.
*
* The list of all the custom tabs.
* @returns {sap.m.ViewSettingsCustomTab[]}
*/
public getCustomTabs(): sap.m.ViewSettingsCustomTab[];
/**
* Forward method to the inner dialog method: getDomRef.
* @returns {HTMLElement} The Element's DOM Element sub DOM Element or null
*/
public getDomRef(): HTMLElement;
/**
* Gets content of aggregation {@link #getFilterItems filterItems}.
*
* The list of items with key and value that can be filtered on (for example, a list of columns for a table). A filterItem is associated with one or more detail filters.
* @returns {sap.m.ViewSettingsItem[]}
*/
public getFilterItems(): sap.m.ViewSettingsItem[];
/**
* Gets current value of property {@link #getFilterSearchOperator filterSearchOperator}.
*
* Provides a string filter operator which is used when the user searches items in filter details page.
* Possible operators are: AnyWordStartsWith
, Contains
, StartsWith
, Equals
.
* This property will be ignored if a custom callback is provided through setFilterSearchCallback
method.
*
* Default value is StartsWith
.
* @returns {sap.m.StringFilterOperator} Value of property filterSearchOperator
*/
public getFilterSearchOperator(): sap.m.StringFilterOperator;
/**
* Gets current value of property {@link #getGroupDescending groupDescending}.
*
* Determines whether the group order is descending or ascending (default).
*
* Default value is false
.
* @returns {boolean} Value of property groupDescending
*/
public getGroupDescending(): boolean;
/**
* Gets content of aggregation {@link #getGroupItems groupItems}.
*
* The list of items with key and value that can be grouped on (for example, a list of columns for a table).
* @returns {sap.m.ViewSettingsItem[]}
*/
public getGroupItems(): sap.m.ViewSettingsItem[];
/**
* Returns a metadata object for class sap.m.ViewSettingsDialog.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getPresetFilterItems presetFilterItems}.
*
* The list of preset filter items that allows the selection of more complex or custom filters. These entries are displayed at the top of the filter tab.
* @returns {sap.m.ViewSettingsItem[]}
*/
public getPresetFilterItems(): sap.m.ViewSettingsItem[];
/**
* Gets the selected filter object in format { parent_key: { key: boolean, key2: boolean, ...}, ... }.
* @returns {any} An object with item and sub-item keys
*/
public getSelectedFilterCompoundKeys(): any;
/**
* Returns the selected filters as an array of ViewSettingsItems.
*
* It can be used to create matching sorters and filters to apply the selected settings to the data.
* @returns {sap.m.ViewSettingsItem[]} An array of selected filter items
*/
public getSelectedFilterItems(): sap.m.ViewSettingsItem[];
/**
* Gets the selected filter object in format {key: boolean}.
*
* It can be used to create matching sorters and filters to apply the selected settings to the data.
* @returns {any} An object with item and sub-item keys
*/
public getSelectedFilterKeys(): any;
/**
* Gets the filter string in format: "filter name (subfilter1 name, subfilter2
* name, ...), ...".
* For custom and preset filters it will only add the filter name to the resulting string.
* @returns {string} The selected filter string
*/
public getSelectedFilterString(): string;
/**
* ID of the element which is the current target of the association {@link #getSelectedGroupItem selectedGroupItem}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedGroupItem(): sap.ui.core.ID;
/**
* ID of the element which is the current target of the association {@link #getSelectedPresetFilterItem selectedPresetFilterItem}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedPresetFilterItem(): sap.ui.core.ID;
/**
* ID of the element which is the current target of the association {@link #getSelectedSortItem selectedSortItem}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedSortItem(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getSortDescending sortDescending}.
*
* Determines whether the sort order is descending or ascending (default).
*
* Default value is false
.
* @returns {boolean} Value of property sortDescending
*/
public getSortDescending(): boolean;
/**
* Gets content of aggregation {@link #getSortItems sortItems}.
*
* The list of items with key and value that can be sorted over (for example, a list of columns for a table).
* @returns {sap.m.ViewSettingsItem[]}
*/
public getSortItems(): sap.m.ViewSettingsItem[];
/**
* Gets current value of property {@link #getTitle title}.
*
* Defines the title of the dialog. If not set and there is only one active tab, the dialog uses the default "View" or "Sort", "Group", "Filter" respectively.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Forward method to the inner dialog method: hasStyleClass.
* @returns {boolean} true if the class is set, false otherwise
*/
public hasStyleClass(): boolean;
/**
* Checks for the provided sap.m.ViewSettingsCustomTab
in the aggregation {@link #getCustomTabs customTabs}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ViewSettingsCustomTab} oCustomTab - The customTab whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfCustomTab(oCustomTab: sap.m.ViewSettingsCustomTab): number;
/**
* Checks for the provided sap.m.ViewSettingsItem
in the aggregation {@link #getFilterItems filterItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ViewSettingsItem} oFilterItem - The filterItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfFilterItem(oFilterItem: sap.m.ViewSettingsItem): number;
/**
* Checks for the provided sap.m.ViewSettingsItem
in the aggregation {@link #getGroupItems groupItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ViewSettingsItem} oGroupItem - The groupItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfGroupItem(oGroupItem: sap.m.ViewSettingsItem): number;
/**
* Checks for the provided sap.m.ViewSettingsItem
in the aggregation {@link #getPresetFilterItems presetFilterItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ViewSettingsItem} oPresetFilterItem - The presetFilterItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfPresetFilterItem(oPresetFilterItem: sap.m.ViewSettingsItem): number;
/**
* Checks for the provided sap.m.ViewSettingsItem
in the aggregation {@link #getSortItems sortItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ViewSettingsItem} oSortItem - The sortItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSortItem(oSortItem: sap.m.ViewSettingsItem): number;
/**
* Inserts a customTab into the aggregation {@link #getCustomTabs customTabs}.
* @param {sap.m.ViewSettingsCustomTab} oCustomTab - the customTab to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the customTab should be inserted at; for a negative value of iIndex
, the customTab is inserted at position 0; for a value greater than the current size of the aggregation, the customTab is inserted at the last position
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public insertCustomTab(oCustomTab: sap.m.ViewSettingsCustomTab, iIndex: number): sap.m.ViewSettingsDialog;
/**
* Inserts a filterItem into the aggregation {@link #getFilterItems filterItems}.
* @param {sap.m.ViewSettingsItem} oFilterItem - the filterItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the filterItem should be inserted at; for a negative value of iIndex
, the filterItem is inserted at position 0; for a value greater than the current size of the aggregation, the filterItem is inserted at the last position
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public insertFilterItem(oFilterItem: sap.m.ViewSettingsItem, iIndex: number): sap.m.ViewSettingsDialog;
/**
* Inserts a groupItem into the aggregation {@link #getGroupItems groupItems}.
* @param {sap.m.ViewSettingsItem} oGroupItem - the groupItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the groupItem should be inserted at; for a negative value of iIndex
, the groupItem is inserted at position 0; for a value greater than the current size of the aggregation, the groupItem is inserted at the last position
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public insertGroupItem(oGroupItem: sap.m.ViewSettingsItem, iIndex: number): sap.m.ViewSettingsDialog;
/**
* Inserts a presetFilterItem into the aggregation {@link #getPresetFilterItems presetFilterItems}.
* @param {sap.m.ViewSettingsItem} oPresetFilterItem - the presetFilterItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the presetFilterItem should be inserted at; for a negative value of iIndex
, the presetFilterItem is inserted at position 0; for a value greater than the current size of the aggregation, the presetFilterItem is inserted at the last position
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public insertPresetFilterItem(oPresetFilterItem: sap.m.ViewSettingsItem, iIndex: number): sap.m.ViewSettingsDialog;
/**
* Inserts a sortItem into the aggregation {@link #getSortItems sortItems}.
* @param {sap.m.ViewSettingsItem} oSortItem - the sortItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the sortItem should be inserted at; for a negative value of iIndex
, the sortItem is inserted at position 0; for a value greater than the current size of the aggregation, the sortItem is inserted at the last position
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public insertSortItem(oSortItem: sap.m.ViewSettingsItem, iIndex: number): sap.m.ViewSettingsDialog;
/**
* Opens the ViewSettingsDialog relative to the parent control.
* @param {string} sPageId - The ID of the initial page to be opened in the dialog. The available values are "sort", "group", "filter" or IDs of custom tabs.
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public open(sPageId?: string): sap.m.ViewSettingsDialog;
/**
* Removes all the controls from the aggregation {@link #getCustomTabs customTabs}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ViewSettingsCustomTab[]} An array of the removed elements (might be empty)
*/
public removeAllCustomTabs(): sap.m.ViewSettingsCustomTab[];
/**
* Removes all filter Items and resets the remembered page if it was a filter detail page and all of its filter items are being removed.
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public removeAllFilterItems(): sap.m.ViewSettingsDialog;
/**
* Removes all the controls from the aggregation {@link #getGroupItems groupItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ViewSettingsItem[]} An array of the removed elements (might be empty)
*/
public removeAllGroupItems(): sap.m.ViewSettingsItem[];
/**
* Removes all the controls from the aggregation {@link #getPresetFilterItems presetFilterItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ViewSettingsItem[]} An array of the removed elements (might be empty)
*/
public removeAllPresetFilterItems(): sap.m.ViewSettingsItem[];
/**
* Removes all the controls from the aggregation {@link #getSortItems sortItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ViewSettingsItem[]} An array of the removed elements (might be empty)
*/
public removeAllSortItems(): sap.m.ViewSettingsItem[];
/**
* Removes a customTab from the aggregation {@link #getCustomTabs customTabs}.
* @param {number|string|sap.m.ViewSettingsCustomTab} vCustomTab - The customTab to remove or its index or id
* @returns {sap.m.ViewSettingsCustomTab} The removed customTab or null
*/
public removeCustomTab(vCustomTab: number|string|sap.m.ViewSettingsCustomTab): sap.m.ViewSettingsCustomTab;
/**
* Removes a filter Item and resets the remembered page if it was the filter detail page of the removed filter.
* @param {number|sap.m.ViewSettingsFilterItem|string} vFilterItem - The filter item's index, or the item itself, or its id
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public removeFilterItem(vFilterItem: number|sap.m.ViewSettingsFilterItem|string): sap.m.ViewSettingsDialog;
/**
* Removes a groupItem from the aggregation {@link #getGroupItems groupItems}.
* @param {number|string|sap.m.ViewSettingsItem} vGroupItem - The groupItem to remove or its index or id
* @returns {sap.m.ViewSettingsItem} The removed groupItem or null
*/
public removeGroupItem(vGroupItem: number|string|sap.m.ViewSettingsItem): sap.m.ViewSettingsItem;
/**
* Removes a presetFilterItem from the aggregation {@link #getPresetFilterItems presetFilterItems}.
* @param {number|string|sap.m.ViewSettingsItem} vPresetFilterItem - The presetFilterItem to remove or its index or id
* @returns {sap.m.ViewSettingsItem} The removed presetFilterItem or null
*/
public removePresetFilterItem(vPresetFilterItem: number|string|sap.m.ViewSettingsItem): sap.m.ViewSettingsItem;
/**
* Removes a sortItem from the aggregation {@link #getSortItems sortItems}.
* @param {number|string|sap.m.ViewSettingsItem} vSortItem - The sortItem to remove or its index or id
* @returns {sap.m.ViewSettingsItem} The removed sortItem or null
*/
public removeSortItem(vSortItem: number|string|sap.m.ViewSettingsItem): sap.m.ViewSettingsItem;
/**
* Forward method to the inner dialog method: removeStyleClass.
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public removeStyleClass(): sap.m.ViewSettingsDialog;
/**
* Forward the busy state setting to the internal dialog instance.
* Needed because of the not-bullet proof implementation of setBusy in sap.ui.core.Control
* @param {boolean} bBusy - The busy state flag
* @returns {sap.m.ViewSettingsDialog} this Instance for chaining
*/
public setBusy(bBusy: boolean): sap.m.ViewSettingsDialog;
/**
* Sets a callback that will check the ViewSettingsItem's text against the search query.
* If a callback is set, filterSearchOperator
property will be ignored, as it serves the same purpose.
* @param {Function} fnTest - A function that accepts two parameters fnTest({string} query, {string} value) and returns boolean if the value satisfies the query.
* @returns {sap.m.ViewSettingsDialog} this instance for chaining
*/
public setFilterSearchCallback(fnTest: Function): sap.m.ViewSettingsDialog;
/**
* Sets a new value for property {@link #getFilterSearchOperator filterSearchOperator}.
*
* Provides a string filter operator which is used when the user searches items in filter details page.
* Possible operators are: AnyWordStartsWith
, Contains
, StartsWith
, Equals
.
* This property will be ignored if a custom callback is provided through setFilterSearchCallback
method.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is StartsWith
.
* @param {sap.m.StringFilterOperator} sFilterSearchOperator - New value for property filterSearchOperator
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public setFilterSearchOperator(sFilterSearchOperator: sap.m.StringFilterOperator): sap.m.ViewSettingsDialog;
/**
* Sets a new value for property {@link #getGroupDescending groupDescending}.
*
* Determines whether the group order is descending or ascending (default).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bGroupDescending - New value for property groupDescending
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public setGroupDescending(bGroupDescending: boolean): sap.m.ViewSettingsDialog;
/**
* Sets the selected filter object in format { parent_key: { key: boolean, key2: boolean, ...}, ... }.
* @param {any} oSelectedFilterKeys - A configuration object with filter item and sub item keys in the format: { parent_key: { key: boolean, key2: boolean, ...}, ... }. Setting boolean to true will set the filter to true, false or omitting an entry will set the filter to false. It can be used to set the dialog state based on presets.
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public setSelectedFilterCompoundKeys(oSelectedFilterKeys: any): sap.m.ViewSettingsDialog;
/**
* Sets the selected filter object in format {key: boolean}.
* Note: Do not use duplicated item keys with this method.
* @param {any} oSelectedFilterKeys - A configuration object with filter item and sub item keys in the format: { key: boolean }. Setting boolean to true will set the filter to true, false or omitting an entry will set the filter to false. It can be used to set the dialog state based on presets.
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public setSelectedFilterKeys(oSelectedFilterKeys: any): sap.m.ViewSettingsDialog;
/**
* Sets the selected group item (either by key or by item).
* @param {sap.m.ViewSettingsItem|string} vItemOrKey - The selected item or the item's key string
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public setSelectedGroupItem(vItemOrKey: sap.m.ViewSettingsItem|string): sap.m.ViewSettingsDialog;
/**
* Sets the selected preset filter item.
* @param {sap.m.ViewSettingsItem|string} vItemOrKey - The selected item or the item's key string
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public setSelectedPresetFilterItem(vItemOrKey: sap.m.ViewSettingsItem|string): sap.m.ViewSettingsDialog;
/**
* Sets the selected sort item (either by key or by item).
* @param {sap.m.ViewSettingsItem|string} vItemOrKey - The selected item or the item's key string
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public setSelectedSortItem(vItemOrKey: sap.m.ViewSettingsItem|string): sap.m.ViewSettingsDialog;
/**
* Sets a new value for property {@link #getSortDescending sortDescending}.
*
* Determines whether the sort order is descending or ascending (default).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSortDescending - New value for property sortDescending
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public setSortDescending(bSortDescending: boolean): sap.m.ViewSettingsDialog;
/**
* Sets the title of the internal dialog.
* @param {string} sTitle - The title text for the dialog
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public setTitle(sTitle: string): sap.m.ViewSettingsDialog;
/**
* Forward method to the inner dialog method: toggleStyleClass.
* @returns {sap.m.ViewSettingsDialog} this pointer for chaining
*/
public toggleStyleClass(): sap.m.ViewSettingsDialog;
/**
* Unbinds aggregation {@link #getCustomTabs customTabs} from model data.
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public unbindCustomTabs(): sap.m.ViewSettingsDialog;
/**
* Unbinds aggregation {@link #getFilterItems filterItems} from model data.
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public unbindFilterItems(): sap.m.ViewSettingsDialog;
/**
* Unbinds aggregation {@link #getGroupItems groupItems} from model data.
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public unbindGroupItems(): sap.m.ViewSettingsDialog;
/**
* Unbinds aggregation {@link #getPresetFilterItems presetFilterItems} from model data.
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public unbindPresetFilterItems(): sap.m.ViewSettingsDialog;
/**
* Unbinds aggregation {@link #getSortItems sortItems} from model data.
* @returns {sap.m.ViewSettingsDialog} Reference to this
in order to allow method chaining
*/
public unbindSortItems(): sap.m.ViewSettingsDialog;
}
/**
* A ViewSettingsFilterItem control is used for modelling filter behaviour in the ViewSettingsDialog.
* It is derived from a core Item, but does not support the base class properties like textDirection and enabled.
* Setting these properties will not have any effects.
*/
export class ViewSettingsFilterItem extends sap.m.ViewSettingsItem {
/**
* Constructor for a new ViewSettingsFilterItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.m.ViewSettingsItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.m.ViewSettingsFilterItem} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.m.ViewSettingsItem): sap.m.ViewSettingsFilterItem;
/**
* Attaches event handler fnFunction
to the {@link #event:filterDetailItemsAggregationChange filterDetailItemsAggregationChange} event of this sap.m.ViewSettingsFilterItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ViewSettingsFilterItem
itself.
*
* Let the outside world know that the filter detail aggregation was changed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ViewSettingsFilterItem
itself
* @returns {sap.m.ViewSettingsFilterItem} Reference to this
in order to allow method chaining
*/
public attachFilterDetailItemsAggregationChange(fnFunction: Function, oListener?: any): sap.m.ViewSettingsFilterItem;
/**
* Attaches event handler fnFunction
to the {@link #event:filterDetailItemsAggregationChange filterDetailItemsAggregationChange} event of this sap.m.ViewSettingsFilterItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ViewSettingsFilterItem
itself.
*
* Let the outside world know that the filter detail aggregation was changed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ViewSettingsFilterItem
itself
* @returns {sap.m.ViewSettingsFilterItem} Reference to this
in order to allow method chaining
*/
public attachFilterDetailItemsAggregationChange(oData: any, fnFunction: Function, oListener?: any): sap.m.ViewSettingsFilterItem;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.m.ViewSettingsFilterItem} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.m.ViewSettingsFilterItem;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.m.ViewSettingsFilterItem} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.m.ViewSettingsFilterItem;
/**
* Detaches event handler fnFunction
from the {@link #event:filterDetailItemsAggregationChange filterDetailItemsAggregationChange} event of this sap.m.ViewSettingsFilterItem
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ViewSettingsFilterItem} Reference to this
in order to allow method chaining
*/
public detachFilterDetailItemsAggregationChange(fnFunction: Function, oListener: any): sap.m.ViewSettingsFilterItem;
/**
* Creates a new subclass of class sap.m.ViewSettingsFilterItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.ViewSettingsItem.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:filterDetailItemsAggregationChange filterDetailItemsAggregationChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ViewSettingsFilterItem} Reference to this
in order to allow method chaining
*/
protected fireFilterDetailItemsAggregationChange(mParameters?: any): sap.m.ViewSettingsFilterItem;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Items that are logically grouped under this filter item. They are used to display filter details in the ViewSettingsDialog.
* @returns {sap.m.ViewSettingsItem[]}
*/
public getItems(): sap.m.ViewSettingsItem[];
/**
* Returns a metadata object for class sap.m.ViewSettingsFilterItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMultiSelect multiSelect}.
*
* If set to (true), multi selection will be allowed for the items aggregation.
*
* Default value is true
.
* @returns {boolean} Value of property multiSelect
*/
public getMultiSelect(): boolean;
/**
* Checks for the provided sap.m.ViewSettingsItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.ViewSettingsItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.m.ViewSettingsItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.m.ViewSettingsItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.m.ViewSettingsFilterItem} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.m.ViewSettingsItem, iIndex: number): sap.m.ViewSettingsFilterItem;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.ViewSettingsItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.m.ViewSettingsItem[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.m.ViewSettingsItem} vItem - The item to remove or its index or id
* @returns {sap.m.ViewSettingsItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.m.ViewSettingsItem): sap.m.ViewSettingsItem;
/**
* Sets a new value for property {@link #getMultiSelect multiSelect}.
*
* If set to (true), multi selection will be allowed for the items aggregation.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bMultiSelect - New value for property multiSelect
* @returns {sap.m.ViewSettingsFilterItem} Reference to this
in order to allow method chaining
*/
public setMultiSelect(bMultiSelect: boolean): sap.m.ViewSettingsFilterItem;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.m.ViewSettingsFilterItem} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.m.ViewSettingsFilterItem;
}
/**
* ViewSettingsItem is used for modelling filter behaviour in the ViewSettingsDialog.
* It is derived from a core Item, but does not support the base class properties "textDirection" and "enabled", setting these properties will not have any effects.
*/
export class ViewSettingsItem extends sap.ui.core.Item {
/**
* Constructor for a new ViewSettingsItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:itemPropertyChanged itemPropertyChanged} event of this sap.m.ViewSettingsItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ViewSettingsItem
itself.
*
* Let the outside world know that some of its properties has changed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ViewSettingsItem
itself
* @returns {sap.m.ViewSettingsItem} Reference to this
in order to allow method chaining
*/
public attachItemPropertyChanged(fnFunction: Function, oListener?: any): sap.m.ViewSettingsItem;
/**
* Attaches event handler fnFunction
to the {@link #event:itemPropertyChanged itemPropertyChanged} event of this sap.m.ViewSettingsItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.ViewSettingsItem
itself.
*
* Let the outside world know that some of its properties has changed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.ViewSettingsItem
itself
* @returns {sap.m.ViewSettingsItem} Reference to this
in order to allow method chaining
*/
public attachItemPropertyChanged(oData: any, fnFunction: Function, oListener?: any): sap.m.ViewSettingsItem;
/**
* Detaches event handler fnFunction
from the {@link #event:itemPropertyChanged itemPropertyChanged} event of this sap.m.ViewSettingsItem
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.ViewSettingsItem} Reference to this
in order to allow method chaining
*/
public detachItemPropertyChanged(fnFunction: Function, oListener: any): sap.m.ViewSettingsItem;
/**
* Creates a new subclass of class sap.m.ViewSettingsItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:itemPropertyChanged itemPropertyChanged} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.ViewSettingsItem} Reference to this
in order to allow method chaining
*/
protected fireItemPropertyChanged(mParameters?: any): sap.m.ViewSettingsItem;
/**
* Returns a metadata object for class sap.m.ViewSettingsItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSelected selected}.
*
* Selected state of the item. If set to "true", the item will be displayed as selected in the view settings dialog.
*
* Default value is false
.
* @returns {boolean} Value of property selected
*/
public getSelected(): boolean;
/**
* Sets a new value for property {@link #getSelected selected}.
*
* Selected state of the item. If set to "true", the item will be displayed as selected in the view settings dialog.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSelected - New value for property selected
* @returns {sap.m.ViewSettingsItem} Reference to this
in order to allow method chaining
*/
public setSelected(bSelected: boolean): sap.m.ViewSettingsItem;
}
/**
* Enables users to accomplish a single goal which consists of multiple dependable sub-tasks.
* Overview
* The sap.m.Wizard helps users complete a complex and unfamiliar task by dividing it into sections and guiding the user through it.
* The wizard has two main areas - a navigation area at the top showing the step sequence and a content area below it.
* Structure
* Navigation Area
* The top most area of the wizard is occupied by the navigation area. It shows the sequence of {@link sap.m.WizardStep wizard steps}.
*
* - The minimum number of steps is 3 and the maximum is 8 and are stored in the
steps
aggregation.
* - Steps can be branching depending on choices the user made in their input - this is set by the
enableBranching
property.
* - Steps can have different visual representations - numbers or icons. You can add labels for better readability
*
* Content
* The content occupies the main part of the page. It can hold any type of input controls. The content is kept in {@link sap.m.WizardStep wizard steps}.
* Next Step Button
* The next step button is displayed below the content. It can be hidden by setting showNextButton
to false
and displayed, for example,
* only after the user has filled all mandatory fields.
* Usage
* When to use:
* When the user has to accomplish a long or unfamiliar task.
* When not to use:
* When the user has to accomplish a routine task that is clear and familiar.
* When the task has only two steps or less.
* Responsive Behavior
* On mobile devices the steps in the StepNavigator are grouped together and overlap. Tapping on them will show a popover to select the step to navigate to.
*/
export class Wizard extends sap.ui.core.Control {
/**
* Constructor for a new Wizard.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds a new step to the Wizard.
* @param {sap.m.WizardStep} wizardStep - New WizardStep to add to the Wizard
* @returns {sap.m.Wizard} Pointer to the control instance for chaining
*/
public addStep(wizardStep: sap.m.WizardStep): sap.m.Wizard;
/**
* Attaches event handler fnFunction
to the {@link #event:complete complete} event of this sap.m.Wizard
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Wizard
itself.
*
* The complete event is fired when the user clicks the finish button of the Wizard.
* The finish button is only available on the last step of the Wizard.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Wizard
itself
* @returns {sap.m.Wizard} Reference to this
in order to allow method chaining
*/
public attachComplete(fnFunction: Function, oListener?: any): sap.m.Wizard;
/**
* Attaches event handler fnFunction
to the {@link #event:complete complete} event of this sap.m.Wizard
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Wizard
itself.
*
* The complete event is fired when the user clicks the finish button of the Wizard.
* The finish button is only available on the last step of the Wizard.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Wizard
itself
* @returns {sap.m.Wizard} Reference to this
in order to allow method chaining
*/
public attachComplete(oData: any, fnFunction: Function, oListener?: any): sap.m.Wizard;
/**
* Attaches event handler fnFunction
to the {@link #event:stepActivate stepActivate} event of this sap.m.Wizard
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Wizard
itself.
*
* The StepActivated event is fired every time a new step is activated.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Wizard
itself
* @returns {sap.m.Wizard} Reference to this
in order to allow method chaining
*/
public attachStepActivate(fnFunction: Function, oListener?: any): sap.m.Wizard;
/**
* Attaches event handler fnFunction
to the {@link #event:stepActivate stepActivate} event of this sap.m.Wizard
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.Wizard
itself.
*
* The StepActivated event is fired every time a new step is activated.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.Wizard
itself
* @returns {sap.m.Wizard} Reference to this
in order to allow method chaining
*/
public attachStepActivate(oData: any, fnFunction: Function, oListener?: any): sap.m.Wizard;
/**
* Destroys all aggregated steps in the Wizard.
* @returns {sap.m.Wizard} Pointer to the control instance for chaining.
*/
public destroySteps(): sap.m.Wizard;
/**
* Detaches event handler fnFunction
from the {@link #event:complete complete} event of this sap.m.Wizard
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Wizard} Reference to this
in order to allow method chaining
*/
public detachComplete(fnFunction: Function, oListener: any): sap.m.Wizard;
/**
* Detaches event handler fnFunction
from the {@link #event:stepActivate stepActivate} event of this sap.m.Wizard
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.Wizard} Reference to this
in order to allow method chaining
*/
public detachStepActivate(fnFunction: Function, oListener: any): sap.m.Wizard;
/**
* Discards all progress done from the given step(incl.) to the end of the wizard.
* The verified state of the steps is returned to the initial provided.
* @param {sap.m.WizardStep} step - The step after which the progress is discarded.
* @returns {sap.m.Wizard} Pointer to the control instance for chaining.
*/
public discardProgress(step: sap.m.WizardStep): sap.m.Wizard;
/**
* Creates a new subclass of class sap.m.Wizard with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:complete complete} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Wizard} Reference to this
in order to allow method chaining
*/
protected fireComplete(mParameters?: any): sap.m.Wizard;
/**
* Fires event {@link #event:stepActivate stepActivate} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.Wizard} Reference to this
in order to allow method chaining
*/
protected fireStepActivate(mParameters?: any): sap.m.Wizard;
/**
* ID of the element which is the current target of the association {@link #getCurrentStep currentStep}, or null
.
* @returns {sap.ui.core.ID}
*/
public getCurrentStep(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getEnableBranching enableBranching}.
*
* Enables the branching functionality of the Wizard.
* Branching gives the developer the ability to define multiple routes a user
* is able to take based on the input in the current step.
* It is up to the developer to programatically check for what is the input in the
* current step and set a concrete next step amongs the available subsequent steps.
* Note: If this property is set to false, next
and subSequentSteps
* associations of the WizardStep control are ignored.
*
* Default value is false
.
* @returns {boolean} Value of property enableBranching
*/
public getEnableBranching(): boolean;
/**
* Returns the finish button text which will be rendered.
* @returns {string} The text which will be rendered in the finish button.
*/
public getFinishButtonText(): string;
/**
* Gets current value of property {@link #getHeight height}.
*
* Determines the height of the Wizard.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.m.Wizard.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the number of the last activated step in the Wizard.
* @returns {number} The last activated step.
*/
public getProgress(): number;
/**
* Returns the last activated step in the Wizard.
* @returns {sap.m.WizardStep} Pointer to the control instance for chaining.
*/
public getProgressStep(): sap.m.WizardStep;
/**
* Gets current value of property {@link #getShowNextButton showNextButton}.
*
* Controls the visibility of the next button. The developers can choose to control the flow of the
* steps either through the API (with nextStep
and previousStep
methods) or let the user click
* the next button, and control it with validateStep
or invalidateStep
methods.
*
* Default value is true
.
* @returns {boolean} Value of property showNextButton
*/
public getShowNextButton(): boolean;
/**
* Gets content of aggregation {@link #getSteps steps}.
*
* The wizard steps to be included in the content of the control.
* @returns {sap.m.WizardStep[]}
*/
public getSteps(): sap.m.WizardStep[];
/**
* Gets current value of property {@link #getWidth width}.
*
* Determines the width of the Wizard.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Goes to the given step. The step must already be activated and visible. You can't use this method on steps
* that haven't been reached yet.
* @param {sap.m.WizardStep} step - The step to go to.
* @param {boolean} focusFirstStepElement - Defines whether the focus should be changed to the first element.
* @returns {sap.m.Wizard} Pointer to the control instance for chaining.
*/
public goToStep(step: sap.m.WizardStep, focusFirstStepElement: boolean): sap.m.Wizard;
/**
* Checks for the provided sap.m.WizardStep
in the aggregation {@link #getSteps steps}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.WizardStep} oStep - The step whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfStep(oStep: sap.m.WizardStep): number;
/**
* Dynamic step insertion is not yet supported.
*/
public insertStep(): void;
/**
* Invalidates the given step.
* @param {sap.m.WizardStep} step - The step to be invalidated.
* @returns {sap.m.Wizard} Pointer to the control instance for chaining.
*/
public invalidateStep(step: sap.m.WizardStep): sap.m.Wizard;
/**
* Validates the current step, and moves one step further.
* @returns {sap.m.Wizard} Pointer to the control instance for chaining.
*/
public nextStep(): sap.m.Wizard;
/**
* Discards the current step and goes one step back.
* @returns {sap.m.Wizard} Pointer to the control instance for chaining.
*/
public previousStep(): sap.m.Wizard;
/**
* Removes all steps from the Wizard.
* @returns {sap.m.WizardStep[]} Pointer to the Steps that were removed.
*/
public removeAllSteps(): sap.m.WizardStep[];
/**
* Dynamic step removal is not yet supported.
*/
public removeStep(): void;
/**
* Sets the associated {@link #getCurrentStep currentStep}.
* @param {sap.ui.core.ID|sap.m.WizardStep} oCurrentStep - ID of an element which becomes the new target of this currentStep association; alternatively, an element instance may be given
* @returns {sap.m.Wizard} Reference to this
in order to allow method chaining
*/
public setCurrentStep(oCurrentStep: sap.ui.core.ID|sap.m.WizardStep): sap.m.Wizard;
/**
* Sets a new value for property {@link #getEnableBranching enableBranching}.
*
* Enables the branching functionality of the Wizard.
* Branching gives the developer the ability to define multiple routes a user
* is able to take based on the input in the current step.
* It is up to the developer to programatically check for what is the input in the
* current step and set a concrete next step amongs the available subsequent steps.
* Note: If this property is set to false, next
and subSequentSteps
* associations of the WizardStep control are ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableBranching - New value for property enableBranching
* @returns {sap.m.Wizard} Reference to this
in order to allow method chaining
*/
public setEnableBranching(bEnableBranching: boolean): sap.m.Wizard;
/**
* Sets the text for the finish button. By default it is "Review".
* @param {string} value - The text of the finish button.
* @returns {sap.m.Wizard} Reference to the control instance for chaining.
*/
public setFinishButtonText(value: string): sap.m.Wizard;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Determines the height of the Wizard.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.m.Wizard} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.m.Wizard;
/**
* Sets the visiblity of the next button.
* @param {boolean} value - True to show the button or false to hide it.
* @returns {sap.m.Wizard} Reference to the control instance for chaining.
*/
public setShowNextButton(value: boolean): sap.m.Wizard;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Determines the width of the Wizard.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.m.Wizard} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.m.Wizard;
/**
* Validates the given step.
* @param {sap.m.WizardStep} step - The step to be validated.
* @returns {sap.m.Wizard} Pointer to the control instance for chaining.
*/
public validateStep(step: sap.m.WizardStep): sap.m.Wizard;
}
/**
* A container control used to aggregate user input controls as part of an sap.m.Wizard.
* Overview
* WizardStep gives the developer the ability to validate, invalidate the step and define subsequent steps.
* The WizardStep control control is supposed to be used only as an aggregation of the {@link sap.m.Wizard Wizard} control,
* and should not be used as a standalone one.
* Structure
*
* - Each wizard step has a title. Additionally it can have an icon.
* - Each wizard step can be validated by setting the
validated
property. This action will trigger the rendering of the Next step button.
* - If the execution needs to branch after a given step, you should set all possible next steps in the
subsequentSteps
aggregation.
*/
export class WizardStep extends sap.ui.core.Control {
/**
* Constructor for a new WizardStep.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.m.WizardStep;
/**
* Adds some subsequentStep into the association {@link #getSubsequentSteps subsequentSteps}.
* @param {sap.ui.core.ID|sap.m.WizardStep} vSubsequentStep - the subsequentSteps to add; if empty, nothing is inserted
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
public addSubsequentStep(vSubsequentStep: sap.ui.core.ID|sap.m.WizardStep): sap.m.WizardStep;
/**
* Attaches event handler fnFunction
to the {@link #event:activate activate} event of this sap.m.WizardStep
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.WizardStep
itself.
*
* This event is fired on next step activation from the Wizard.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.WizardStep
itself
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
public attachActivate(fnFunction: Function, oListener?: any): sap.m.WizardStep;
/**
* Attaches event handler fnFunction
to the {@link #event:activate activate} event of this sap.m.WizardStep
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.WizardStep
itself.
*
* This event is fired on next step activation from the Wizard.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.WizardStep
itself
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
public attachActivate(oData: any, fnFunction: Function, oListener?: any): sap.m.WizardStep;
/**
* Attaches event handler fnFunction
to the {@link #event:complete complete} event of this sap.m.WizardStep
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.WizardStep
itself.
*
* This event is fired after the user presses the Next button in the Wizard,
* or on nextStep
method call from the app developer.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.WizardStep
itself
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
public attachComplete(fnFunction: Function, oListener?: any): sap.m.WizardStep;
/**
* Attaches event handler fnFunction
to the {@link #event:complete complete} event of this sap.m.WizardStep
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.m.WizardStep
itself.
*
* This event is fired after the user presses the Next button in the Wizard,
* or on nextStep
method call from the app developer.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.m.WizardStep
itself
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
public attachComplete(oData: any, fnFunction: Function, oListener?: any): sap.m.WizardStep;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.m.WizardStep;
/**
* Detaches event handler fnFunction
from the {@link #event:activate activate} event of this sap.m.WizardStep
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
public detachActivate(fnFunction: Function, oListener: any): sap.m.WizardStep;
/**
* Detaches event handler fnFunction
from the {@link #event:complete complete} event of this sap.m.WizardStep
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
public detachComplete(fnFunction: Function, oListener: any): sap.m.WizardStep;
/**
* Creates a new subclass of class sap.m.WizardStep with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:activate activate} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
protected fireActivate(mParameters?: any): sap.m.WizardStep;
/**
* Fires event {@link #event:complete complete} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
protected fireComplete(mParameters?: any): sap.m.WizardStep;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content of the Wizard Step.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getIcon icon}.
*
* Determines the icon that is displayed for this step.
* The icon is visualized in the progress navigation part of the Wizard control.
* Note: In order for the icon to be displayed, each step in the Wizard should have
* this property defined, otherwise the default numbering will be displayed.
*
* Default value is
.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.m.WizardStep.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* ID of the element which is the current target of the association {@link #getNextStep nextStep}, or null
.
* @returns {sap.ui.core.ID}
*/
public getNextStep(): sap.ui.core.ID;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getSubsequentSteps subsequentSteps}.
* @returns {sap.ui.core.ID[]}
*/
public getSubsequentSteps(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getTitle title}.
*
* Determines the title of the step.
* The title is visualized in the Wizard control.
*
* Default value is
.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getValidated validated}.
*
* Indicates whether or not the step is validated.
* When a step is validated a Next button is visualized in the Wizard control.
*
* Default value is true
.
* @returns {boolean} Value of property validated
*/
public getValidated(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.m.WizardStep;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes all the controls in the association named {@link #getSubsequentSteps subsequentSteps}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllSubsequentSteps(): sap.ui.core.ID[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes an subsequentStep from the association named {@link #getSubsequentSteps subsequentSteps}.
* @param {number|sap.ui.core.ID|sap.m.WizardStep} vSubsequentStep - The subsequentStep to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed subsequentStep or null
*/
public removeSubsequentStep(vSubsequentStep: number|sap.ui.core.ID|sap.m.WizardStep): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Determines the icon that is displayed for this step.
* The icon is visualized in the progress navigation part of the Wizard control.
* Note: In order for the icon to be displayed, each step in the Wizard should have
* this property defined, otherwise the default numbering will be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.m.WizardStep;
/**
* Sets the associated {@link #getNextStep nextStep}.
* @param {sap.ui.core.ID|sap.m.WizardStep} oNextStep - ID of an element which becomes the new target of this nextStep association; alternatively, an element instance may be given
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
public setNextStep(oNextStep: sap.ui.core.ID|sap.m.WizardStep): sap.m.WizardStep;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Determines the title of the step.
* The title is visualized in the Wizard control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sTitle - New value for property title
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.m.WizardStep;
/**
* Sets a new value for property {@link #getValidated validated}.
*
* Indicates whether or not the step is validated.
* When a step is validated a Next button is visualized in the Wizard control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bValidated - New value for property validated
* @returns {sap.m.WizardStep} Reference to this
in order to allow method chaining
*/
public setValidated(bValidated: boolean): sap.m.WizardStep;
}
}
/**
* SAPUI5 library with controls specialized for administrative applications.
*/
namespace tnt {
/**
* The NavigationList control is an interactive control, which provides a choice of
* different items, ordered as a list.
*/
export class NavigationList extends sap.ui.core.Control {
/**
* Constructor for a new NavigationList.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.tnt.NavigationList} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.tnt.NavigationList;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.tnt.NavigationList} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.tnt.NavigationList;
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.tnt.NavigationListItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.tnt.NavigationList} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.tnt.NavigationListItem): sap.tnt.NavigationList;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelect itemSelect} event of this sap.tnt.NavigationList
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.tnt.NavigationList
itself.
*
* Fired when an item is selected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.tnt.NavigationList
itself
* @returns {sap.tnt.NavigationList} Reference to this
in order to allow method chaining
*/
public attachItemSelect(fnFunction: Function, oListener?: any): sap.tnt.NavigationList;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelect itemSelect} event of this sap.tnt.NavigationList
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.tnt.NavigationList
itself.
*
* Fired when an item is selected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.tnt.NavigationList
itself
* @returns {sap.tnt.NavigationList} Reference to this
in order to allow method chaining
*/
public attachItemSelect(oData: any, fnFunction: Function, oListener?: any): sap.tnt.NavigationList;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.tnt.NavigationList} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.tnt.NavigationList;
/**
* Detaches event handler fnFunction
from the {@link #event:itemSelect itemSelect} event of this sap.tnt.NavigationList
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.tnt.NavigationList} Reference to this
in order to allow method chaining
*/
public detachItemSelect(fnFunction: Function, oListener: any): sap.tnt.NavigationList;
/**
* Creates a new subclass of class sap.tnt.NavigationList with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:itemSelect itemSelect} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.tnt.NavigationList} Reference to this
in order to allow method chaining
*/
protected fireItemSelect(mParameters?: any): sap.tnt.NavigationList;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getExpanded expanded}.
*
* Specifies if the control is in expanded or collapsed mode.
*
* Default value is true
.
* @returns {boolean} Value of property expanded
*/
public getExpanded(): boolean;
/**
* Gets content of aggregation {@link #getItems items}.
*
* The items displayed in the list.
* @returns {sap.tnt.NavigationListItem[]}
*/
public getItems(): sap.tnt.NavigationListItem[];
/**
* Returns a metadata object for class sap.tnt.NavigationList.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getWidth width}.
*
* Specifies the width of the control.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.tnt.NavigationListItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.tnt.NavigationListItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.tnt.NavigationListItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.tnt.NavigationListItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.tnt.NavigationList} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.tnt.NavigationListItem, iIndex: number): sap.tnt.NavigationList;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.tnt.NavigationListItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.tnt.NavigationListItem[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.tnt.NavigationListItem} vItem - The item to remove or its index or id
* @returns {sap.tnt.NavigationListItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.tnt.NavigationListItem): sap.tnt.NavigationListItem;
/**
* Sets a new value for property {@link #getExpanded expanded}.
*
* Specifies if the control is in expanded or collapsed mode.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bExpanded - New value for property expanded
* @returns {sap.tnt.NavigationList} Reference to this
in order to allow method chaining
*/
public setExpanded(bExpanded: boolean): sap.tnt.NavigationList;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Specifies the width of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.tnt.NavigationList} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.tnt.NavigationList;
}
/**
* The NavigationListItem control represents an action, which can be selected by the user.
* It can provide sub items.
*/
export class NavigationListItem extends sap.ui.core.Item {
/**
* Constructor for a new NavigationListItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.tnt.NavigationListItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.tnt.NavigationListItem} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.tnt.NavigationListItem): sap.tnt.NavigationListItem;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.tnt.NavigationListItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.tnt.NavigationListItem
itself.
*
* Fired when this item is selected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.tnt.NavigationListItem
itself
* @returns {sap.tnt.NavigationListItem} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.tnt.NavigationListItem;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.tnt.NavigationListItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.tnt.NavigationListItem
itself.
*
* Fired when this item is selected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.tnt.NavigationListItem
itself
* @returns {sap.tnt.NavigationListItem} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.tnt.NavigationListItem;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.tnt.NavigationListItem} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.tnt.NavigationListItem;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.tnt.NavigationListItem
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.tnt.NavigationListItem} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.tnt.NavigationListItem;
/**
* Creates a new subclass of class sap.tnt.NavigationListItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.tnt.NavigationListItem} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.tnt.NavigationListItem;
/**
* Gets current value of property {@link #getExpanded expanded}.
*
* Specifies if the item is expanded.
*
* Default value is true
.
* @returns {boolean} Value of property expanded
*/
public getExpanded(): boolean;
/**
* Gets current value of property {@link #getHasExpander hasExpander}.
*
* Specifies if the item has an expander.
*
* Default value is true
.
* @returns {boolean} Value of property hasExpander
*/
public getHasExpander(): boolean;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Specifies the icon for the item.
*
* Default value is
.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets content of aggregation {@link #getItems items}.
*
* The sub items.
* @returns {sap.tnt.NavigationListItem[]}
*/
public getItems(): sap.tnt.NavigationListItem[];
/**
* Returns a metadata object for class sap.tnt.NavigationListItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.tnt.NavigationListItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.tnt.NavigationListItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.tnt.NavigationListItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.tnt.NavigationListItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.tnt.NavigationListItem} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.tnt.NavigationListItem, iIndex: number): sap.tnt.NavigationListItem;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.tnt.NavigationListItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.tnt.NavigationListItem[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.tnt.NavigationListItem} vItem - The item to remove or its index or id
* @returns {sap.tnt.NavigationListItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.tnt.NavigationListItem): sap.tnt.NavigationListItem;
/**
* Sets a new value for property {@link #getExpanded expanded}.
*
* Specifies if the item is expanded.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bExpanded - New value for property expanded
* @returns {sap.tnt.NavigationListItem} Reference to this
in order to allow method chaining
*/
public setExpanded(bExpanded: boolean): sap.tnt.NavigationListItem;
/**
* Sets a new value for property {@link #getHasExpander hasExpander}.
*
* Specifies if the item has an expander.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bHasExpander - New value for property hasExpander
* @returns {sap.tnt.NavigationListItem} Reference to this
in order to allow method chaining
*/
public setHasExpander(bHasExpander: boolean): sap.tnt.NavigationListItem;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Specifies the icon for the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.tnt.NavigationListItem} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.tnt.NavigationListItem;
}
/**
* The SideNavigation control is a container, which consists of flexible and fixed parts on top of each other. The flexible part adapts its size to the fixed one.
* The flexible part has a scrollbar when the content is larger than the available space.
* Whenever the height of the whole control is less than 256 pixels, the scrollbar becomes joint for the two parts.
*
* Note: In order for the SideNavigation to stretch properly, its parent layout control should only be the sap.tnt.ToolPage.
*/
export class SideNavigation extends sap.ui.core.Control {
/**
* Constructor for a new SideNavigation.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelect itemSelect} event of this sap.tnt.SideNavigation
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.tnt.SideNavigation
itself.
*
* Fired when an item is selected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.tnt.SideNavigation
itself
* @returns {sap.tnt.SideNavigation} Reference to this
in order to allow method chaining
*/
public attachItemSelect(fnFunction: Function, oListener?: any): sap.tnt.SideNavigation;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelect itemSelect} event of this sap.tnt.SideNavigation
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.tnt.SideNavigation
itself.
*
* Fired when an item is selected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.tnt.SideNavigation
itself
* @returns {sap.tnt.SideNavigation} Reference to this
in order to allow method chaining
*/
public attachItemSelect(oData: any, fnFunction: Function, oListener?: any): sap.tnt.SideNavigation;
/**
* Binds aggregation {@link #getItem item} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.tnt.SideNavigation} Reference to this
in order to allow method chaining
*/
public bindItem(oBindingInfo: any): sap.tnt.SideNavigation;
/**
* Destroys the fixedItem in the aggregation {@link #getFixedItem fixedItem}.
* @returns {sap.tnt.SideNavigation} Reference to this
in order to allow method chaining
*/
public destroyFixedItem(): sap.tnt.SideNavigation;
/**
* Destroys the footer in the aggregation {@link #getFooter footer}.
* @returns {sap.tnt.SideNavigation} Reference to this
in order to allow method chaining
*/
public destroyFooter(): sap.tnt.SideNavigation;
/**
* Destroys the item in the aggregation {@link #getItem item}.
* @returns {sap.tnt.SideNavigation} Reference to this
in order to allow method chaining
*/
public destroyItem(): sap.tnt.SideNavigation;
/**
* Detaches event handler fnFunction
from the {@link #event:itemSelect itemSelect} event of this sap.tnt.SideNavigation
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.tnt.SideNavigation} Reference to this
in order to allow method chaining
*/
public detachItemSelect(fnFunction: Function, oListener: any): sap.tnt.SideNavigation;
/**
* Creates a new subclass of class sap.tnt.SideNavigation with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:itemSelect itemSelect} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.tnt.SideNavigation} Reference to this
in order to allow method chaining
*/
protected fireItemSelect(mParameters?: any): sap.tnt.SideNavigation;
/**
* Gets current value of property {@link #getExpanded expanded}.
*
* Specifies if the control is expanded.
*
* Default value is true
.
* @returns {boolean} Value of property expanded
*/
public getExpanded(): boolean;
/**
* Gets content of aggregation {@link #getFixedItem fixedItem}.
*
* Defines the content inside the fixed part.
* @returns {sap.tnt.NavigationList}
*/
public getFixedItem(): sap.tnt.NavigationList;
/**
* Gets content of aggregation {@link #getFooter footer}.
*
* Defines the content inside the footer.
* @returns {sap.tnt.NavigationList}
*/
public getFooter(): sap.tnt.NavigationList;
/**
* Gets content of aggregation {@link #getItem item}.
*
* Defines the content inside the flexible part.
* @returns {sap.tnt.NavigationList}
*/
public getItem(): sap.tnt.NavigationList;
/**
* Returns a metadata object for class sap.tnt.SideNavigation.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets a new value for property {@link #getExpanded expanded}.
*
* Specifies if the control is expanded.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bExpanded - New value for property expanded
* @returns {sap.tnt.SideNavigation} Reference to this
in order to allow method chaining
*/
public setExpanded(bExpanded: boolean): sap.tnt.SideNavigation;
/**
* Sets if the control is in expanded or collapsed mode.
* @param {boolean} isExpanded - Indication if the SideNavigation is expanded.
* @returns {sap.tnt.SideNavigation} this SideNavigation reference for chaining.
*/
public static setExpanded(isExpanded: boolean): sap.tnt.SideNavigation;
/**
* Sets the aggregated {@link #getFixedItem fixedItem}.
* @param {sap.tnt.NavigationList} oFixedItem - The fixedItem to set
* @returns {sap.tnt.SideNavigation} Reference to this
in order to allow method chaining
*/
public setFixedItem(oFixedItem: sap.tnt.NavigationList): sap.tnt.SideNavigation;
/**
* Sets the aggregated {@link #getFooter footer}.
* @param {sap.tnt.NavigationList} oFooter - The footer to set
* @returns {sap.tnt.SideNavigation} Reference to this
in order to allow method chaining
*/
public setFooter(oFooter: sap.tnt.NavigationList): sap.tnt.SideNavigation;
/**
* Sets the aggregated {@link #getItem item}.
* @param {sap.tnt.NavigationList} oItem - The item to set
* @returns {sap.tnt.SideNavigation} Reference to this
in order to allow method chaining
*/
public setItem(oItem: sap.tnt.NavigationList): sap.tnt.SideNavigation;
/**
* Unbinds aggregation {@link #getItem item} from model data.
* @returns {sap.tnt.SideNavigation} Reference to this
in order to allow method chaining
*/
public unbindItem(): sap.tnt.SideNavigation;
}
/**
* The ToolHeader control is a horizontal container that is most
* commonly used to display buttons, labels, selects and other various input controls.
*
* The ToolHeader control is based on sap.m.OverflowToolbar. In addition to the OverflowToolbar,
* the user can specify where the overflow button is placed.
*/
export class ToolHeader extends sap.m.OverflowToolbar {
/**
* Constructor for a new ToolHeader.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.tnt.ToolHeader with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.OverflowToolbar.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.tnt.ToolHeader.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* The ToolHeaderUtilitySeparator control is used in the sap.tnt.ToolHeader control
* to specify where the overflow button is placed.
*/
export class ToolHeaderUtilitySeparator extends sap.ui.core.Control {
/**
* Constructor for a new ToolHeaderUtilitySeparator.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.tnt.ToolHeaderUtilitySeparator with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.tnt.ToolHeaderUtilitySeparator.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* The ToolPage is a layout control, used to put together the parts of a basic tools app - ToolHeader, SideNavigation and contents area.
*/
export class ToolPage extends sap.ui.core.Control {
/**
* Constructor for a new ToolPage.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some mainContent to the aggregation {@link #getMainContents mainContents}.
* @param {sap.ui.core.Control} oMainContent - the mainContent to add; if empty, nothing is inserted
* @returns {sap.tnt.ToolPage} Reference to this
in order to allow method chaining
*/
public addMainContent(oMainContent: sap.ui.core.Control): sap.tnt.ToolPage;
/**
* Destroys the header in the aggregation {@link #getHeader header}.
* @returns {sap.tnt.ToolPage} Reference to this
in order to allow method chaining
*/
public destroyHeader(): sap.tnt.ToolPage;
/**
* Destroys all the mainContents in the aggregation {@link #getMainContents mainContents}.
* @returns {sap.tnt.ToolPage} Reference to this
in order to allow method chaining
*/
public destroyMainContents(): sap.tnt.ToolPage;
/**
* Destroys the sideContent in the aggregation {@link #getSideContent sideContent}.
* @returns {sap.tnt.ToolPage} Reference to this
in order to allow method chaining
*/
public destroySideContent(): sap.tnt.ToolPage;
/**
* Creates a new subclass of class sap.tnt.ToolPage with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getHeader header}.
*
* The control to appear in the header area.
* @returns {sap.tnt.ToolHeader}
*/
public getHeader(): sap.tnt.ToolHeader;
/**
* Gets content of aggregation {@link #getMainContents mainContents}.
*
* The content section.
* @returns {sap.ui.core.Control[]}
*/
public getMainContents(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.tnt.ToolPage.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getSideContent sideContent}.
*
* The side menu of the layout.
* @returns {sap.tnt.SideNavigation}
*/
public getSideContent(): sap.tnt.SideNavigation;
/**
* Gets current value of property {@link #getSideExpanded sideExpanded}.
*
* Indicates if the side area is expanded. Overrides the expanded property of the sideContent aggregation.
*
* Default value is true
.
* @returns {boolean} Value of property sideExpanded
*/
public getSideExpanded(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getMainContents mainContents}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oMainContent - The mainContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfMainContent(oMainContent: sap.ui.core.Control): number;
/**
* Inserts a mainContent into the aggregation {@link #getMainContents mainContents}.
* @param {sap.ui.core.Control} oMainContent - the mainContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the mainContent should be inserted at; for a negative value of iIndex
, the mainContent is inserted at position 0; for a value greater than the current size of the aggregation, the mainContent is inserted at the last position
* @returns {sap.tnt.ToolPage} Reference to this
in order to allow method chaining
*/
public insertMainContent(oMainContent: sap.ui.core.Control, iIndex: number): sap.tnt.ToolPage;
/**
* Removes all the controls from the aggregation {@link #getMainContents mainContents}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllMainContents(): sap.ui.core.Control[];
/**
* Removes a mainContent from the aggregation {@link #getMainContents mainContents}.
* @param {number|string|sap.ui.core.Control} vMainContent - The mainContent to remove or its index or id
* @returns {sap.ui.core.Control} The removed mainContent or null
*/
public removeMainContent(vMainContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets the aggregated {@link #getHeader header}.
* @param {sap.tnt.ToolHeader} oHeader - The header to set
* @returns {sap.tnt.ToolPage} Reference to this
in order to allow method chaining
*/
public setHeader(oHeader: sap.tnt.ToolHeader): sap.tnt.ToolPage;
/**
* Sets the aggregated {@link #getSideContent sideContent}.
* @param {sap.tnt.SideNavigation} oSideContent - The sideContent to set
* @returns {sap.tnt.ToolPage} Reference to this
in order to allow method chaining
*/
public setSideContent(oSideContent: sap.tnt.SideNavigation): sap.tnt.ToolPage;
/**
* Sets the expand/collapse state of the SideContent.
* @param {boolean} isSideExpanded - defines whether the SideNavigation is expanded.
* @returns {sap.tnt.ToolPage} Pointer to the control instance for chaining
*/
public setSideExpanded(isSideExpanded: boolean): sap.tnt.ToolPage;
/**
* Toggles the expand/collapse state of the SideContent.
* @returns {sap.tnt.ToolPage} Pointer to the control instance for chaining.
*/
public toggleSideContentMode(): sap.tnt.ToolPage;
}
}
/**
* The sap.ui
namespace is the central OpenAjax compliant entry
* point for UI related JavaScript functionality provided by SAP.
*/
namespace ui {
/**
* Creates a new instance of a Component
or returns the instance
* of an existing Component
.
*
* If you want to look up an existing Component
you can call
* this function with a Component ID as parameter:
*
* var oComponent = sap.ui.component(sComponentId);
*
*
* To create a new instance of a component you pass a component configuration
* object into this function:
*
* var oComponent = sap.ui.component({
* name: "my.Component",
* url: "my/component/location",
* id: "myCompId1"
* });
*
* @param {string|any} vConfig - ID of an existing Component or the configuration object to create the Component
* @returns {sap.ui.core.Component|Promise} the Component instance or a Promise in case of asynchronous loading
*/
function component(vConfig: string|any): sap.ui.core.Component|Promise;
/**
* Defines a controller class or creates an instance of an already defined controller class.
*
* When a name and a controller implementation object is given, a new controller class
* of the given name is created. The members of the implementation object will be copied
* into each new instance of that controller class (shallow copy).
* Note: as the members are shallow copied, controller instances will share all object values.
* This might or might not be what applications expect.
*
* If only a name is given, a new instance of the named controller class is returned.
* @param {string} sName - The controller name
* @param {any} oControllerImpl - An object literal defining the methods and properties of the controller
* @returns {void|sap.ui.core.mvc.Controller} void or the new controller instance, depending on the use case
*/
function controller(sName: string, oControllerImpl?: any): void|sap.ui.core.mvc.Controller;
/**
* Defines a Javascript module with its name, its dependencies and a module value or factory.
*
* The typical and only suggested usage of this method is to have one single, top level call to
* sap.ui.define
in one Javascript resource (file). When a module is requested by its
* name for the first time, the corresponding resource is determined from the name and the current
* {@link jQuery.sap.registerResourcePath configuration}. The resource will be loaded and executed
* which in turn will execute the top level sap.ui.define
call.
*
* If the module name was omitted from that call, it will be substituted by the name that was used to
* request the module. As a preparation step, the dependencies as well as their transitive dependencies,
* will be loaded. Then, the module value will be determined: if a static value (object, literal) was
* given as vFactory
, that value will be the module value. If a function was given, that
* function will be called (providing the module values of the declared dependencies as parameters
* to the function) and its return value will be used as module value. The framework internally associates
* the resulting value with the module name and provides it to the original requester of the module.
* Whenever the module is requested again, the same value will be returned (modules are executed only once).
*
* Example:
* The following example defines a module "SomeClass", but doesn't hard code the module name.
* If stored in a file 'sap/mylib/SomeClass.js', it can be requested as 'sap/mylib/SomeClass'.
*
* sap.ui.define(['./Helper', 'sap/m/Bar'], function(Helper,Bar) {
*
* // create a new class
* var SomeClass = function() {};
*
* // add methods to its prototype
* SomeClass.prototype.foo = function() {
*
* // use a function from the dependency 'Helper' in the same package (e.g. 'sap/mylib/Helper' )
* var mSettings = Helper.foo();
*
* // create and return an sap.m.Bar (using its local name 'Bar')
* return new Bar(mSettings);
*
* }
*
* // return the class as module value
* return SomeClass;
*
* });
*
*
* In another module or in an application HTML page, the {@link sap.ui.require} API can be used
* to load the Something module and to work with it:
*
*
* sap.ui.require(['sap/mylib/Something'], function(Something) {
*
* // instantiate a Something and call foo() on it
* new Something().foo();
*
* });
*
*
* Module Name Syntax
* sap.ui.define
uses a simplified variant of the {@link jQuery.sap.getResourcePath
* unified resource name} syntax for the module's own name as well as for its dependencies.
* The only difference to that syntax is, that for sap.ui.define
and
* sap.ui.require
, the extension (which always would be '.js') has to be omitted.
* Both methods always add this extension internally.
*
* As a convenience, the name of a dependency can start with the segment './' which will be
* replaced by the name of the package that contains the currently defined module (relative name).
*
* It is best practice to omit the name of the defined module (first parameter) and to use
* relative names for the dependencies whenever possible. This reduces the necessary configuration,
* simplifies renaming of packages and allows to map them to a different namespace.
*
*
* Dependency to Modules
* If a dependencies array is given, each entry represents the name of another module that
* the currently defined module depends on. All dependency modules are loaded before the value
* of the currently defined module is determined. The module value of each dependency module
* will be provided as a parameter to a factory function, the order of the parameters will match
* the order of the modules in the dependencies array.
*
* Note: the order in which the dependency modules are executed is not
* defined by the order in the dependencies array! The execution order is affected by dependencies
* between the dependency modules as well as by their current state (whether a module
* already has been loaded or not). Neither module implementations nor dependents that require
* a module set must make any assumption about the execution order (other than expressed by
* their dependencies). There is, however, one exception with regard to third party libraries,
* see the list of limitations further down below.
*
* Note:a static module value (a literal provided to sap.ui.define
) cannot
* depend on the module values of the dependency modules. Instead, modules can use a factory function,
* calculate the static value in that function, potentially based on the dependencies, and return
* the result as module value. The same approach must be taken when the module value is supposed
* to be a function.
*
*
* Asynchronous Contract
* sap.ui.define
is designed to support real Asynchronous Module Definitions (AMD)
* in future, although it internally still uses the the old synchronous module loading of UI5.
* Callers of sap.ui.define
therefore must not rely on any synchronous behavior
* that they might observe with the current implementation.
*
* For example, callers of sap.ui.define
must not use the module value immediately
* after invoking sap.ui.define
:
*
*
* // COUNTER EXAMPLE HOW __NOT__ TO DO IT
*
* // define a class Something as AMD module
* sap.ui.define('Something', [], function() {
* var Something = function() {};
* return Something;
* });
*
* // DON'T DO THAT!
* // accessing the class _synchronously_ after sap.ui.define was called
* new Something();
*
*
* Applications that need to ensure synchronous module definition or synchronous loading of dependencies
* MUST use the old {@link jQuery.sap.declare} and {@link jQuery.sap.require} APIs.
*
*
* (No) Global References
* To be in line with AMD best practices, modules defined with sap.ui.define
* should not make any use of global variables if those variables are also available as module
* values. Instead, they should add dependencies to those modules and use the corresponding parameter
* of the factory function to access the module value.
*
* As the current programming model and the documentation of UI5 heavily rely on global names,
* there will be a transition phase where UI5 enables AMD modules and local references to module
* values in parallel to the old global names. The fourth parameter of sap.ui.define
* has been added to support that transition phase. When this parameter is set to true, the framework
* provides two additional functionalities
*
*
* - before the factory function is called, the existence of the global parent namespace for
* the current module is ensured
* - the module value will be automatically exported under a global name which is derived from
* the name of the module
*
*
* The parameter lets the framework know whether any of those two operations is needed or not.
* In future versions of UI5, a central configuration option is planned to suppress those 'exports'.
*
*
* Third Party Modules
* Although third party modules don't use UI5 APIs, they still can be listed as dependencies in
* a sap.ui.define
call. They will be requested and executed like UI5 modules, but their
* module value will be undefined
.
*
* If the currently defined module needs to access the module value of such a third party module,
* it can access the value via its global name (if the module supports such a usage).
*
* Note that UI5 temporarily deactivates an existing AMD loader while it executes third party modules
* known to support AMD. This sounds contradictorily at a first glance as UI5 wants to support AMD,
* but for now it is necessary to fully support UI5 applications that rely on global names for such modules.
*
* Example:
*
* // module 'Something' wants to use third party library 'URI.js'
* // It is packaged by UI5 as non-UI5-module 'sap/ui/thirdparty/URI'
*
* sap.ui.define('Something', ['sap/ui/thirdparty/URI'], function(URIModuleValue) {
*
* new URIModuleValue(); // fails as module value is undefined
*
* //global URI // (optional) declare usage of global name so that static code checks don't complain
* new URI(); // access to global name 'URI' works
*
* ...
* });
*
*
*
* Differences to requireJS
* The current implementation of sap.ui.define
differs from requireJS
* or other AMD loaders in several aspects:
*
* - the name
sap.ui.define
is different from the plain define
.
* This has two reasons: first, it avoids the impression that sap.ui.define
is
* an exact implementation of an AMD loader. And second, it allows the coexistence of an AMD
* loader (requireJS) and sap.ui.define
in one application as long as UI5 or
* applications using UI5 are not fully prepared to run with an AMD loader
* sap.ui.define
currently loads modules with synchronous XHR calls. This is
* basically a tribute to the synchronous history of UI5.
* BUT: synchronous dependency loading and factory execution explicitly it not part of
* contract of sap.ui.define
. To the contrary, it is already clear and planned
* that asynchronous loading will be implemented, at least as an alternative if not as the only
* implementation. Also check section Asynchronous Contract above.
* Applications that need to ensure synchronous loading of dependencies MUST use the old
* {@link jQuery.sap.require} API.
* sap.ui.define
does not support plugins to use other file types, formats or
* protocols. It is not planned to support this in future
* sap.ui.define
does not support the 'sugar' of requireJS where CommonJS
* style dependency declarations using sap.ui.require("something")
are automagically
* converted into sap.ui.define
dependencies before executing the factory function.
*
*
*
* Limitations, Design Considerations
*
* - Limitation: as dependency management is not supported for Non-UI5 modules, the only way
* to ensure proper execution order for such modules currently is to rely on the order in the
* dependency array. Obviously, this only works as long as
sap.ui.define
uses
* synchronous loading. It will be enhanced when asynchronous loading is implemented.
* - it was discussed to enforce asynchronous execution of the module factory function (e.g. with a
* timeout of 0). But this would have invalidated the current migration scenario where a
* sync
jQuery.sap.require
call can load a sap.ui.define
'ed module.
* If the module definition would not execute synchronously, the synchronous contract of the
* require call would be broken (default behavior in existing UI5 applications)
* - a single file must not contain multiple calls to
sap.ui.define
. Multiple calls
* currently are only supported in the so called 'preload' files that the UI5 merge tooling produces.
* The exact details of how this works might be changed in future implementations and are not
* yet part of the API contract
*
* @param {Function|any} vFactory - the module value or a function that calculates the value
* @param {boolean} bExport - whether an export to global names is required - should be used by SAP-owned code only
*/
function define(vFactory: Function|any, bExport?: boolean): void;
/**
* Defines a Javascript module with its name, its dependencies and a module value or factory.
*
* The typical and only suggested usage of this method is to have one single, top level call to
* sap.ui.define
in one Javascript resource (file). When a module is requested by its
* name for the first time, the corresponding resource is determined from the name and the current
* {@link jQuery.sap.registerResourcePath configuration}. The resource will be loaded and executed
* which in turn will execute the top level sap.ui.define
call.
*
* If the module name was omitted from that call, it will be substituted by the name that was used to
* request the module. As a preparation step, the dependencies as well as their transitive dependencies,
* will be loaded. Then, the module value will be determined: if a static value (object, literal) was
* given as vFactory
, that value will be the module value. If a function was given, that
* function will be called (providing the module values of the declared dependencies as parameters
* to the function) and its return value will be used as module value. The framework internally associates
* the resulting value with the module name and provides it to the original requester of the module.
* Whenever the module is requested again, the same value will be returned (modules are executed only once).
*
* Example:
* The following example defines a module "SomeClass", but doesn't hard code the module name.
* If stored in a file 'sap/mylib/SomeClass.js', it can be requested as 'sap/mylib/SomeClass'.
*
* sap.ui.define(['./Helper', 'sap/m/Bar'], function(Helper,Bar) {
*
* // create a new class
* var SomeClass = function() {};
*
* // add methods to its prototype
* SomeClass.prototype.foo = function() {
*
* // use a function from the dependency 'Helper' in the same package (e.g. 'sap/mylib/Helper' )
* var mSettings = Helper.foo();
*
* // create and return an sap.m.Bar (using its local name 'Bar')
* return new Bar(mSettings);
*
* }
*
* // return the class as module value
* return SomeClass;
*
* });
*
*
* In another module or in an application HTML page, the {@link sap.ui.require} API can be used
* to load the Something module and to work with it:
*
*
* sap.ui.require(['sap/mylib/Something'], function(Something) {
*
* // instantiate a Something and call foo() on it
* new Something().foo();
*
* });
*
*
* Module Name Syntax
* sap.ui.define
uses a simplified variant of the {@link jQuery.sap.getResourcePath
* unified resource name} syntax for the module's own name as well as for its dependencies.
* The only difference to that syntax is, that for sap.ui.define
and
* sap.ui.require
, the extension (which always would be '.js') has to be omitted.
* Both methods always add this extension internally.
*
* As a convenience, the name of a dependency can start with the segment './' which will be
* replaced by the name of the package that contains the currently defined module (relative name).
*
* It is best practice to omit the name of the defined module (first parameter) and to use
* relative names for the dependencies whenever possible. This reduces the necessary configuration,
* simplifies renaming of packages and allows to map them to a different namespace.
*
*
* Dependency to Modules
* If a dependencies array is given, each entry represents the name of another module that
* the currently defined module depends on. All dependency modules are loaded before the value
* of the currently defined module is determined. The module value of each dependency module
* will be provided as a parameter to a factory function, the order of the parameters will match
* the order of the modules in the dependencies array.
*
* Note: the order in which the dependency modules are executed is not
* defined by the order in the dependencies array! The execution order is affected by dependencies
* between the dependency modules as well as by their current state (whether a module
* already has been loaded or not). Neither module implementations nor dependents that require
* a module set must make any assumption about the execution order (other than expressed by
* their dependencies). There is, however, one exception with regard to third party libraries,
* see the list of limitations further down below.
*
* Note:a static module value (a literal provided to sap.ui.define
) cannot
* depend on the module values of the dependency modules. Instead, modules can use a factory function,
* calculate the static value in that function, potentially based on the dependencies, and return
* the result as module value. The same approach must be taken when the module value is supposed
* to be a function.
*
*
* Asynchronous Contract
* sap.ui.define
is designed to support real Asynchronous Module Definitions (AMD)
* in future, although it internally still uses the the old synchronous module loading of UI5.
* Callers of sap.ui.define
therefore must not rely on any synchronous behavior
* that they might observe with the current implementation.
*
* For example, callers of sap.ui.define
must not use the module value immediately
* after invoking sap.ui.define
:
*
*
* // COUNTER EXAMPLE HOW __NOT__ TO DO IT
*
* // define a class Something as AMD module
* sap.ui.define('Something', [], function() {
* var Something = function() {};
* return Something;
* });
*
* // DON'T DO THAT!
* // accessing the class _synchronously_ after sap.ui.define was called
* new Something();
*
*
* Applications that need to ensure synchronous module definition or synchronous loading of dependencies
* MUST use the old {@link jQuery.sap.declare} and {@link jQuery.sap.require} APIs.
*
*
* (No) Global References
* To be in line with AMD best practices, modules defined with sap.ui.define
* should not make any use of global variables if those variables are also available as module
* values. Instead, they should add dependencies to those modules and use the corresponding parameter
* of the factory function to access the module value.
*
* As the current programming model and the documentation of UI5 heavily rely on global names,
* there will be a transition phase where UI5 enables AMD modules and local references to module
* values in parallel to the old global names. The fourth parameter of sap.ui.define
* has been added to support that transition phase. When this parameter is set to true, the framework
* provides two additional functionalities
*
*
* - before the factory function is called, the existence of the global parent namespace for
* the current module is ensured
* - the module value will be automatically exported under a global name which is derived from
* the name of the module
*
*
* The parameter lets the framework know whether any of those two operations is needed or not.
* In future versions of UI5, a central configuration option is planned to suppress those 'exports'.
*
*
* Third Party Modules
* Although third party modules don't use UI5 APIs, they still can be listed as dependencies in
* a sap.ui.define
call. They will be requested and executed like UI5 modules, but their
* module value will be undefined
.
*
* If the currently defined module needs to access the module value of such a third party module,
* it can access the value via its global name (if the module supports such a usage).
*
* Note that UI5 temporarily deactivates an existing AMD loader while it executes third party modules
* known to support AMD. This sounds contradictorily at a first glance as UI5 wants to support AMD,
* but for now it is necessary to fully support UI5 applications that rely on global names for such modules.
*
* Example:
*
* // module 'Something' wants to use third party library 'URI.js'
* // It is packaged by UI5 as non-UI5-module 'sap/ui/thirdparty/URI'
*
* sap.ui.define('Something', ['sap/ui/thirdparty/URI'], function(URIModuleValue) {
*
* new URIModuleValue(); // fails as module value is undefined
*
* //global URI // (optional) declare usage of global name so that static code checks don't complain
* new URI(); // access to global name 'URI' works
*
* ...
* });
*
*
*
* Differences to requireJS
* The current implementation of sap.ui.define
differs from requireJS
* or other AMD loaders in several aspects:
*
* - the name
sap.ui.define
is different from the plain define
.
* This has two reasons: first, it avoids the impression that sap.ui.define
is
* an exact implementation of an AMD loader. And second, it allows the coexistence of an AMD
* loader (requireJS) and sap.ui.define
in one application as long as UI5 or
* applications using UI5 are not fully prepared to run with an AMD loader
* sap.ui.define
currently loads modules with synchronous XHR calls. This is
* basically a tribute to the synchronous history of UI5.
* BUT: synchronous dependency loading and factory execution explicitly it not part of
* contract of sap.ui.define
. To the contrary, it is already clear and planned
* that asynchronous loading will be implemented, at least as an alternative if not as the only
* implementation. Also check section Asynchronous Contract above.
* Applications that need to ensure synchronous loading of dependencies MUST use the old
* {@link jQuery.sap.require} API.
* sap.ui.define
does not support plugins to use other file types, formats or
* protocols. It is not planned to support this in future
* sap.ui.define
does not support the 'sugar' of requireJS where CommonJS
* style dependency declarations using sap.ui.require("something")
are automagically
* converted into sap.ui.define
dependencies before executing the factory function.
*
*
*
* Limitations, Design Considerations
*
* - Limitation: as dependency management is not supported for Non-UI5 modules, the only way
* to ensure proper execution order for such modules currently is to rely on the order in the
* dependency array. Obviously, this only works as long as
sap.ui.define
uses
* synchronous loading. It will be enhanced when asynchronous loading is implemented.
* - it was discussed to enforce asynchronous execution of the module factory function (e.g. with a
* timeout of 0). But this would have invalidated the current migration scenario where a
* sync
jQuery.sap.require
call can load a sap.ui.define
'ed module.
* If the module definition would not execute synchronously, the synchronous contract of the
* require call would be broken (default behavior in existing UI5 applications)
* - a single file must not contain multiple calls to
sap.ui.define
. Multiple calls
* currently are only supported in the so called 'preload' files that the UI5 merge tooling produces.
* The exact details of how this works might be changed in future implementations and are not
* yet part of the API contract
*
* @param {string} sModuleName - name of the module in simplified resource name syntax. When omitted, the loader determines the name from the request.
* @param {Function|any} vFactory - the module value or a function that calculates the value
* @param {boolean} bExport - whether an export to global names is required - should be used by SAP-owned code only
*/
function define(sModuleName: string, vFactory: Function|any, bExport?: boolean): void;
/**
* Defines a Javascript module with its name, its dependencies and a module value or factory.
*
* The typical and only suggested usage of this method is to have one single, top level call to
* sap.ui.define
in one Javascript resource (file). When a module is requested by its
* name for the first time, the corresponding resource is determined from the name and the current
* {@link jQuery.sap.registerResourcePath configuration}. The resource will be loaded and executed
* which in turn will execute the top level sap.ui.define
call.
*
* If the module name was omitted from that call, it will be substituted by the name that was used to
* request the module. As a preparation step, the dependencies as well as their transitive dependencies,
* will be loaded. Then, the module value will be determined: if a static value (object, literal) was
* given as vFactory
, that value will be the module value. If a function was given, that
* function will be called (providing the module values of the declared dependencies as parameters
* to the function) and its return value will be used as module value. The framework internally associates
* the resulting value with the module name and provides it to the original requester of the module.
* Whenever the module is requested again, the same value will be returned (modules are executed only once).
*
* Example:
* The following example defines a module "SomeClass", but doesn't hard code the module name.
* If stored in a file 'sap/mylib/SomeClass.js', it can be requested as 'sap/mylib/SomeClass'.
*
* sap.ui.define(['./Helper', 'sap/m/Bar'], function(Helper,Bar) {
*
* // create a new class
* var SomeClass = function() {};
*
* // add methods to its prototype
* SomeClass.prototype.foo = function() {
*
* // use a function from the dependency 'Helper' in the same package (e.g. 'sap/mylib/Helper' )
* var mSettings = Helper.foo();
*
* // create and return an sap.m.Bar (using its local name 'Bar')
* return new Bar(mSettings);
*
* }
*
* // return the class as module value
* return SomeClass;
*
* });
*
*
* In another module or in an application HTML page, the {@link sap.ui.require} API can be used
* to load the Something module and to work with it:
*
*
* sap.ui.require(['sap/mylib/Something'], function(Something) {
*
* // instantiate a Something and call foo() on it
* new Something().foo();
*
* });
*
*
* Module Name Syntax
* sap.ui.define
uses a simplified variant of the {@link jQuery.sap.getResourcePath
* unified resource name} syntax for the module's own name as well as for its dependencies.
* The only difference to that syntax is, that for sap.ui.define
and
* sap.ui.require
, the extension (which always would be '.js') has to be omitted.
* Both methods always add this extension internally.
*
* As a convenience, the name of a dependency can start with the segment './' which will be
* replaced by the name of the package that contains the currently defined module (relative name).
*
* It is best practice to omit the name of the defined module (first parameter) and to use
* relative names for the dependencies whenever possible. This reduces the necessary configuration,
* simplifies renaming of packages and allows to map them to a different namespace.
*
*
* Dependency to Modules
* If a dependencies array is given, each entry represents the name of another module that
* the currently defined module depends on. All dependency modules are loaded before the value
* of the currently defined module is determined. The module value of each dependency module
* will be provided as a parameter to a factory function, the order of the parameters will match
* the order of the modules in the dependencies array.
*
* Note: the order in which the dependency modules are executed is not
* defined by the order in the dependencies array! The execution order is affected by dependencies
* between the dependency modules as well as by their current state (whether a module
* already has been loaded or not). Neither module implementations nor dependents that require
* a module set must make any assumption about the execution order (other than expressed by
* their dependencies). There is, however, one exception with regard to third party libraries,
* see the list of limitations further down below.
*
* Note:a static module value (a literal provided to sap.ui.define
) cannot
* depend on the module values of the dependency modules. Instead, modules can use a factory function,
* calculate the static value in that function, potentially based on the dependencies, and return
* the result as module value. The same approach must be taken when the module value is supposed
* to be a function.
*
*
* Asynchronous Contract
* sap.ui.define
is designed to support real Asynchronous Module Definitions (AMD)
* in future, although it internally still uses the the old synchronous module loading of UI5.
* Callers of sap.ui.define
therefore must not rely on any synchronous behavior
* that they might observe with the current implementation.
*
* For example, callers of sap.ui.define
must not use the module value immediately
* after invoking sap.ui.define
:
*
*
* // COUNTER EXAMPLE HOW __NOT__ TO DO IT
*
* // define a class Something as AMD module
* sap.ui.define('Something', [], function() {
* var Something = function() {};
* return Something;
* });
*
* // DON'T DO THAT!
* // accessing the class _synchronously_ after sap.ui.define was called
* new Something();
*
*
* Applications that need to ensure synchronous module definition or synchronous loading of dependencies
* MUST use the old {@link jQuery.sap.declare} and {@link jQuery.sap.require} APIs.
*
*
* (No) Global References
* To be in line with AMD best practices, modules defined with sap.ui.define
* should not make any use of global variables if those variables are also available as module
* values. Instead, they should add dependencies to those modules and use the corresponding parameter
* of the factory function to access the module value.
*
* As the current programming model and the documentation of UI5 heavily rely on global names,
* there will be a transition phase where UI5 enables AMD modules and local references to module
* values in parallel to the old global names. The fourth parameter of sap.ui.define
* has been added to support that transition phase. When this parameter is set to true, the framework
* provides two additional functionalities
*
*
* - before the factory function is called, the existence of the global parent namespace for
* the current module is ensured
* - the module value will be automatically exported under a global name which is derived from
* the name of the module
*
*
* The parameter lets the framework know whether any of those two operations is needed or not.
* In future versions of UI5, a central configuration option is planned to suppress those 'exports'.
*
*
* Third Party Modules
* Although third party modules don't use UI5 APIs, they still can be listed as dependencies in
* a sap.ui.define
call. They will be requested and executed like UI5 modules, but their
* module value will be undefined
.
*
* If the currently defined module needs to access the module value of such a third party module,
* it can access the value via its global name (if the module supports such a usage).
*
* Note that UI5 temporarily deactivates an existing AMD loader while it executes third party modules
* known to support AMD. This sounds contradictorily at a first glance as UI5 wants to support AMD,
* but for now it is necessary to fully support UI5 applications that rely on global names for such modules.
*
* Example:
*
* // module 'Something' wants to use third party library 'URI.js'
* // It is packaged by UI5 as non-UI5-module 'sap/ui/thirdparty/URI'
*
* sap.ui.define('Something', ['sap/ui/thirdparty/URI'], function(URIModuleValue) {
*
* new URIModuleValue(); // fails as module value is undefined
*
* //global URI // (optional) declare usage of global name so that static code checks don't complain
* new URI(); // access to global name 'URI' works
*
* ...
* });
*
*
*
* Differences to requireJS
* The current implementation of sap.ui.define
differs from requireJS
* or other AMD loaders in several aspects:
*
* - the name
sap.ui.define
is different from the plain define
.
* This has two reasons: first, it avoids the impression that sap.ui.define
is
* an exact implementation of an AMD loader. And second, it allows the coexistence of an AMD
* loader (requireJS) and sap.ui.define
in one application as long as UI5 or
* applications using UI5 are not fully prepared to run with an AMD loader
* sap.ui.define
currently loads modules with synchronous XHR calls. This is
* basically a tribute to the synchronous history of UI5.
* BUT: synchronous dependency loading and factory execution explicitly it not part of
* contract of sap.ui.define
. To the contrary, it is already clear and planned
* that asynchronous loading will be implemented, at least as an alternative if not as the only
* implementation. Also check section Asynchronous Contract above.
* Applications that need to ensure synchronous loading of dependencies MUST use the old
* {@link jQuery.sap.require} API.
* sap.ui.define
does not support plugins to use other file types, formats or
* protocols. It is not planned to support this in future
* sap.ui.define
does not support the 'sugar' of requireJS where CommonJS
* style dependency declarations using sap.ui.require("something")
are automagically
* converted into sap.ui.define
dependencies before executing the factory function.
*
*
*
* Limitations, Design Considerations
*
* - Limitation: as dependency management is not supported for Non-UI5 modules, the only way
* to ensure proper execution order for such modules currently is to rely on the order in the
* dependency array. Obviously, this only works as long as
sap.ui.define
uses
* synchronous loading. It will be enhanced when asynchronous loading is implemented.
* - it was discussed to enforce asynchronous execution of the module factory function (e.g. with a
* timeout of 0). But this would have invalidated the current migration scenario where a
* sync
jQuery.sap.require
call can load a sap.ui.define
'ed module.
* If the module definition would not execute synchronously, the synchronous contract of the
* require call would be broken (default behavior in existing UI5 applications)
* - a single file must not contain multiple calls to
sap.ui.define
. Multiple calls
* currently are only supported in the so called 'preload' files that the UI5 merge tooling produces.
* The exact details of how this works might be changed in future implementations and are not
* yet part of the API contract
*
* @param {string[]} aDependencies - list of dependencies of the module
* @param {Function|any} vFactory - the module value or a function that calculates the value
* @param {boolean} bExport - whether an export to global names is required - should be used by SAP-owned code only
*/
function define(aDependencies: string[], vFactory: Function|any, bExport?: boolean): void;
/**
* Defines a Javascript module with its name, its dependencies and a module value or factory.
*
* The typical and only suggested usage of this method is to have one single, top level call to
* sap.ui.define
in one Javascript resource (file). When a module is requested by its
* name for the first time, the corresponding resource is determined from the name and the current
* {@link jQuery.sap.registerResourcePath configuration}. The resource will be loaded and executed
* which in turn will execute the top level sap.ui.define
call.
*
* If the module name was omitted from that call, it will be substituted by the name that was used to
* request the module. As a preparation step, the dependencies as well as their transitive dependencies,
* will be loaded. Then, the module value will be determined: if a static value (object, literal) was
* given as vFactory
, that value will be the module value. If a function was given, that
* function will be called (providing the module values of the declared dependencies as parameters
* to the function) and its return value will be used as module value. The framework internally associates
* the resulting value with the module name and provides it to the original requester of the module.
* Whenever the module is requested again, the same value will be returned (modules are executed only once).
*
* Example:
* The following example defines a module "SomeClass", but doesn't hard code the module name.
* If stored in a file 'sap/mylib/SomeClass.js', it can be requested as 'sap/mylib/SomeClass'.
*
* sap.ui.define(['./Helper', 'sap/m/Bar'], function(Helper,Bar) {
*
* // create a new class
* var SomeClass = function() {};
*
* // add methods to its prototype
* SomeClass.prototype.foo = function() {
*
* // use a function from the dependency 'Helper' in the same package (e.g. 'sap/mylib/Helper' )
* var mSettings = Helper.foo();
*
* // create and return an sap.m.Bar (using its local name 'Bar')
* return new Bar(mSettings);
*
* }
*
* // return the class as module value
* return SomeClass;
*
* });
*
*
* In another module or in an application HTML page, the {@link sap.ui.require} API can be used
* to load the Something module and to work with it:
*
*
* sap.ui.require(['sap/mylib/Something'], function(Something) {
*
* // instantiate a Something and call foo() on it
* new Something().foo();
*
* });
*
*
* Module Name Syntax
* sap.ui.define
uses a simplified variant of the {@link jQuery.sap.getResourcePath
* unified resource name} syntax for the module's own name as well as for its dependencies.
* The only difference to that syntax is, that for sap.ui.define
and
* sap.ui.require
, the extension (which always would be '.js') has to be omitted.
* Both methods always add this extension internally.
*
* As a convenience, the name of a dependency can start with the segment './' which will be
* replaced by the name of the package that contains the currently defined module (relative name).
*
* It is best practice to omit the name of the defined module (first parameter) and to use
* relative names for the dependencies whenever possible. This reduces the necessary configuration,
* simplifies renaming of packages and allows to map them to a different namespace.
*
*
* Dependency to Modules
* If a dependencies array is given, each entry represents the name of another module that
* the currently defined module depends on. All dependency modules are loaded before the value
* of the currently defined module is determined. The module value of each dependency module
* will be provided as a parameter to a factory function, the order of the parameters will match
* the order of the modules in the dependencies array.
*
* Note: the order in which the dependency modules are executed is not
* defined by the order in the dependencies array! The execution order is affected by dependencies
* between the dependency modules as well as by their current state (whether a module
* already has been loaded or not). Neither module implementations nor dependents that require
* a module set must make any assumption about the execution order (other than expressed by
* their dependencies). There is, however, one exception with regard to third party libraries,
* see the list of limitations further down below.
*
* Note:a static module value (a literal provided to sap.ui.define
) cannot
* depend on the module values of the dependency modules. Instead, modules can use a factory function,
* calculate the static value in that function, potentially based on the dependencies, and return
* the result as module value. The same approach must be taken when the module value is supposed
* to be a function.
*
*
* Asynchronous Contract
* sap.ui.define
is designed to support real Asynchronous Module Definitions (AMD)
* in future, although it internally still uses the the old synchronous module loading of UI5.
* Callers of sap.ui.define
therefore must not rely on any synchronous behavior
* that they might observe with the current implementation.
*
* For example, callers of sap.ui.define
must not use the module value immediately
* after invoking sap.ui.define
:
*
*
* // COUNTER EXAMPLE HOW __NOT__ TO DO IT
*
* // define a class Something as AMD module
* sap.ui.define('Something', [], function() {
* var Something = function() {};
* return Something;
* });
*
* // DON'T DO THAT!
* // accessing the class _synchronously_ after sap.ui.define was called
* new Something();
*
*
* Applications that need to ensure synchronous module definition or synchronous loading of dependencies
* MUST use the old {@link jQuery.sap.declare} and {@link jQuery.sap.require} APIs.
*
*
* (No) Global References
* To be in line with AMD best practices, modules defined with sap.ui.define
* should not make any use of global variables if those variables are also available as module
* values. Instead, they should add dependencies to those modules and use the corresponding parameter
* of the factory function to access the module value.
*
* As the current programming model and the documentation of UI5 heavily rely on global names,
* there will be a transition phase where UI5 enables AMD modules and local references to module
* values in parallel to the old global names. The fourth parameter of sap.ui.define
* has been added to support that transition phase. When this parameter is set to true, the framework
* provides two additional functionalities
*
*
* - before the factory function is called, the existence of the global parent namespace for
* the current module is ensured
* - the module value will be automatically exported under a global name which is derived from
* the name of the module
*
*
* The parameter lets the framework know whether any of those two operations is needed or not.
* In future versions of UI5, a central configuration option is planned to suppress those 'exports'.
*
*
* Third Party Modules
* Although third party modules don't use UI5 APIs, they still can be listed as dependencies in
* a sap.ui.define
call. They will be requested and executed like UI5 modules, but their
* module value will be undefined
.
*
* If the currently defined module needs to access the module value of such a third party module,
* it can access the value via its global name (if the module supports such a usage).
*
* Note that UI5 temporarily deactivates an existing AMD loader while it executes third party modules
* known to support AMD. This sounds contradictorily at a first glance as UI5 wants to support AMD,
* but for now it is necessary to fully support UI5 applications that rely on global names for such modules.
*
* Example:
*
* // module 'Something' wants to use third party library 'URI.js'
* // It is packaged by UI5 as non-UI5-module 'sap/ui/thirdparty/URI'
*
* sap.ui.define('Something', ['sap/ui/thirdparty/URI'], function(URIModuleValue) {
*
* new URIModuleValue(); // fails as module value is undefined
*
* //global URI // (optional) declare usage of global name so that static code checks don't complain
* new URI(); // access to global name 'URI' works
*
* ...
* });
*
*
*
* Differences to requireJS
* The current implementation of sap.ui.define
differs from requireJS
* or other AMD loaders in several aspects:
*
* - the name
sap.ui.define
is different from the plain define
.
* This has two reasons: first, it avoids the impression that sap.ui.define
is
* an exact implementation of an AMD loader. And second, it allows the coexistence of an AMD
* loader (requireJS) and sap.ui.define
in one application as long as UI5 or
* applications using UI5 are not fully prepared to run with an AMD loader
* sap.ui.define
currently loads modules with synchronous XHR calls. This is
* basically a tribute to the synchronous history of UI5.
* BUT: synchronous dependency loading and factory execution explicitly it not part of
* contract of sap.ui.define
. To the contrary, it is already clear and planned
* that asynchronous loading will be implemented, at least as an alternative if not as the only
* implementation. Also check section Asynchronous Contract above.
* Applications that need to ensure synchronous loading of dependencies MUST use the old
* {@link jQuery.sap.require} API.
* sap.ui.define
does not support plugins to use other file types, formats or
* protocols. It is not planned to support this in future
* sap.ui.define
does not support the 'sugar' of requireJS where CommonJS
* style dependency declarations using sap.ui.require("something")
are automagically
* converted into sap.ui.define
dependencies before executing the factory function.
*
*
*
* Limitations, Design Considerations
*
* - Limitation: as dependency management is not supported for Non-UI5 modules, the only way
* to ensure proper execution order for such modules currently is to rely on the order in the
* dependency array. Obviously, this only works as long as
sap.ui.define
uses
* synchronous loading. It will be enhanced when asynchronous loading is implemented.
* - it was discussed to enforce asynchronous execution of the module factory function (e.g. with a
* timeout of 0). But this would have invalidated the current migration scenario where a
* sync
jQuery.sap.require
call can load a sap.ui.define
'ed module.
* If the module definition would not execute synchronously, the synchronous contract of the
* require call would be broken (default behavior in existing UI5 applications)
* - a single file must not contain multiple calls to
sap.ui.define
. Multiple calls
* currently are only supported in the so called 'preload' files that the UI5 merge tooling produces.
* The exact details of how this works might be changed in future implementations and are not
* yet part of the API contract
*
* @param {string} sModuleName - name of the module in simplified resource name syntax. When omitted, the loader determines the name from the request.
* @param {string[]} aDependencies - list of dependencies of the module
* @param {Function|any} vFactory - the module value or a function that calculates the value
* @param {boolean} bExport - whether an export to global names is required - should be used by SAP-owned code only
*/
function define(sModuleName: string, aDependencies: string[], vFactory: Function|any, bExport?: boolean): void;
/**
* Creates 0..n UI5 controls from an ExtensionPoint.
* One control if the ExtensionPoint is e.g. filled with a View, zero for ExtensionPoints without configured extension and
* n controls for multi-root Fragments as extension.
*
* In JSViews, this function allows both JSON notation in aggregation content as well as adding an extension point to an aggregation after the target control
* has already been instantiated. In the latter case the optional parameters oTargetControls and oTargetAggregation need to be specified.
* @param {sap.ui.core.mvc.View|sap.ui.core.Fragment} oContainer - The view or fragment containing the extension point
* @param {string} sExtName - The extensionName used to identify the extension point in the customizing
* @param {() => sap.ui.core.Control[]} fnCreateDefaultContent - Optional callback function creating default content, returning an Array of controls. It is executed when there's no customizing, if not provided, no default content will be rendered.
* @param {sap.ui.core.Control} oTargetControl - Optional - use this parameter to attach the extension point to a particular aggregation
* @param {string} sAggregationName - Optional - if provided along with oTargetControl, the extension point content is added to this particular aggregation at oTargetControl, if not given, but an oTargetControl is still present, the function will attempt to add the extension point to the default aggregation of oTargetControl. If no oTargetControl is provided, sAggregationName will also be ignored.
* @returns {sap.ui.core.Control[]} an array with 0..n controls created from an ExtensionPoint
*/
function extensionpoint(oContainer: sap.ui.core.mvc.View|sap.ui.core.Fragment, sExtName: string, fnCreateDefaultContent?: () => sap.ui.core.Control[], oTargetControl?: sap.ui.core.Control, sAggregationName?: string): sap.ui.core.Control[];
/**
* Instantiate a Fragment - this method loads the Fragment content, instantiates it, and returns this content.
* The Fragment object itself is not an entity which has further significance beyond this constructor.
*
* To instantiate an existing Fragment, call this method as:
* sap.ui.fragment(sName, sType, [oController]);
* The sName must correspond to an XML Fragment which can be loaded
* via the module system (fragmentName + suffix ".fragment.[typeextension]") and which defines the Fragment content.
* If oController is given, the (event handler) methods referenced in the Fragment will be called on this controller.
* Note that Fragments may require a Controller to be given and certain methods to be available.
*
* The Fragment types "XML", "JS" and "HTML" are available by default; additional Fragment types can be implemented
* and added using the sap.ui.core.Fragment.registerType() function.
*
*
* Advanced usage:
* To instantiate a Fragment and give further configuration options, call this method as:
* sap.ui.fragment(oFragmentConfig, [oController]);
* The oFragmentConfig object can have the following properties:
* - "fragmentName": the name of the Fragment, as above
* - "fragmentContent": the definition of the Fragment content itself. When this property is given, any given name is ignored.
* The type of this property depends on the Fragment type, e.g. it could be a string for XML Fragments.
* - "type": the type of the Fragment, as above (mandatory)
* - "id": the ID of the Fragment (optional)
* Further properties may be supported by future or custom Fragment types. Any given properties
* will be forwarded to the Fragment implementation.
*
* If you want to give a fixed ID for the Fragment, please use the advanced version of this method call with the
* configuration object or use the typed factories like sap.ui.xmlfragment(...) or sap.ui.jsfragment(...).
* Otherwise the Fragment ID is generated. In any case, the Fragment ID will be used as prefix for the ID of
* all contained controls.
* @param {string} sName - the Fragment name
* @param {string} sType - the Fragment type, e.g. "XML", "JS", or "HTML"
* @param {sap.ui.core.mvc.Controller} oController - the Controller which should be used by the controls in the Fragment. Note that some Fragments may not need a Controller and other may need one - and even rely on certain methods implemented in the Controller.
* @returns {sap.ui.core.Control|sap.ui.core.Control[]} the root Control(s) of the Fragment content
*/
function fragment(sName: string, sType: string, oController?: sap.ui.core.mvc.Controller): sap.ui.core.Control|sap.ui.core.Control[];
/**
* Retrieve the {@link sap.ui.core.Core SAPUI5 Core} instance for the current window.
* @returns {sap.ui.core.Core} the API of the current SAPUI5 Core instance.
*/
function getCore(): sap.ui.core.Core;
/**
* Loads the version info file (resources/sap-ui-version.json) and returns
* it or if a library name is specified then the version info of the individual
* library will be returned.
*
* In case of the version info file is not available an error will occur when
* calling this function.
* @param {string|any} mOptions - name of the library (e.g. "sap.ui.core") or an object map (see below)
* @returns {any|any|Promise} the full version info, the library specific one, undefined (if library is not listed or there was an error and "failOnError" is set to "false") or a Promise which resolves with one of them
*/
function getVersionInfo(mOptions?: string|any): any|any|Promise;
/**
* Instantiates an HTML-based Fragment.
*
* To instantiate a Fragment, call this method as:
* sap.ui.htmlfragment([sId], sFragmentName, [oController]);
* The Fragment instance ID is optional and will be used as prefix for the ID of all
* contained controls. If no ID is passed, controls will not be prefixed.
* The sFragmentName must correspond to an HTML Fragment which can be loaded
* via the module system (fragmentName + ".fragment.html") and which defines the Fragment.
* If oController is given, the methods referenced in the Fragment will be called on this controller.
* Note that Fragments may require a Controller to be given and certain methods to be available.
*
*
* Advanced usage:
* To instantiate a Fragment and optionally directly give the HTML definition instead of loading it from a file,
* call this method as:
* sap.ui.htmlfragment(oFragmentConfig, [oController]);
* The oFragmentConfig object can either have a "fragmentName" or a "fragmentContent" property.
* fragmentContent is optional and can hold the Fragment definition as XML string; if not
* given, fragmentName must be given and the Fragment content definition is loaded by the module system.
* Again, if oController is given, the methods referenced in the Fragment will be called on this controller.
* @param {string|any} vFragment - name of the Fragment (or Fragment configuration as described above, in this case no sId may be given. Instead give the id inside the config object, if desired.)
* @param {sap.ui.core.mvc.Controller} oController - a Controller to be used for event handlers in the Fragment
* @returns {sap.ui.core.Control|sap.ui.core.Control[]} the root Control(s) of the created Fragment instance
*/
function htmlfragment(vFragment: string|any, oController?: sap.ui.core.mvc.Controller): sap.ui.core.Control|sap.ui.core.Control[];
/**
* Instantiates an HTML-based Fragment.
*
* To instantiate a Fragment, call this method as:
* sap.ui.htmlfragment([sId], sFragmentName, [oController]);
* The Fragment instance ID is optional and will be used as prefix for the ID of all
* contained controls. If no ID is passed, controls will not be prefixed.
* The sFragmentName must correspond to an HTML Fragment which can be loaded
* via the module system (fragmentName + ".fragment.html") and which defines the Fragment.
* If oController is given, the methods referenced in the Fragment will be called on this controller.
* Note that Fragments may require a Controller to be given and certain methods to be available.
*
*
* Advanced usage:
* To instantiate a Fragment and optionally directly give the HTML definition instead of loading it from a file,
* call this method as:
* sap.ui.htmlfragment(oFragmentConfig, [oController]);
* The oFragmentConfig object can either have a "fragmentName" or a "fragmentContent" property.
* fragmentContent is optional and can hold the Fragment definition as XML string; if not
* given, fragmentName must be given and the Fragment content definition is loaded by the module system.
* Again, if oController is given, the methods referenced in the Fragment will be called on this controller.
* @param {string} sId - id of the newly created Fragment
* @param {string|any} vFragment - name of the Fragment (or Fragment configuration as described above, in this case no sId may be given. Instead give the id inside the config object, if desired.)
* @param {sap.ui.core.mvc.Controller} oController - a Controller to be used for event handlers in the Fragment
* @returns {sap.ui.core.Control|sap.ui.core.Control[]} the root Control(s) of the created Fragment instance
*/
function htmlfragment(sId: string, vFragment: string|any, oController?: sap.ui.core.mvc.Controller): sap.ui.core.Control|sap.ui.core.Control[];
/**
* Defines or creates an instance of a declarative HTML view.
*
* The behavior of this method depends on the signature of the call and on the current context.
*
*
* - View Definition
sap.ui.htmlview(sId, vView)
: Defines a view of the given name with the given
* implementation. sId must be the views name, vView must be an object and can contain
* implementations for any of the hooks provided by HTMLView
* - View Instantiation
sap.ui.htmlview(sId?, vView)
: Creates an instance of the view with the given name (and id) .
*
*
* Any other call signature will lead to a runtime error. If the id is omitted in the second variant, an id will
* be created automatically.
* @param {string|any} vView - name or implementation of the view.
* @returns {sap.ui.core.mvc.HTMLView|any} the created HTMLView instance in the creation case, otherwise undefined
*/
function htmlview(vView: string|any): sap.ui.core.mvc.HTMLView|any;
/**
* Defines or creates an instance of a declarative HTML view.
*
* The behavior of this method depends on the signature of the call and on the current context.
*
*
* - View Definition
sap.ui.htmlview(sId, vView)
: Defines a view of the given name with the given
* implementation. sId must be the views name, vView must be an object and can contain
* implementations for any of the hooks provided by HTMLView
* - View Instantiation
sap.ui.htmlview(sId?, vView)
: Creates an instance of the view with the given name (and id) .
*
*
* Any other call signature will lead to a runtime error. If the id is omitted in the second variant, an id will
* be created automatically.
* @param {string} sId - id of the newly created view, only allowed for instance creation
* @param {string|any} vView - name or implementation of the view.
* @returns {sap.ui.core.mvc.HTMLView|any} the created HTMLView instance in the creation case, otherwise undefined
*/
function htmlview(sId: string, vView: string|any): sap.ui.core.mvc.HTMLView|any;
/**
* Defines OR instantiates an HTML-based Fragment.
*
* To define a JS Fragment, call this method as:
* sap.ui.jsfragment(sName, oFragmentDefinition)
* Where:
* - "sName" is the name by which this fragment can be found and instantiated. If defined in its own file,
* in order to be found by the module loading system, the file location and name must correspond to sName
* (path + file name must be: fragmentName + ".fragment.js").
* - "oFragmentDefinition" is an object at least holding the "createContent(oController)" method which defines
* the Fragment content. If given during instantiation, the createContent method receives a Controller
* instance (otherwise oController is undefined) and the return value must be one sap.ui.core.Control
* (which could have any number of children).
*
*
* To instantiate a JS Fragment, call this method as:
* sap.ui.jsfragment([sId], sFragmentName, [oController]);
* The Fragment ID is optional (generated if not given) and the Fragment implementation CAN use it
* to make contained controls unique (this depends on the implementation: some JS Fragments may choose
* not to support multiple instances within one application and not use the ID prefixing).
* The sFragmentName must correspond to a JS Fragment which can be loaded
* via the module system (fragmentName + ".fragment.js") and which defines the Fragment.
* If oController is given, the methods referenced in the Fragment will be called on this controller.
* Note that Fragments may require a Controller to be given and certain methods to be available.
* @param {string|any} sFragmentName - name of the Fragment (or Fragment configuration as described above, in this case no sId may be given. Instead give the id inside the config object, if desired)
* @param {sap.ui.core.mvc.Controller} oController - a Controller to be used for event handlers in the Fragment
* @returns {sap.ui.core.Control|sap.ui.core.Control[]} the root Control(s) of the created Fragment instance
*/
function jsfragment(sFragmentName: string|any, oController?: sap.ui.core.mvc.Controller): sap.ui.core.Control|sap.ui.core.Control[];
/**
* Defines OR instantiates an HTML-based Fragment.
*
* To define a JS Fragment, call this method as:
* sap.ui.jsfragment(sName, oFragmentDefinition)
* Where:
* - "sName" is the name by which this fragment can be found and instantiated. If defined in its own file,
* in order to be found by the module loading system, the file location and name must correspond to sName
* (path + file name must be: fragmentName + ".fragment.js").
* - "oFragmentDefinition" is an object at least holding the "createContent(oController)" method which defines
* the Fragment content. If given during instantiation, the createContent method receives a Controller
* instance (otherwise oController is undefined) and the return value must be one sap.ui.core.Control
* (which could have any number of children).
*
*
* To instantiate a JS Fragment, call this method as:
* sap.ui.jsfragment([sId], sFragmentName, [oController]);
* The Fragment ID is optional (generated if not given) and the Fragment implementation CAN use it
* to make contained controls unique (this depends on the implementation: some JS Fragments may choose
* not to support multiple instances within one application and not use the ID prefixing).
* The sFragmentName must correspond to a JS Fragment which can be loaded
* via the module system (fragmentName + ".fragment.js") and which defines the Fragment.
* If oController is given, the methods referenced in the Fragment will be called on this controller.
* Note that Fragments may require a Controller to be given and certain methods to be available.
* @param {string} sId - id of the newly created Fragment
* @param {string|any} sFragmentName - name of the Fragment (or Fragment configuration as described above, in this case no sId may be given. Instead give the id inside the config object, if desired)
* @param {sap.ui.core.mvc.Controller} oController - a Controller to be used for event handlers in the Fragment
* @returns {sap.ui.core.Control|sap.ui.core.Control[]} the root Control(s) of the created Fragment instance
*/
function jsfragment(sId: string, sFragmentName: string|any, oController?: sap.ui.core.mvc.Controller): sap.ui.core.Control|sap.ui.core.Control[];
/**
* Creates a JSON view of the given name and id.
*
* The viewName
must either correspond to a JSON module that can be loaded
* via the module system (viewName + suffix ".view.json") and which defines the view or it must
* be a configuration object for a view.
* The configuration object can have a viewName, viewContent and a controller property. The viewName
* behaves as described above, viewContent can hold the view description as JSON string or as object literal.
*
* Note: when an object literal is given, it might be modified during view construction.
*
* The controller property can hold a controller instance. If a controller instance is given,
* it overrides the controller defined in the view.
*
* Like with any other control, an id is optional and will be created when missing.
* @param {string|any} vView - name of a view resource or view configuration as described above.
* @returns {sap.ui.core.mvc.JSONView} the created JSONView instance
*/
function jsonview(vView: string|any): sap.ui.core.mvc.JSONView;
/**
* Creates a JSON view of the given name and id.
*
* The viewName
must either correspond to a JSON module that can be loaded
* via the module system (viewName + suffix ".view.json") and which defines the view or it must
* be a configuration object for a view.
* The configuration object can have a viewName, viewContent and a controller property. The viewName
* behaves as described above, viewContent can hold the view description as JSON string or as object literal.
*
* Note: when an object literal is given, it might be modified during view construction.
*
* The controller property can hold a controller instance. If a controller instance is given,
* it overrides the controller defined in the view.
*
* Like with any other control, an id is optional and will be created when missing.
* @param {string} sId - id of the newly created view
* @param {string|any} vView - name of a view resource or view configuration as described above.
* @returns {sap.ui.core.mvc.JSONView} the created JSONView instance
*/
function jsonview(sId: string, vView: string|any): sap.ui.core.mvc.JSONView;
/**
* Defines or creates an instance of a JavaScript view.
*
* The behavior of this method depends on the signature of the call and on the current context.
*
*
* - View Definition
sap.ui.jsview(sId, vView)
: Defines a view of the given name with the given
* implementation. sId must be the view's name, vView must be an object and can contain
* implementations for any of the hooks provided by JSView
*
* - View Instantiation
sap.ui.jsview(sId?, vView)
: Creates an instance of the view with the given name (and id).
* If no view implementation has been defined for that view name, a JavaScript module with the same name and with suffix "view.js" will be loaded
* and executed. The module should contain a view definition (1st. variant above).
*
*
* Any other call signature will lead to a runtime error. If the id is omitted in the second variant, an id will
* be created automatically.
* @param {string|any} vView - name or implementation of the view.
* @param {boolean} bAsync - defines how the view source is loaded and rendered later on (only relevant for instantiation, ignored for everything else)
* @returns {sap.ui.core.mvc.JSView|any} the created JSView instance in the creation case, otherwise undefined
*/
function jsview(vView: string|any, bAsync?: boolean): sap.ui.core.mvc.JSView|any;
/**
* Defines or creates an instance of a JavaScript view.
*
* The behavior of this method depends on the signature of the call and on the current context.
*
*
* - View Definition
sap.ui.jsview(sId, vView)
: Defines a view of the given name with the given
* implementation. sId must be the view's name, vView must be an object and can contain
* implementations for any of the hooks provided by JSView
*
* - View Instantiation
sap.ui.jsview(sId?, vView)
: Creates an instance of the view with the given name (and id).
* If no view implementation has been defined for that view name, a JavaScript module with the same name and with suffix "view.js" will be loaded
* and executed. The module should contain a view definition (1st. variant above).
*
*
* Any other call signature will lead to a runtime error. If the id is omitted in the second variant, an id will
* be created automatically.
* @param {string} sId - id of the newly created view, only allowed for instance creation
* @param {string|any} vView - name or implementation of the view.
* @param {boolean} bAsync - defines how the view source is loaded and rendered later on (only relevant for instantiation, ignored for everything else)
* @returns {sap.ui.core.mvc.JSView|any} the created JSView instance in the creation case, otherwise undefined
*/
function jsview(sId: string, vView: string|any, bAsync?: boolean): sap.ui.core.mvc.JSView|any;
/**
* Creates a lazy loading stub for a given class sClassName
.
*
* If the class has been loaded already, nothing is done. Otherwise a stub object
* or constructor and - optionally - a set of stub methods are created.
* All created stubs will load the corresponding module on execution
* and then delegate to their counterpart in the loaded module.
*
* When no methods are given or when the list of methods contains the special name
* "new" (which is an operator can't be used as method name in JavaScript), then a
* stub constructor for class sClassName
is created.
* Otherwise, a plain object is created.
*
* Note: Accessing any stub as a plain object without executing it (no matter
* whether it is a function or an object) won't load the module and therefore most like
* won't work as expected. This is a fundamental restriction of the lazy loader approach.
* It could only be fixed with JavaScript 1.5 features that are not available in all
* UI5 target browsers (e.g. not in IE8).
*
* Note: As a side effect of this method, the namespace containing the given
* class is created immediately.
* @param {string} sClassName - Fully qualified name (dot notation) of the class that should be prepared
* @param {string} sMethods - space separated list of additional (static) methods that should be created as stubs
* @param {string} sModuleName - name of the module to load, defaults to the class name
*/
function lazyRequire(sClassName: string, sMethods?: string, sModuleName?: string): void;
/**
* Redirects access to resources that are part of the given namespace to a location
* relative to the assumed application root folder.
*
* Any UI5 managed resource (view, controller, control, JavaScript module, CSS file, etc.)
* whose resource name starts with sNamespace
, will be loaded from an
* equally named subfolder of the application root folder.
* If the resource name consists of multiple segments (separated by a dot), each segment
* is assumed to represent an individual folder. In other words: when a resource name is
* converted to a URL, any dots ('.') are converted to slashes ('/').
*
* Limitation: For the time being, the application root folder is assumed to be
* the same as the folder where the current page resides in.
*
* Usage sample:
*
* // Let UI5 know that resources, whose name starts with "com.mycompany.myapp"
* // should be loaded from the URL location "./com/mycompany/myapp"
* sap.ui.localResources("com.mycompany.myapp");
*
* // The following call implicitly will use the mapping done by the previous line
* // It will load a view from ./com/mycompany/myapp/views/Main.view.xml
* sap.ui.view({ view : "com.mycompany.myapp.views.Main", type : sap.ui.core.mvc.ViewType.XML});
*
*
* When applications need a more flexible mapping between resource names and their location,
* they can use {@link jQuery.sap.registerModulePath}.
*
* It is intended to make this configuration obsolete in future releases, but for the time
* being, applications must call this method when they want to store resources relative to
* the assumed application root folder.
* @param {string} sNamespace - Namespace prefix for which to load resources relative to the application root folder
*/
function localResources(sNamespace: string): void;
/**
* Ensures that a given a namespace or hierarchy of nested namespaces exists in the
* current window
.
* @param {string} sNamespace
* @returns {any} the innermost namespace of the hierarchy
*/
function namespace(sNamespace: string): any;
/**
* Resolves one or more module dependencies.
*
* Synchronous Retrieval of a Single Module Value
*
* When called with a single string, that string is assumed to be the name of an already loaded
* module and the value of that module is returned. If the module has not been loaded yet,
* or if it is a Non-UI5 module (e.g. third party module), undefined
is returned.
* This signature variant allows synchronous access to module values without initiating module loading.
*
* Sample:
*
* var JSONModel = sap.ui.require("sap/ui/model/json/JSONModel");
*
*
* For modules that are known to be UI5 modules, this signature variant can be used to check whether
* the module has been loaded.
*
* Asynchronous Loading of Multiple Modules
*
* If an array of strings is given and (optionally) a callback function, then the strings
* are interpreted as module names and the corresponding modules (and their transitive
* dependencies) are loaded. Then the callback function will be called asynchronously.
* The module values of the specified modules will be provided as parameters to the callback
* function in the same order in which they appeared in the dependencies array.
*
* The return value for the asynchronous use case is undefined
.
*
*
* sap.ui.require(['sap/ui/model/json/JSONModel', 'sap/ui/core/UIComponent'], function(JSONModel,UIComponent) {
*
* var MyComponent = UIComponent.extend('MyComponent', {
* ...
* });
* ...
*
* });
*
*
* This method uses the same variation of the {@link jQuery.sap.getResourcePath unified resource name}
* syntax that {@link sap.ui.define} uses: module names are specified without the implicit extension '.js'.
* Relative module names are not supported.
* @param {string|string[]} vDependencies - dependency (dependencies) to resolve
* @param {Function} fnCallback - callback function to execute after resolving an array of dependencies
* @returns {any|any} a single module value or undefined
*/
function require(vDependencies: string|string[], fnCallback?: Function): any|any;
/**
* Returns the URL of a resource that belongs to the given library and has the given relative location within the library.
* This is mainly meant for static resources like images that are inside the library.
* It is NOT meant for access to JavaScript modules or anything for which a different URL has been registered with jQuery.sap.registerModulePath(). For
* these cases use jQuery.sap.getModulePath().
* It DOES work, however, when the given sResourcePath starts with "themes/" (= when it is a theme-dependent resource). Even when for this theme a different
* location outside the normal library location is configured.
* @param {string} sLibraryName - the name of a library, like "sap.ui.commons"
* @param {string} sResourcePath - the relative path of a resource inside this library, like "img/mypic.png" or "themes/my_theme/img/mypic.png"
* @returns {string} the URL of the requested resource
*/
function resource(sLibraryName: string, sResourcePath: string): string;
/**
* Displays the control tree with the given root inside the area of the given
* DOM reference (or inside the DOM node with the given ID) or in the given Control.
*
* Example:
*
* <div id="SAPUI5UiArea"></div>
* <script>
* var oRoot = new sap.ui.commons.Label();
* oRoot.setText("Hello world!");
* sap.ui.setRoot("SAPUI5UiArea", oRoot);
* </script>
*
*
*
* This is a shortcut for sap.ui.getCore().setRoot()
.
*
* Internally, if a string is given that does not identify a UIArea or a control
* then implicitly a new UIArea
is created for the given DOM reference
* and the given control is added.
* @param {string|Element|sap.ui.core.Control} oDomRef - a DOM Element or Id String of the UIArea
* @param {sap.ui.base.Interface|sap.ui.core.Control} oControl - the Control that should be added to the UIArea
.
*/
function setRoot(oDomRef: string|Element|sap.ui.core.Control, oControl: sap.ui.base.Interface|sap.ui.core.Control): void;
/**
* Creates a Template for the given ID, DOM reference or a configuration object.
*
* If no parameter is defined, this function makes a lookup of DOM elements
* which are specifying a type attribute. If the value of this type attribute
* matches a registered type then the content of this DOM element will be
* used to create a new Template
instance.
*
* If you want to lookup all kind of existing and known templates and parse them
* directly you can simply call:
*
* sap.ui.template();
*
*
* To parse a concrete DOM element you can do so by using this function in the
* following way:
*
* sap.ui.template("theTemplateId");
*
*
* Or you can pass the reference to a DOM element and use this DOM element as
* a source for the template:
*
* sap.ui.template(oDomRef);
*
*
* The last option to use this function is to pass the information via a
* configuration object. This configuration object can be used to pass a
* context for the templating framework when compiling the template:
*
* var oTemplateById = sap.ui.template({
* id: "theTemplateId",
* context: { ... }
* });
*
* var oTemplateByDomRef = sap.ui.template({
* domref: oDomRef,
* context: { ... }
* });
*
*
* It can also be used to load a template from another file:
*
* var oTemplate = sap.ui.template({
* id: "myTemplate",
* src: "myTemplate.tmpl"
* });
*
* var oTemplateWithContext = sap.ui.template({
* id: "myTemplate",
* src: "myTemplate.tmpl",
* context: { ... }
* });
*
* @param {string|HTMLElement|any} oTemplate - the ID or the DOM reference to the template to lookup or a configuration object containing the src, type and eventually the ID of the Template.
* @returns {sap.ui.core.tmpl.Template|sap.ui.core.tmpl.Template[]} the created Template instance or in case of usage without parameters any array of templates is returned
*/
function template(oTemplate?: string|HTMLElement|any): sap.ui.core.tmpl.Template|sap.ui.core.tmpl.Template[];
/**
* Defines or creates an instance of a template view.
*
* The behavior of this method depends on the signature of the call and on the current context.
*
*
* - View Definition
sap.ui.templateview(sId, vView)
: Defines a view of the given name with the given
* implementation. sId must be the views name, vView must be an object and can contain
* implementations for any of the hooks provided by templateview
* - View Instantiation
sap.ui.templateview(sId?, vView)
: Creates an instance of the view with the given name (and id) .
*
*
* Any other call signature will lead to a runtime error. If the id is omitted in the second variant, an id will
* be created automatically.
* @param {string|any} vView - name or implementation of the view.
* @returns {sap.ui.core.mvc.TemplateView|any} the created TemplateView instance in the creation case, otherwise undefined
*/
function templateview(vView: string|any): sap.ui.core.mvc.TemplateView|any;
/**
* Defines or creates an instance of a template view.
*
* The behavior of this method depends on the signature of the call and on the current context.
*
*
* - View Definition
sap.ui.templateview(sId, vView)
: Defines a view of the given name with the given
* implementation. sId must be the views name, vView must be an object and can contain
* implementations for any of the hooks provided by templateview
* - View Instantiation
sap.ui.templateview(sId?, vView)
: Creates an instance of the view with the given name (and id) .
*
*
* Any other call signature will lead to a runtime error. If the id is omitted in the second variant, an id will
* be created automatically.
* @param {string} sId - id of the newly created view, only allowed for instance creation
* @param {string|any} vView - name or implementation of the view.
* @returns {sap.ui.core.mvc.TemplateView|any} the created TemplateView instance in the creation case, otherwise undefined
*/
function templateview(sId: string, vView: string|any): sap.ui.core.mvc.TemplateView|any;
/**
* Creates a view of the given type, name and with the given id.
*
* The vView
configuration object can have the following properties for the view
* instantiation:
*
* - The ID
vView.id
specifies an ID for the View instance. If no ID is given,
* an ID will be generated.
* - The view name
vView.viewName
corresponds to an XML module that can be loaded
* via the module system (vView.viewName + suffix ".view.xml")
* - The controller instance
vView.controller
must be a valid controller implementation.
* The given controller instance overrides the controller defined in the view definition
* - The view type
vView.type
specifies what kind of view will be instantiated. All valid
* view types are listed in the enumeration sap.ui.core.mvc.ViewType.
* - The view data
vView.viewData
can hold user specific data. This data is available
* during the whole lifecycle of the view and the controller
* - The view loading mode
vView.async
must be a boolean and defines if the view source is loaded
* synchronously or asynchronously. In async mode, the view is rendered empty initially, and re-rendered with the
* loaded view content.
* vView.preprocessors
can hold a map from the specified preprocessor type (e.g. "xml") to an array of
* preprocessor configurations; each configuration consists of a preprocessor
property (optional when
* registered as on-demand preprocessor) and may contain further preprocessor-specific settings. The preprocessor can
* be either a module name as string implementation of {@link sap.ui.core.mvc.View.Preprocessor} or a function according to
* {@link sap.ui.core.mvc.View.Preprocessor.process}. Do not set properties starting with underscore like _sProperty
* property, these are reserved for internal purposes. When several preprocessors are provided for one hook, it has to be made
* sure that they do not conflict when being processed serially.
*
* Note: These preprocessors are only available to this instance. For global or
* on-demand availability use {@link sap.ui.core.mvc.XMLView.registerPreprocessor}.
*
* Note: Please note that preprocessors in general are currently only available
* to XMLViews.
*
* Note: Preprocessors only work in async views and will be ignored when the view is instantiated
* in sync mode by default, as this could have unexpected side effects. You may override this behaviour by setting the
* bSyncSupport flag of the preprocessor to true.
* @param {string} sId - id of the newly created view, only allowed for instance creation
* @param {string|any} vView - the view name or view configuration object
* @returns {sap.ui.core.mvc.View} the created View instance
*/
function view(sId: string, vView?: string|any): sap.ui.core.mvc.View;
/**
* Instantiates an XML-based Fragment.
*
* To instantiate a Fragment, call this method as:
* sap.ui.xmlfragment([sId], sFragmentName, [oController]);
* The Fragment instance ID is optional and will be used as prefix for the ID of all
* contained controls. If no ID is passed, controls will not be prefixed.
* The sFragmentName must correspond to an XML Fragment which can be loaded
* via the module system (fragmentName + ".fragment.xml") and which defines the Fragment.
* If oController is given, the methods referenced in the Fragment will be called on this controller.
* Note that Fragments may require a Controller to be given and certain methods to be available.
*
*
* Advanced usage:
* To instantiate a Fragment and optionally directly give the XML definition instead of loading it from a file,
* call this method as:
* sap.ui.xmlfragment(oFragmentConfig, [oController]);
* The oFragmentConfig object can either have a "fragmentName" or a "fragmentContent" property.
* fragmentContent is optional and can hold the Fragment definition as XML string; if not
* given, fragmentName must be given and the Fragment content definition is loaded by the module system.
* Again, if oController is given, the methods referenced in the Fragment will be called on this controller.
* @param {string|any} vFragment - name of the Fragment (or Fragment configuration as described above, in this case no sId may be given. Instead give the id inside the config object, if desired)
* @param {sap.ui.core.mvc.Controller} oController - a Controller to be used for event handlers in the Fragment
* @returns {sap.ui.core.Control|sap.ui.core.Control[]} the root Control(s) of the created Fragment instance
*/
function xmlfragment(vFragment: string|any, oController?: sap.ui.core.mvc.Controller): sap.ui.core.Control|sap.ui.core.Control[];
/**
* Instantiates an XML-based Fragment.
*
* To instantiate a Fragment, call this method as:
* sap.ui.xmlfragment([sId], sFragmentName, [oController]);
* The Fragment instance ID is optional and will be used as prefix for the ID of all
* contained controls. If no ID is passed, controls will not be prefixed.
* The sFragmentName must correspond to an XML Fragment which can be loaded
* via the module system (fragmentName + ".fragment.xml") and which defines the Fragment.
* If oController is given, the methods referenced in the Fragment will be called on this controller.
* Note that Fragments may require a Controller to be given and certain methods to be available.
*
*
* Advanced usage:
* To instantiate a Fragment and optionally directly give the XML definition instead of loading it from a file,
* call this method as:
* sap.ui.xmlfragment(oFragmentConfig, [oController]);
* The oFragmentConfig object can either have a "fragmentName" or a "fragmentContent" property.
* fragmentContent is optional and can hold the Fragment definition as XML string; if not
* given, fragmentName must be given and the Fragment content definition is loaded by the module system.
* Again, if oController is given, the methods referenced in the Fragment will be called on this controller.
* @param {string} sId - id of the newly created Fragment
* @param {string|any} vFragment - name of the Fragment (or Fragment configuration as described above, in this case no sId may be given. Instead give the id inside the config object, if desired)
* @param {sap.ui.core.mvc.Controller} oController - a Controller to be used for event handlers in the Fragment
* @returns {sap.ui.core.Control|sap.ui.core.Control[]} the root Control(s) of the created Fragment instance
*/
function xmlfragment(sId: string, vFragment: string|any, oController?: sap.ui.core.mvc.Controller): sap.ui.core.Control|sap.ui.core.Control[];
/**
* Instantiates an XMLView of the given name and with the given ID.
*
* The viewName
must either correspond to an XML module that can be loaded
* via the module system (viewName + suffix ".view.xml") and which defines the view, or it must
* be a configuration object for a view.
* The configuration object can have a viewName
, viewContent
and a controller
*
property. The viewName
behaves as described above. viewContent
is optional
* and can hold a view description as XML string or as already parsed XML Document. If not given, the view content
* definition is loaded by the module system.
*
* Note: if a Document
is given, it might be modified during view construction.
*
* Note:
* On root level, you can only define content for the default aggregation, e.g. without adding the <content>
tag. If
* you want to specify content for another aggregation of a view like dependents
, place it in a child
* control's dependents aggregation or add it by using {@link sap.ui.core.mvc.XMLView#addDependent}.
*
* Note: if you enable caching, you need to take care of the invalidation via keys. Automatic
* invalidation takes only place if the UI5 version or the component descriptor (manifest.json) change. This is
* still an experimental feature and may experience slight changes of the invalidation parameters or the cache
* key format.
*
* The controller property can hold a controller instance. If a controller instance is given,
* it overrides the controller defined in the view.
*
* Like with any other control, ID is optional and one will be created automatically.
* @param {string|any} vView - Name of the view or a view configuration object as described above
* @returns {sap.ui.core.mvc.XMLView} the created XMLView instance
*/
function xmlview(vView: string|any): sap.ui.core.mvc.XMLView;
/**
* Instantiates an XMLView of the given name and with the given ID.
*
* The viewName
must either correspond to an XML module that can be loaded
* via the module system (viewName + suffix ".view.xml") and which defines the view, or it must
* be a configuration object for a view.
* The configuration object can have a viewName
, viewContent
and a controller
*
property. The viewName
behaves as described above. viewContent
is optional
* and can hold a view description as XML string or as already parsed XML Document. If not given, the view content
* definition is loaded by the module system.
*
* Note: if a Document
is given, it might be modified during view construction.
*
* Note:
* On root level, you can only define content for the default aggregation, e.g. without adding the <content>
tag. If
* you want to specify content for another aggregation of a view like dependents
, place it in a child
* control's dependents aggregation or add it by using {@link sap.ui.core.mvc.XMLView#addDependent}.
*
* Note: if you enable caching, you need to take care of the invalidation via keys. Automatic
* invalidation takes only place if the UI5 version or the component descriptor (manifest.json) change. This is
* still an experimental feature and may experience slight changes of the invalidation parameters or the cache
* key format.
*
* The controller property can hold a controller instance. If a controller instance is given,
* it overrides the controller defined in the view.
*
* Like with any other control, ID is optional and one will be created automatically.
* @param {string} sId - ID of the newly created view
* @param {string|any} vView - Name of the view or a view configuration object as described above
* @returns {sap.ui.core.mvc.XMLView} the created XMLView instance
*/
function xmlview(sId: string, vView: string|any): sap.ui.core.mvc.XMLView;
/**
*/
namespace app {
/**
* Base class for application classes
*/
export class Application extends sap.ui.core.Component {
/**
* Abstract application class. Extend this class to create a central application class.
*
* Only one instance is allowed.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - optional id for the application; generated automatically if no non-empty id is given Note: this can be omitted, no matter whether mSettings
will be given or not!
* @param {any} mSettings - optional map/JSON-object with initial settings for the new application instance
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates and returns the root component. Override this method in your application implementation, if you want to override the default creation by metadata.
* @returns {sap.ui.core.UIComponent} the root component
*/
protected createRootComponent(): sap.ui.core.UIComponent;
/**
*/
public destroy(): void;
/**
* Destroys the rootComponent in the aggregation {@link #getRootComponent rootComponent}.
* @returns {sap.ui.app.Application} Reference to this
in order to allow method chaining
*/
public destroyRootComponent(): sap.ui.app.Application;
/**
* Creates a new subclass of class sap.ui.app.Application with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Component.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getConfig config}.
* @returns {any} Value of property config
*/
public getConfig(): any;
/**
* Returns a metadata object for class sap.ui.app.Application.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRoot root}.
* @returns {string} Value of property root
*/
public getRoot(): string;
/**
* Gets content of aggregation {@link #getRootComponent rootComponent}.
* @returns {sap.ui.core.UIComponent}
*/
public getRootComponent(): sap.ui.core.UIComponent;
/**
* Returns the application root component.
* @returns {sap.ui.core.Control} The root component
*/
public getView(): sap.ui.core.Control;
/**
* The main method is called when the DOM and UI5 is completely loaded. Override this method in your Application class implementation to execute code which relies on a loaded DOM / UI5.
*/
public main(): void;
/**
* On before exit application hook. Override this method in your Application class implementation, to handle cleanup before the real exit or to prompt a question to the user,
* if the application should be exited.
* @returns {string} return a string if a prompt should be displayed to the user confirming closing the application (e.g. when the application is not yet saved).
*/
public onBeforeExit(): string;
/**
* On error hook. Override this method in your Application class implementation to listen to unhandled errors.
* @param {string} sMessage - The error message.
* @param {string} sFile - The file where the error occurred
* @param {number} iLine - The line number of the error
*/
public onError(sMessage: string, sFile: string, iLine: number): void;
/**
* On exit application hook. Override this method in your Application class implementation, to handle cleanup of the application.
*/
public onExit(): void;
/**
* Sets the configuration model.
* @param {string|any|sap.ui.model.Model} vConfig - the configuration model, the configuration object or a URI string to load a JSON configuration file.
*/
public setConfig(vConfig: string|any|sap.ui.model.Model): void;
/**
* Sets a new value for property {@link #getRoot root}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sRoot - New value for property root
* @returns {sap.ui.app.Application} Reference to this
in order to allow method chaining
*/
public setRoot(sRoot: string): sap.ui.app.Application;
/**
* Sets the aggregated {@link #getRootComponent rootComponent}.
* @param {sap.ui.core.UIComponent} oRootComponent - The rootComponent to set
* @returns {sap.ui.app.Application} Reference to this
in order to allow method chaining
*/
public setRootComponent(oRootComponent: sap.ui.core.UIComponent): sap.ui.app.Application;
}
/**
* Class to mock a server
*/
export class MockServer extends sap.ui.base.ManagedObject {
/**
* Creates a mocked server. This helps to mock all or some backend calls, e.g. for OData/JSON Models or simple XHR calls, without
* changing the application code. This class can also be used for qunit tests.
* @param {string} sId - id for the new server object; generated automatically if no non-empty id is given Note: this can be omitted, no matter whether mSettings
will be given or not!
* @param {any} mSettings - optional map/JSON-object with initial property values, aggregated objects etc. for the new object
* @param {any} oScope - scope object for resolving string based type and formatter references in bindings
*/
public constructor(sId?: string, mSettings?: any, oScope?: any);
}
}
/**
* SAPUI5 base classes
*/
namespace base {
/**
* An Event object consisting of an id, a source and a map of parameters
*/
export class Event extends sap.ui.base.Object {
/**
* Creates an event with the given sId
, linked to the provided oSource
and enriched with the mParameters
.
* @param {string} sId - The id of the event
* @param {sap.ui.base.EventProvider} oSource - The source of the event
* @param {any} mParameters - A map of parameters for this event
*/
public constructor(sId: string, oSource: sap.ui.base.EventProvider, mParameters: any);
/**
* Cancel bubbling of the event.
*
* Note: This function only has an effect if the bubbling of the event is supported by the event source.
*/
public cancelBubble(): void;
/**
* Creates a new subclass of class sap.ui.base.Event with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the id of the event.
* @returns {string} The id of the event
*/
public getId(): string;
/**
* Returns a metadata object for class sap.ui.base.Event.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the value of the parameter with the given sName.
* @param {string} sName - The name of the parameter to return
* @returns {any} The value for the named parameter
*/
public getParameter(sName: string): any;
/**
* Returns all parameter values of the event keyed by their names.
* @returns {{ [key: string]: any }} All parameters of the event keyed by name
*/
public getParameters(): { [key: string]: any };
/**
* Returns the event provider on which the event was fired.
* @returns {sap.ui.base.EventProvider} The source of the event
*/
public getSource(): sap.ui.base.EventProvider;
/**
* Prevent the default action of this event.
*
* Note: This function only has an effect if preventing the default action of the event is supported by the event source.
*/
public preventDefault(): void;
}
/**
* Provides eventing capabilities for objects like attaching or detaching event handlers for events which are notified when events are fired.
*/
export class EventProvider extends sap.ui.base.Object {
/**
* Creates an instance of EventProvider.
*/
public constructor();
/**
* Attaches an event handler to the event with the given identifier.
* @param {string} sEventId - The identifier of the event to listen for
* @param {Function} fnFunction - The handler function to call when the event occurs. This function will be called in the context of the oListener
instance (if present) or on the event provider instance. The event object ({@link sap.ui.base.Event}) is provided as first argument of the handler. Handlers must not change the content of the event. The second argument is the specified oData
instance (if present).
* @param {any} oListener - The object that wants to be notified when the event occurs (this
context within the handler function). If it is not specified, the handler function is called in the context of the event provider.
* @returns {sap.ui.base.EventProvider} Returns this
to allow method chaining
*/
public attachEvent(sEventId: string, fnFunction: Function, oListener?: any): sap.ui.base.EventProvider;
/**
* Attaches an event handler to the event with the given identifier.
* @param {string} sEventId - The identifier of the event to listen for
* @param {any} oData - An object that will be passed to the handler along with the event object when the event is fired
* @param {Function} fnFunction - The handler function to call when the event occurs. This function will be called in the context of the oListener
instance (if present) or on the event provider instance. The event object ({@link sap.ui.base.Event}) is provided as first argument of the handler. Handlers must not change the content of the event. The second argument is the specified oData
instance (if present).
* @param {any} oListener - The object that wants to be notified when the event occurs (this
context within the handler function). If it is not specified, the handler function is called in the context of the event provider.
* @returns {sap.ui.base.EventProvider} Returns this
to allow method chaining
*/
public attachEvent(sEventId: string, oData: any, fnFunction: Function, oListener?: any): sap.ui.base.EventProvider;
/**
* Attaches an event handler, called one time only, to the event with the given identifier.
*
* When the event occurs, the handler function is called and the handler registration is automatically removed afterwards.
* @param {string} sEventId - The identifier of the event to listen for
* @param {Function} fnFunction - The handler function to call when the event occurs. This function will be called in the context of the oListener
instance (if present) or on the event provider instance. The event object ({@link sap.ui.base.Event}) is provided as first argument of the handler. Handlers must not change the content of the event. The second argument is the specified oData
instance (if present).
* @param {any} oListener - The object that wants to be notified when the event occurs (this
context within the handler function). If it is not specified, the handler function is called in the context of the event provider.
* @returns {sap.ui.base.EventProvider} Returns this
to allow method chaining
*/
public attachEventOnce(sEventId: string, fnFunction: Function, oListener?: any): sap.ui.base.EventProvider;
/**
* Attaches an event handler, called one time only, to the event with the given identifier.
*
* When the event occurs, the handler function is called and the handler registration is automatically removed afterwards.
* @param {string} sEventId - The identifier of the event to listen for
* @param {any} oData - An object that will be passed to the handler along with the event object when the event is fired
* @param {Function} fnFunction - The handler function to call when the event occurs. This function will be called in the context of the oListener
instance (if present) or on the event provider instance. The event object ({@link sap.ui.base.Event}) is provided as first argument of the handler. Handlers must not change the content of the event. The second argument is the specified oData
instance (if present).
* @param {any} oListener - The object that wants to be notified when the event occurs (this
context within the handler function). If it is not specified, the handler function is called in the context of the event provider.
* @returns {sap.ui.base.EventProvider} Returns this
to allow method chaining
*/
public attachEventOnce(sEventId: string, oData: any, fnFunction: Function, oListener?: any): sap.ui.base.EventProvider;
/**
* Cleans up the internal structures and removes all event handlers.
*
* The object must not be used anymore after destroy was called.
*/
public destroy(): void;
/**
* Removes a previously attached event handler from the event with the given identifier.
*
* The passed parameters must match those used for registration with {@link #attachEvent} beforehand.
* @param {string} sEventId - The identifier of the event to detach from
* @param {Function} fnFunction - The handler function to detach from the event
* @param {any} oListener - The object that wanted to be notified when the event occurred
* @returns {sap.ui.base.EventProvider} Returns this
to allow method chaining
*/
public detachEvent(sEventId: string, fnFunction: Function, oListener?: any): sap.ui.base.EventProvider;
/**
* Creates a new subclass of class sap.ui.base.EventProvider with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires an {@link sap.ui.base.Event event} with the given settings and notifies all attached event handlers.
* @param {string} sEventId - The identifier of the event to fire
* @param {any} mParameters - The parameters which should be carried by the event
* @param {boolean} bAllowPreventDefault - Defines whether function preventDefault
is supported on the fired event
* @param {boolean} bEnableEventBubbling - Defines whether event bubbling is enabled on the fired event. Set to true
the event is also forwarded to the parent(s) of the event provider ({@link #getEventingParent}) until the bubbling of the event is stopped or no parent is available anymore.
* @returns {sap.ui.base.EventProvider|boolean} Returns this
to allow method chaining. When preventDefault
is supported on the fired event the function returns true
if the default action should be executed, false
otherwise.
*/
protected fireEvent(sEventId: string, mParameters?: any, bAllowPreventDefault?: boolean, bEnableEventBubbling?: boolean): sap.ui.base.EventProvider|boolean;
/**
* Returns the parent in the eventing hierarchy of this object.
*
* Per default this returns null, but if eventing is used in objects, which are hierarchically
* structured, this can be overwritten to make the object hierarchy visible to the eventing and
* enables the use of event bubbling within this object hierarchy.
* @returns {sap.ui.base.EventProvider} The parent event provider
*/
protected getEventingParent(): sap.ui.base.EventProvider;
/**
* Returns a metadata object for class sap.ui.base.EventProvider.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns whether there are any registered event handlers for the event with the given identifier.
* @param {string} sEventId - The identifier of the event
* @returns {boolean} Whether there are any registered event handlers
*/
protected hasListeners(sEventId: string): boolean;
/**
* Returns a string representation of this object.
*
* In case there is no class or id information, a simple static string is returned.
* Subclasses should override this method.
* @returns {string} A string description of this event provider
*/
public toString(): string;
}
/**
* A class that creates an Interface for an existing class. If a class returns the interface in its constructor,
* only the defined functions will be visible, no internals of the class can be accessed.
*/
export class Interface {
/**
* Constructs an instance of sap.ui.base.Interface which restricts access to methods marked as public.
* @param {sap.ui.base.Object} oObject - the instance that needs an interface created
* @param {string[]} aMethods - the names of the methods, that should be available on this interface
*/
public constructor(oObject: sap.ui.base.Object, aMethods: string[]);
}
/**
* Base Class that introduces some basic concepts like state management or databinding.
*
* New subclasses of ManagedObject are created with a call to {@link #.extend ManagedObject.extend} and can make use
* of the following managed features:
*
* Properties
* Managed properties represent the state of a ManagedObject. They can store a single value of a simple data type
* (like 'string' or 'int'). They have a name (e.g. 'size') and methods to get the current value (getSize
)
* or to set a new value (setSize
). When a property is modified, the ManagedObject is marked as invalidated.
* A managed property can be bound against a property in a {@link sap.ui.model.Model} by using the {@link #bindProperty} method.
* Updates to the model property will be automatically reflected in the managed property and - if TwoWay databinding is active,
* changes to the managed property will be reflected in the model. An existing binding can be removed by calling {@link #unbindProperty}.
*
* If a ManagedObject is cloned, the clone will have the same values for its managed properties as the source of the
* clone - if the property wasn't bound. If it is bound, the property in the clone will be bound to the same
* model property as in the source.
*
* Details about the declaration of a managed property, the metadata that describes it and the set of methods that are automatically
* generated to access it, can be found in the documentation of the {@link sap.ui.base.ManagedObject.extend extend } method.
*
*
* Aggregations
* Managed aggregations can store one or more references to other ManagedObjects. They are a mean to control the lifecycle
* of the aggregated objects: one ManagedObject can be aggregated by at most one parent ManagedObject at any time.
* When a ManagedObject is destroyed, all aggregated objects are destroyed as well and the object itself is removed from
* its parent. That is, aggregations won't contain destroyed objects or null/undefined.
*
* Aggregations have a name ('e.g 'header' or 'items'), a cardinality ('0..1' or '0..n') and are of a specific
* type (which must be a subclass of ManagedObject as well or a UI5 interface). A ManagedObject will provide methods to
* set or get the aggregated object for a specific aggregation of cardinality 0..1 (e.g. setHeader
, getHeader
* for an aggregation named 'header'). For an aggregation of cardinality 0..n, there are methods to get all aggregated objects
* (getItems
), to locate an object in the aggregation (e.g. indexOfItem
), to add, insert or remove
* a single aggregated object (addItem
, insertItem
, removeItem
) or to remove or destroy
* all objects from an aggregation (removeAllItems
, destroyItems
).
*
* Details about the declaration of a managed aggregation, the metadata that describes it and the set of methods that are automatically
* generated to access it, can be found in the documentation of the {@link sap.ui.base.ManagedObject.extend extend} method.
*
* Aggregations of cardinality 0..n can be bound to a collection in a model by using {@link #bindAggregation} (and unbound again
* using {@link #unbindAggregation}). For each context in the model collection, a corresponding object will be created in the
* managed aggregation, either by cloning a template object or by calling a factory function.
*
* Aggregations also control the databinding context of bound objects: by default, aggregated objects inherit all models
* and binding contexts from their parent object.
*
* When a ManagedObject is cloned, all aggregated objects will be cloned as well - but only if they haven't been added by
* databinding. In that case, the aggregation in the clone will be bound to the same model collection.
*
*
* Associations
* Managed associations also form a relationship between objects, but they don't define a lifecycle for the
* associated objects. They even can 'break' in the sense that an associated object might have been destroyed already
* although it is still referenced in an association. For the same reason, the internal storage for associations
* are not direct object references but only the IDs of the associated target objects.
*
* Associations have a name ('e.g 'initialFocus'), a cardinality ('0..1' or '0..n') and are of a specific type
* (which must be a subclass of ManagedObject as well or a UI5 interface). A ManagedObject will provide methods to set or get
* the associated object for a specific association of cardinality 0..1 (e.g. setInitialFocus
, getInitialFocus
).
* For an association of cardinality 0..n, there are methods to get all associated objects (getRefItems
),
* to add, insert or remove a single associated object (addRefItem
,
* insertRefItem
, removeRefItem
) or to remove all objects from an association
* (removeAllRefItems
).
*
* Details about the declaration of a managed association, the metadata that describes it and the set of methods that are automatically
* generated to access it, can be found in the documentation of the {@link sap.ui.base.ManagedObject.extend extend} method.
*
* Associations can't be bound to the model.
*
* When a ManagedObject is cloned, the result for an association depends on the relationship between the associated target
* object and the root of the clone operation: if the associated object is part of the to-be-cloned object tree (reachable
* via aggregations from the root of the clone operation), then the cloned association will reference the clone of the
* associated object. Otherwise it will reference the same object as in the original tree.
* When a ManagedObject is destroyed, other objects that are only associated, are not affected by the destroy operation.
*
*
* Events
* Managed events provide a mean for communicating important state changes to an arbitrary number of 'interested' listeners.
* Events have a name and (optionally) a set of parameters. For each event there will be methods to add or remove an event
* listener as well as a method to fire the event. (e.g. attachChange
, detachChange
, fireChange
* for an event named 'change').
*
* Details about the declaration of a managed events, the metadata that describes it and the set of methods that are automatically
* generated to access it, can be found in the documentation of the {@link sap.ui.base.ManagedObject.extend extend} method.
*
* When a ManagedObject is cloned, all listeners registered for any event in the clone source are also registered to the
* clone. Later changes are not reflected in any direction (neither from source to clone nor vice versa).
*
*
* Low Level APIs:
* The prototype of ManagedObject provides several generic, low level APIs to manage properties, aggregations, associations
* and events. These generic methods are solely intended for implementing higher level, non-generic methods that manage
* a single managed property etc. (e.g. a function setSize(value)
that sets a new value for property 'size').
* {@link sap.ui.base.ManagedObject.extend} creates default implementations of those higher level APIs for all managed aspects.
* The implementation of a subclass then can override those default implementations with a more specific implementation,
* e.g. to implement a side effect when a specific property is set or retrieved.
* It is therefore important to understand that the generic low-level methods ARE NOT SUITABLE FOR GENERIC ACCESS to the
* state of a managed object, as that would bypass the overriding higher level methods and their side effects.
*/
export class ManagedObject extends sap.ui.base.EventProvider {
/**
* Constructs and initializes a managed object with the given sId
and settings.
*
* If the optional mSettings
are given, they must be a simple object
* that defines values for properties, aggregations, associations or events keyed by their name.
*
* Valid Names and Value Ranges:
*
* The property (key) names supported in the object literal are exactly the (case sensitive)
* names documented in the JSDoc for the properties, aggregations, associations and events
* of the current class and its base classes. Note that for 0..n aggregations and associations this
* name usually is the plural name, whereas it is the singular name in case of 0..1 relations.
*
* If a key name is ambiguous for a specific managed object class (e.g. a property has the same
* name as an event), then this method prefers property, aggregation, association and
* event in that order. To resolve such ambiguities, the keys can be prefixed with
* aggregation:
, association:
or event:
* (such keys containing a colon (':') must be quoted to be valid Javascript).
*
* The possible values for a setting depend on its kind:
*
* - for simple properties, the value has to match the documented type of the property (no type conversion occurs)
*
- for 0..1 aggregations, the value has to be an instance of the aggregated type
*
- for 0..n aggregations, the value has to be an array of instances of the aggregated type or a single instance
*
- for 0..1 associations, an instance of the associated type or an id (string) is accepted
*
- for 0..n associations, an array of instances of the associated type or of IDs is accepted
*
- for events either a function (event handler) is accepted or an array of length 2
* where the first element is a function and the 2nd element is an object to invoke the method on.
*
*
* Each subclass should document the name and type of its supported settings in its constructor documentation.
*
* Besides the settings documented below, ManagedObject itself supports the following special settings:
*
* id : sap.ui.core.ID
an ID for the new instance. Some subclasses (Element, Component) require the id
* to be unique in a specific scope (e.g. an Element Id must be unique across all Elements, a Component id must
* be unique across all Components).
* models : object
a map of {@link sap.ui.model.Model} instances keyed by their model name (alias).
* Each entry with key k in this object has the same effect as a call this.setModel(models[k], k);
.
* bindingContexts : object
a map of {@link sap.ui.model.Context} instances keyed by their model name.
* Each entry with key k in this object has the same effect as a call this.setBindingContext(bindingContexts[k], k);
* objectBindings : object
a map of binding paths keyed by the corresponding model name.
* Each entry with key k in this object has the same effect as a call this.bindObject(objectBindings[k], k);
* metadataContexts : object
a map of binding paths keyed by the corresponding model name.
*
* @param {string} sId - id for the new managed object; generated automatically if no non-empty id is given Note: this can be omitted, no matter whether mSettings
will be given or not!
* @param {any} mSettings - Optional map/JSON-object with initial property values, aggregated objects etc. for the new object
* @param {any} oScope - Scope object for resolving string based type and formatter references in bindings. When a scope object is given, mSettings
cannot be omitted, at least null
or an empty object literal must be given.
*/
public constructor(sId?: string, mSettings?: any, oScope?: any);
/**
* Hook method to let descendants of ManagedObject know when propagated contextual settings have changed
*/
protected _onContextualSettingsChanged(): void;
/**
* Adds some entity oObject
to the aggregation identified by sAggregationName
.
*
* If the given object is not valid with regard to the aggregation (if it is not an instance
* of the type specified for that aggregation) or when the method is called for an aggregation
* of cardinality 0..1, then an Error is thrown (see {@link #validateAggregation}.
*
* If the aggregation already has content, the new object will be added after the current content.
* If the new object was already contained in the aggregation, it will be moved to the end.
*
* Note: This method is a low-level API as described in the class documentation.
* Applications or frameworks must not use this method to generically add an object to an aggregation.
* Use the concrete method addXYZ for aggregation 'XYZ' or the generic {@link #applySettings} instead.
* @param {string} sAggregationName - the string identifying the aggregation that oObject
should be added to.
* @param {sap.ui.base.ManagedObject} oObject - the object to add; if empty, nothing is added
* @param {boolean} bSuppressInvalidate - if true, this ManagedObject as well as the added child are not marked as changed
* @returns {sap.ui.base.ManagedObject} Returns this
to allow method chaining
*/
protected addAggregation(sAggregationName: string, oObject: sap.ui.base.ManagedObject, bSuppressInvalidate?: boolean): sap.ui.base.ManagedObject;
/**
* Adds some object with the ID sId
to the association identified by sAssociationName
and
* marks this ManagedObject as changed.
*
* This method does not avoid duplicates.
*
* Note: This method is a low-level API as described in the class documentation.
* Applications or frameworks must not use this method to generically add an object to an association.
* Use the concrete method addXYZ for association 'XYZ' or the generic {@link #applySettings} instead.
* @param {string} sAssociationName - the string identifying the association the object should be added to.
* @param {string|sap.ui.base.ManagedObject} sId - the ID of the ManagedObject object to add; if empty, nothing is added; if a sap.ui.base.ManagedObject
is given, its ID is added
* @param {boolean} bSuppressInvalidate - if true, this managed object as well as the newly associated object are not marked as changed
* @returns {sap.ui.base.ManagedObject} Returns this
to allow method chaining
*/
protected addAssociation(sAssociationName: string, sId: string|sap.ui.base.ManagedObject, bSuppressInvalidate?: boolean): sap.ui.base.ManagedObject;
/**
* Adds a listener function that will be called during each propagation step on every control
* @param {Function} listener - function
* @returns {sap.ui.base.ManagedObject} Returns this
to allow method chaining
*/
protected addPropagationListener(listener: Function): sap.ui.base.ManagedObject;
/**
* Sets all the properties, aggregations, associations and event handlers as given in
* the object literal mSettings
. If a property, aggregation, etc.
* is not listed in mSettings
, then its value is not changed by this method.
*
* For properties and 0..1 aggregations/associations, any given setting overwrites
* the current value. For 0..n aggregations, the given values are appended; event
* listeners are registered in addition to existing ones.
*
* For the possible keys and values in mSettings
see the general
* documentation in {@link sap.ui.base.ManagedObject} or the specific documentation
* of the constructor of the concrete managed object class.
* @param {any} mSettings - the settings to apply to this managed object
* @param {any} oScope - Scope object to resolve types and formatters
* @returns {sap.ui.base.ManagedObject} Returns this
to allow method chaining
*/
public applySettings(mSettings: any, oScope?: any): sap.ui.base.ManagedObject;
/**
* Attaches event handler fnFunction
to the {@link #event:formatError formatError} event of this sap.ui.base.ManagedObject
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.base.ManagedObject
itself.
*
* Fired when a new value for a bound property should have been propagated from the model,
* but formatting the value failed with an exception.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.base.ManagedObject
itself
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
public attachFormatError(fnFunction: Function, oListener?: any): sap.ui.base.ManagedObject;
/**
* Attaches event handler fnFunction
to the {@link #event:formatError formatError} event of this sap.ui.base.ManagedObject
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.base.ManagedObject
itself.
*
* Fired when a new value for a bound property should have been propagated from the model,
* but formatting the value failed with an exception.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.base.ManagedObject
itself
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
public attachFormatError(oData: any, fnFunction: Function, oListener?: any): sap.ui.base.ManagedObject;
/**
* Attaches event handler fnFunction
to the {@link #event:modelContextChange modelContextChange} event of this sap.ui.base.ManagedObject
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.base.ManagedObject
itself.
*
* Fired when models or contexts are changed on this object (either by calling setModel/setBindingContext or due to propagation)
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.base.ManagedObject
itself
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
public attachModelContextChange(fnFunction: Function, oListener?: any): sap.ui.base.ManagedObject;
/**
* Attaches event handler fnFunction
to the {@link #event:modelContextChange modelContextChange} event of this sap.ui.base.ManagedObject
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.base.ManagedObject
itself.
*
* Fired when models or contexts are changed on this object (either by calling setModel/setBindingContext or due to propagation)
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.base.ManagedObject
itself
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
public attachModelContextChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.base.ManagedObject;
/**
* Attaches event handler fnFunction
to the {@link #event:parseError parseError} event of this sap.ui.base.ManagedObject
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.base.ManagedObject
itself.
*
* Fired when a new value for a bound property should have been propagated to the model,
* but parsing the value failed with an exception.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.base.ManagedObject
itself
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
public attachParseError(fnFunction: Function, oListener?: any): sap.ui.base.ManagedObject;
/**
* Attaches event handler fnFunction
to the {@link #event:parseError parseError} event of this sap.ui.base.ManagedObject
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.base.ManagedObject
itself.
*
* Fired when a new value for a bound property should have been propagated to the model,
* but parsing the value failed with an exception.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.base.ManagedObject
itself
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
public attachParseError(oData: any, fnFunction: Function, oListener?: any): sap.ui.base.ManagedObject;
/**
* Attaches event handler fnFunction
to the {@link #event:validationError validationError} event of this sap.ui.base.ManagedObject
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.base.ManagedObject
itself.
*
* Fired when a new value for a bound property should have been propagated to the model,
* but validating the value failed with an exception.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.base.ManagedObject
itself
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
public attachValidationError(fnFunction: Function, oListener?: any): sap.ui.base.ManagedObject;
/**
* Attaches event handler fnFunction
to the {@link #event:validationError validationError} event of this sap.ui.base.ManagedObject
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.base.ManagedObject
itself.
*
* Fired when a new value for a bound property should have been propagated to the model,
* but validating the value failed with an exception.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.base.ManagedObject
itself
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
public attachValidationError(oData: any, fnFunction: Function, oListener?: any): sap.ui.base.ManagedObject;
/**
* Attaches event handler fnFunction
to the {@link #event:validationSuccess validationSuccess} event of this sap.ui.base.ManagedObject
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.base.ManagedObject
itself.
*
* Fired after a new value for a bound property has been propagated to the model.
* Only fired, when the binding uses a data type.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.base.ManagedObject
itself
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
public attachValidationSuccess(fnFunction: Function, oListener?: any): sap.ui.base.ManagedObject;
/**
* Attaches event handler fnFunction
to the {@link #event:validationSuccess validationSuccess} event of this sap.ui.base.ManagedObject
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.base.ManagedObject
itself.
*
* Fired after a new value for a bound property has been propagated to the model.
* Only fired, when the binding uses a data type.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.base.ManagedObject
itself
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
public attachValidationSuccess(oData: any, fnFunction: Function, oListener?: any): sap.ui.base.ManagedObject;
/**
* Bind an aggregation to the model.
*
* The bound aggregation will use the given template, clone it for each item
* which exists in the bound list and set the appropriate binding context.
* This is a generic method which can be used to bind any aggregation to the
* model. A managed object may flag aggregations in the metamodel with
* bindable="bindable" to get typed bindSomething methods for those aggregations.
* @param {string} sName - the aggregation to bind
* @param {any} oBindingInfo - the binding info
* @returns {sap.ui.base.ManagedObject} reference to the instance itself
*/
public bindAggregation(sName: string, oBindingInfo: any): sap.ui.base.ManagedObject;
/**
* Bind the object to the referenced entity in the model, which is used as the binding context
* to resolve bound properties or aggregations of the object itself and all of its children
* relatively to the given path.
* @param {string} sPath - the binding path
* @returns {sap.ui.base.ManagedObject} reference to the instance itself
*/
public bindContext(sPath: string): sap.ui.base.ManagedObject;
/**
* Bind the object to the referenced entity in the model, which is used as the binding context
* to resolve bound properties or aggregations of the object itself and all of its children
* relatively to the given path.
* If a relative binding path is used, this will be applied whenever the parent context changes.
* There is no difference between {@link sap.ui.core.Element#bindElement} and {@link sap.ui.base.ManagedObject#bindObject}.
* @param {string|any} vPath - the binding path or an object with more detailed binding options
* @param {any} mParameters - map of additional parameters for this binding (only taken into account when vPath is a string in that case the properties described for vPath above are valid here). The supported parameters are listed in the corresponding model-specific implementation of sap.ui.model.ContextBinding
.
* @returns {sap.ui.base.ManagedObject} reference to the instance itself
*/
public bindObject(vPath: string|any, mParameters?: any): sap.ui.base.ManagedObject;
/**
* Binds a property to the model.
*
* The Setter for the given property will be called with the value retrieved from the data model.
* When the binding mode is OneTime
, the property will be set only once. When it is
* OneWay
, the property will be updated whenever the corresponding data in the model changes.
* In mode TwoWay
, changes to the property (not originating in the model) will be
* reported back to the model (typical use case: user interaction changes the value of a control).
*
* This is a generic method which can be used to bind any property to the model. A managed
* object may flag any property in its metadata with bindable="bindable"
to additionally
* provide named methods to bind and unbind the corresponding property.
*
*
* Composite Binding
* A composite property binding which combines data from multiple model paths can be declared using
* the parts
parameter instead of path
. The formatter
function
* or a {@link sap.ui.model.CompositeType composite type} then can be used to combine the parts,
* Properties with a composite binding are also known as "calculated fields".
*
* Example:
*
* oTxt.bindValue({
* parts: [
* {path: "/firstName", type: "sap.ui.model.type.String"},
* {path: "myModel2>/lastName"}
* ]
* });
*
*
* Note that a composite binding will be forced into mode OneWay
when one of the
* binding parts is not in mode TwoWay
.
*
*
* Formatter Functions
* When a formatter function is specified for the binding or for a binding part, it will be
* called with the value of the bound model property. After setting the initial property value,
* the formatter function will only be called again when the bound model property changes
* (simple property binding) or when at least one of the bound model properties changes
* (formatter function of a composite binding). Note that a binding only monitors the
* bound model data for changes. Dependencies of the formatter implementation to other model
* data is not known to the binding and changes won't be detected.
*
* When the formatter for a property binding (simple or composite) is called, the managed object
* will be given as this
context. For formatters of binding parts in a composite
* binding, this is not the case.
* @param {string} sName - Name of the property to bind
* @param {any} oBindingInfo - Binding information
* @returns {sap.ui.base.ManagedObject} reference to the instance itself
*/
public bindProperty(sName: string, oBindingInfo: any): sap.ui.base.ManagedObject;
/**
* Clones a tree of objects starting with the object on which clone is called first (root object).
*
* The IDs within the newly created clone tree are derived from the original IDs by appending
* the given sIdSuffix
(if no suffix is given, one will be created; it will be
* unique across multiple clone calls).
*
* The oOptions
configuration object can have the following properties:
*
* - The boolean value
cloneChildren
specifies whether associations/aggregations will be cloned
* - The boolean value
cloneBindings
specifies if bindings will be cloned
*
*
* For each cloned object the following settings are cloned based on the metadata of the object and the defined options:
*
* - all properties that are not bound. If
cloneBinding
is false
,
* even these properties will be cloned; the values are used by reference, they are not cloned
* - all aggregated objects that are not bound. If
cloneBinding
is false
,
* even the ones that are bound will be cloned; they are all cloned recursively using the same
* sIdSuffix
* - all associated controls; when an association points to an object inside the cloned object tree,
* then the cloned association will be modified to that it points to the clone of the target object.
* When the association points to a managed object outside of the cloned object tree, then its
* target won't be changed.
* - all models set via
setModel()
; used by reference
* - all property and aggregation bindings (if
cloneBindings
is true
);
* the pure binding information (path, model name) is cloned, but all other information like
* template control or factory function, data type or formatter function are copied by reference.
* The bindings themselves are created anew as they are specific for the combination (object, property, model).
* As a result, any later changes to a binding of the original object are not reflected
* in the clone, but changes to e.g the type or template etc. are.
*
*
* Each clone is created by first collecting the above mentioned settings and then creating
* a new instance with the normal constructor function. As a result, any side effects of
* mutator methods (setProperty
etc.) or init hooks are repeated during clone creation.
* There is no need to override clone()
just to reproduce these internal settings!
*
* Custom controls however can override clone()
to implement additional clone steps.
* They usually will first call clone()
on the super class and then modify the
* returned clone accordingly.
*
* Applications must never provide the second parameter aLocaleIds
.
* It is determined automatically for the root object (and its non-existence also serves as
* an indicator for the root object). Specifying it will break the implementation of clone()
.
* @param {string} sIdSuffix - a suffix to be appended to the cloned object ID
* @param {string[]} aLocalIds - an array of local IDs within the cloned hierarchy (internally used)
* @param {Object} oOptions - configuration object
* @param {boolean} cloneChildren - Whether associations and aggregations will be cloned
* @param {boolean} cloneBindings - Whether bindings will be cloned
* @returns {sap.ui.base.ManagedObject} Reference to the newly created clone
*/
protected clone(sIdSuffix?: string, aLocalIds?: string[], oOptions?: Object, cloneChildren?: boolean, cloneBindings?: boolean): sap.ui.base.ManagedObject;
/**
* Creates a new ManagedObject from the given data.
*
* If vData
is a managed object already, that object is returned.
* If vData
is an object (literal), then a new object is created with vData
* as settings. The type of the object is either determined by a property of name Type
* (capital 'T') in the vData
or by a property type
(lower case 't')
* in the oKeyInfo
object. In both cases, the type can be specified by name (dot separated
* name of the class) or by the constructor function of the class.
* @param {sap.ui.base.ManagedObject|any} vData
- the data to create the object from
* @param {any} oKeyInfo
* @param {any} oScope - Scope object to resolve types and formatters in bindings
*/
public static create(vData: sap.ui.base.ManagedObject|any, oKeyInfo?: any, oScope?: any): void;
/**
* Cleans up the resources associated with this object and all its aggregated children.
*
* After an object has been destroyed, it can no longer be used in!
*
* Applications should call this method if they don't need the object any longer.
* @param {boolean} bSuppressInvalidate - if true, this ManagedObject is not marked as changed
*/
public destroy(bSuppressInvalidate?: boolean): void;
/**
* Destroys (all) the managed object(s) in the aggregation named sAggregationName
and empties the
* aggregation. If the aggregation did contain any object, this ManagedObject is marked as changed.
*
* Note: This method is a low-level API as described in the class documentation.
* Applications or frameworks must not use this method to generically destroy all objects in an aggregation.
* Use the concrete method destroyXYZ for aggregation 'XYZ' instead.
* @param {string} sAggregationName - the name of the aggregation
* @param {boolean} bSuppressInvalidate - if true, this ManagedObject is not marked as changed
* @returns {sap.ui.base.ManagedObject} Returns this
to allow method chaining
*/
protected destroyAggregation(sAggregationName: string, bSuppressInvalidate?: boolean): sap.ui.base.ManagedObject;
/**
* Detaches event handler fnFunction
from the {@link #event:formatError formatError} event of this sap.ui.base.ManagedObject
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
public detachFormatError(fnFunction: Function, oListener: any): sap.ui.base.ManagedObject;
/**
* Detaches event handler fnFunction
from the {@link #event:modelContextChange modelContextChange} event of this sap.ui.base.ManagedObject
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
public detachModelContextChange(fnFunction: Function, oListener: any): sap.ui.base.ManagedObject;
/**
* Detaches event handler fnFunction
from the {@link #event:parseError parseError} event of this sap.ui.base.ManagedObject
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
public detachParseError(fnFunction: Function, oListener: any): sap.ui.base.ManagedObject;
/**
* Detaches event handler fnFunction
from the {@link #event:validationError validationError} event of this sap.ui.base.ManagedObject
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
public detachValidationError(fnFunction: Function, oListener: any): sap.ui.base.ManagedObject;
/**
* Detaches event handler fnFunction
from the {@link #event:validationSuccess validationSuccess} event of this sap.ui.base.ManagedObject
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
public detachValidationSuccess(fnFunction: Function, oListener: any): sap.ui.base.ManagedObject;
/**
* Defines a new subclass of ManagedObject with name sClassName
and enriches it with
* the information contained in oClassInfo
.
*
* oClassInfo
can contain the same information that {@link sap.ui.base.Object.extend} already accepts,
* plus the following new properties in the 'metadata' object literal:
*
*
* library : string
* properties : object
* defaultProperty : string
* aggregations : object
* defaultAggregation : string
* associations : object
* events : object
* specialSettings : object
// this one is still experimental and not for public usage!
*
*
* Each of these properties is explained in more detail lateron.
*
* Example:
*
* ManagedObect.extend('sap.mylib.MyClass', {
* metadata : {
* library: 'sap.mylib',
* properties : {
* value: 'string',
* width: 'sap.ui.core.CSSSize',
* height: { type: 'sap.ui.core.CSSSize', defaultValue: '100%' }
* },
* defaultProperty : 'value',
* aggregations : {
* header : { type: 'sap.mylib.FancyHeader', multiple : false }
* items : 'sap.ui.core.Control'
* },
* defaultAggregation : 'items',
* associations : {
* initiallyFocused : { type: 'sap.ui.core.Control' }
* },
* events: {
* beforeOpen : {
* parameters : {
* opener : 'sap.ui.core.Control'
* }
* }
* },
* },
*
* init: function() {
* }
*
* }); // end of 'extend' call
*
*
* Detailed explanation of properties
*
*
* 'library' : string
* Name of the library that the new subclass should belong to. If the subclass is a control or element, it will
* automatically register with that library so that authoring tools can discover it.
* By convention, the name of the subclass should have the library name as a prefix, e.g. 'sap.ui.commons.Panel' belongs
* to library 'sap.ui.commons'.
*
*
* 'properties' : object
* An object literal whose properties each define a new managed property in the ManagedObject subclass.
* The value can either be a simple string which then will be assumed to be the type of the new property or it can be
* an object literal with the following properties
*
* type: string
type of the new property. Must either be one of the built-in types 'string', 'boolean', 'int', 'float', 'object' or 'any', or a
* type created and registered with {@link sap.ui.base.DataType.createType} or an array type based on one of the previous types.
* group:string
a semantic grouping of the properties, intended to be used in design time tools.
* Allowed values are (case sensitive): Accessibility, Appearance, Behavior, Data, Designtime, Dimension, Identification, Misc
* defaultValue: any
the default value for the property or null if there is no defaultValue.
* bindable: boolean|string
(either can be omitted or set to the boolean value true
or the magic string 'bindable')
* If set to true
or 'bindable', additional named methods bindName
and unbindName
are generated as convenience.
* Despite its name, setting this flag is not mandatory to make the managed property bindable. The generic methods {@link #bindProperty} and
* {@link #unbindProperty} can always be used.
*
* Property names should use camelCase notation, start with a lowercase letter and only use characters from the set [a-zA-Z0-9_$].
* If an aggregation in the literal is preceded by a JSDoc comment (doclet) and if the UI5 plugin and template are used for JSDoc3 generation, the doclet will
* be used as generic documentation of the aggregation.
*
* For each public property 'foo', the following methods will be created by the "extend" method and will be added to the
* prototype of the subclass:
*
* - getFoo() - returns the current value of property 'foo'. Internally calls {@link #getProperty}
*
- setFoo(v) - sets 'v' as the new value of property 'foo'. Internally calls {@link #setProperty}
*
- bindFoo(c) - (only if property was defined to be 'bindable'): convenience function that wraps {@link #bindProperty}
*
- unbindFoo() - (only if property was defined to be 'bindable'): convenience function that wraps {@link #unbindProperty}
*
*
*
* 'defaultProperty' : string
* When specified, the default property must match the name of one of the properties defined for the new subclass (either own or inherited).
* The named property can be used to identify the main property to be used for bound data. E.g. the value property of a field control.
*
*
* 'aggregations' : object
* An object literal whose properties each define a new aggregation in the ManagedObject subclass.
* The value can either be a simple string which then will be assumed to be the type of the new aggregation or it can be
* an object literal with the following properties
*
* type: string
type of the new aggregation. must be the full global name of a ManagedObject subclass (in dot notation, e.g. 'sap.m.Button')
* [multiple]: boolean
whether the aggregation is a 0..1 (false) or a 0..n aggregation (true), defaults to true
* [singularName]: string
. Singular name for 0..n aggregations. For 0..n aggregations the name by convention should be the plural name.
* Methods affecting multiple objects in an aggregation will use the plural name (e.g. getItems(), whereas methods that deal with a single object will use
* the singular name (e.g. addItem). The framework knows a set of common rules for building plural form of English nouns and uses these rules to determine
* a singular name on its own. if that name is wrong, a singluarName can be specified with this property.
* - [visibility]: string
either 'hidden' or 'public', defaults to 'public'. Aggregations that belong to the API of a class must be 'public' whereas
* 'hidden' aggregations typically are used for the implementation of composite classes (e.g. composite controls)
* bindable: boolean|string
(either can be omitted or set to the boolean value true
or the magic string 'bindable')
* If set to true
or 'bindable', additional named methods bindName
and unbindName
are generated as convenience.
* Despite its name, setting this flag is not mandatory to make the managed aggregation bindable. The generic methods {@link #bindAggregation} and
* {@link #unbindAggregation} can always be used.
*
* Aggregation names should use camelCase notation, start with a lowercase letter and only use characters from the set [a-zA-Z0-9_$].
* The name for a hidden aggregations might start with an underscore.
* If an aggregation in the literal is preceded by a JSDoc comment (doclet) and if the UI5 plugin and template are used for JSDoc3 generation, the doclet will
* be used as generic documentation of the aggregation.
*
* For each public aggregation 'item' of cardinality 0..1, the following methods will be created by the "extend" method and will be added to the
* prototype of the subclass:
*
* - getItem() - returns the current value of aggregation 'item'. Internally calls {@link #getAggregation} with a default value of
undefined
* - setItem(o) - sets 'o' as the new aggregated object in aggregation 'item'. Internally calls {@link #setAggregation}
* - destroyItem(o) - destroy a currently aggregated object in aggregation 'item' and clears the aggregation. Internally calls {@link #destroyAggregation}
* - bindItem(c) - (only if aggregation was defined to be 'bindable'): convenience function that wraps {@link #bindAggregation}
* - unbindItem() - (only if aggregation was defined to be 'bindable'): convenience function that wraps {@link #unbindAggregation}
*
* For a public aggregation 'items' of cardinality 0..n, the following methods will be created:
*
* - getItems() - returns an array with the objects contained in aggregation 'items'. Internally calls {@link #getAggregation} with a default value of
[]
* - addItem(o) - adds an object as last element in the aggregation 'items'. Internally calls {@link #addAggregation}
* - insertItem(o,p) - inserts an object into the aggregation 'items'. Internally calls {@link #insertAggregation}
* - removeItem(v) - removes an object from the aggregation 'items'. Internally calls {@link #removeAggregation}
* - removeItems() - removes all object from the aggregation 'items'. Internally calls {@link #removeAllAggregation}
* - destroyItems() - destroy all currently aggregated objects in aggregation 'items' and clears the aggregation. Internally calls {@link #destroyAggregation}
* - bindItems(c) - (only if aggregation was defined to be 'bindable'): convenience function that wraps {@link #bindAggregation}
* - unbindItems() - (only if aggregation was defined to be 'bindable'): convenience function that wraps {@link #unbindAggregation}
*
* For private or hidden aggregations, no methods are generated.
*
*
* 'defaultAggregation' : string
* When specified, the default aggregation must match the name of one of the aggregations defined for the new subclass (either own or inherited).
* The named aggregation will be used in contexts where no aggregation is specified. E,g. when an object in an XMLView embeds other objects without
* naming an aggregation, as in the following example:
*
* <!-- assuming the defaultAggregation for Dialog is 'content' -->
* <Dialog>
* <Text/>
* <Button/>
* </Dialog>
*
*
*
* 'associations' : object
* An object literal whose properties each define a new association of the ManagedObject subclass.
* The value can either be a simple string which then will be assumed to be the type of the new association or it can be
* an object literal with the following properties
*
* type: string
type of the new association
* multiple: boolean
whether the association is a 0..1 (false) or a 0..n association (true), defaults to false(1) for associations
* [singularName]: string
. Singular name for 0..n associations. For 0..n associations the name by convention should be the plural name.
* Methods affecting multiple objects in an association will use the plural name (e.g. getItems(), whereas methods that deal with a single object will use
* the singular name (e.g. addItem). The framework knows a set of common rules for building plural form of English nouns and uses these rules to determine
* a singular name on its own. if that name is wrong, a singluarName can be specified with this property.
*
* Association names should use camelCase notation, start with a lowercase letter and only use characters from the set [a-zA-Z0-9_$].
* If an association in the literal is preceded by a JSDoc comment (doclet) and if the UI5 plugin and template are used for JSDoc3 generation, the doclet will
* be used as generic documentation of the association.
*
* For each association 'ref' of cardinality 0..1, the following methods will be created by the "extend" method and will be added to the
* prototype of the subclass:
*
* - getRef() - returns the current value of association 'item'. Internally calls {@link #getAssociation} with a default value of
undefined
* - setRef(o) - sets 'o' as the new associated object in association 'item'. Internally calls {@link #setAssociation}
*
* For a public association 'refs' of cardinality 0..n, the following methods will be created:
*
* - getRefs() - returns an array with the objects contained in association 'items'. Internally calls {@link #getAssociation} with a default value of
[]
* - addRef(o) - adds an object as last element in the association 'items'. Internally calls {@link #addAssociation}
* - removeRef(v) - removes an object from the association 'items'. Internally calls {@link #removeAssociation}
* - removeAllRefs() - removes all objects from the association 'items'. Internally calls {@link #removeAllAssociation}
*
*
*
* 'events' : object
* An object literal whose properties each define a new event of the ManagedObject subclass.
* The value can either be a simple string which then will be assumed to be the type of the new association or it can be
* an object literal with the following properties
*
* allowPreventDefault: boolean
whether the event allows to prevented the default behavior of the event source
* parameters: object
an object literal that describes the parameters of this event.
*
* Event names should use camelCase notation, start with a lowercase letter and only use characters from the set [a-zA-Z0-9_$].
* If an event in the literal is preceded by a JSDoc comment (doclet) and if the UI5 plugin and template are used for JSDoc3 generation, the doclet will be used
* as generic documentation of the event.
*
* For each event 'Some' the following methods will be created by the "extend" method and will be added to the
* prototype of the subclass:
*
* - attachSome(fn,o) - registers a listener for the event. Internally calls {@link #attachEvent}
* - detachSome(fn,o) - deregisters a listener for the event. Internally calls {@link #detachEvent}
* - fireSome() - fire the event. Internally calls {@link #fireEvent}
*
*
*
* 'specialSettings' : object
* Special settings are an experimental feature and MUST NOT BE USED by controls or applications outside of the sap.ui.core project.
* @param {string} sClassName - name of the class to be created
* @param {any} oClassInfo - object literal with informations about the class
* @param {Function} FNMetaImpl - constructor function for the metadata object. If not given, it defaults to sap.ui.base.ManagedObjectMetadata
.
* @returns {Function} the created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Searches and returns all aggregated objects that pass the given check function.
*
* When the search is done recursively (bRecursive === true
), it will be
* executed depth-first and ancestors will be added to the result array before their descendants.
*
* If no check function is given, all aggregated objects will pass the check and be added
* to the result array.
*
* Take care: this operation might be expensive.
* @param {boolean} bRecursive - Whether the whole aggregation tree should be searched
* @param {boolean} fnCondition - Objects for which this function returns a falsy value will not be added to the result array
* @returns {sap.ui.base.ManagedObject[]} Array of aggregated objects that passed the check
*/
public findAggregatedObjects(bRecursive: boolean, fnCondition?: boolean): sap.ui.base.ManagedObject[];
/**
* Fires event {@link #event:formatError formatError} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
protected fireFormatError(mParameters?: any): sap.ui.base.ManagedObject;
/**
* Fires event {@link #event:modelContextChange modelContextChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
protected fireModelContextChange(mParameters?: any): sap.ui.base.ManagedObject;
/**
* Fires event {@link #event:parseError parseError} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
protected fireParseError(mParameters?: any): sap.ui.base.ManagedObject;
/**
* Fires event {@link #event:validationError validationError} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
protected fireValidationError(mParameters?: any): sap.ui.base.ManagedObject;
/**
* Fires event {@link #event:validationSuccess validationSuccess} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.base.ManagedObject} Reference to this
in order to allow method chaining
*/
protected fireValidationSuccess(mParameters?: any): sap.ui.base.ManagedObject;
/**
* Returns the aggregated object(s) for the named aggregation of this ManagedObject.
*
* If the aggregation does not contain any objects(s), the given oDefaultForCreation
* (or null
) is set as new value of the aggregation and returned to the caller.
*
* Note: the need to specify a default value and the fact that it is stored as
* new value of a so far empty aggregation is recognized as a shortcoming of this API
* but can no longer be changed for compatibility reasons.
*
* Note: This method is a low-level API as described in the class documentation.
* Applications or frameworks must not use this method to generically read the content of an aggregation.
* Use the concrete method getXYZ for aggregation 'XYZ' instead.
* @param {string} sAggregationName - the name of the aggregation
* @param {sap.ui.base.ManagedObject|any[]} oDefaultForCreation - the object that is used in case the current aggregation is empty
* @returns {sap.ui.base.ManagedObject|any[]} the aggregation array in case of 0..n-aggregations or the managed object or null in case of 0..1-aggregations
*/
protected getAggregation(sAggregationName: string, oDefaultForCreation: sap.ui.base.ManagedObject|any[]): sap.ui.base.ManagedObject|any[];
/**
* Returns the content of the association with the given name.
*
* For associations of cardinality 0..1, a single string with the ID of an associated
* object is returned (if any). For cardinality 0..n, an array with the IDs of the
* associated objects is returned.
*
* If the association does not contain any objects(s), the given oDefaultForCreation
* is set as new value of the association and returned to the caller. The only supported values for
* oDefaultForCreation
are null
and undefined
in the case of
* cardinality 0..1 and null
, undefined
or an empty array ([]
)
* in case of cardinality 0..n. If the argument is omitted, null
is used independently
* from the cardinality.
*
* Note: the need to specify a default value and the fact that it is stored as
* new value of a so far empty association is recognized as a shortcoming of this API
* but can no longer be changed for compatibility reasons.
*
* Note: This method is a low-level API as described in the class documentation.
* Applications or frameworks must not use this method to generically retrieve the content of an association.
* Use the concrete method getXYZ for association 'XYZ' instead.
* @param {string} sAssociationName - the name of the association
* @param {any} oDefaultForCreation - the object that is used in case the current aggregation is empty (only null or empty array allowed)
* @returns {string|string[]} the ID of the associated managed object or an array of such IDs; may be null if the association has not been populated
*/
protected getAssociation(sAssociationName: string, oDefaultForCreation: any): string|string[];
/**
* Get the binding object for a specific aggregation/property
* @param {string} sName - the name of the property or aggregation
* @returns {sap.ui.model.Binding} the binding for the given name
*/
public getBinding(sName: string): sap.ui.model.Binding;
/**
* Get the binding context of this object for the given model name.
*
* If the object does not have a binding context set on itself and has no own model set,
* it will use the first binding context defined in its parent hierarchy.
*
* Note: to be compatible with future versions of this API, applications must not use the value null
,
* the empty string ""
or the string literals "null"
or "undefined"
as model name.
*
* Note: A ManagedObject inherits binding contexts from the Core only when it is a descendant of a UIArea.
* @param {string} sModelName - the name of the model or undefined
* @returns {sap.ui.model.Context} The binding context of this object
*/
public getBindingContext(sModelName?: string): sap.ui.model.Context;
/**
* Returns the binding infos for the given property or aggregation. The binding info contains information about path, binding object, format options,
* sorter, filter etc. for the property or aggregation. As the binding object is only created when the model becomes available, the binding property may be
* undefined.
* @param {string} sName - the name of the property or aggregation
* @returns {any} the binding info object, containing at least a path or parts property and, depending on the binding type, additional properties
*/
protected getBindingInfo(sName: string): any;
/**
* Get the binding path for a specific aggregation/property
* @param {string} sName - the name of the property or aggregation
* @returns {string} the binding path for the given name
*/
protected getBindingPath(sName: string): string;
/**
* Returns the parent managed object as new eventing parent to enable control event bubbling
* or null
if this object hasn't been added to a parent yet.
* @returns {sap.ui.base.EventProvider} the parent event provider
*/
protected getEventingParent(): sap.ui.base.EventProvider;
/**
* Returns the object's Id.
* @returns {string} the objects's Id.
*/
public getId(): string;
/**
* Returns the metadata for the class that this object belongs to.
* @returns {sap.ui.base.Metadata} Metadata for the class of the object
*/
public getMetadata(): sap.ui.base.Metadata;
/**
* Returns the metadata for the ManagedObject class.
* @returns {sap.ui.base.Metadata} Metadata for the ManagedObject class.
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Get the model to be used for data bindings with the given model name.
* If the object does not have a model set on itself, it will use the first
* model defined in its parent hierarchy.
*
* The name can be omitted to reference the default model or it must be a non-empty string.
*
* Note: to be compatible with future versions of this API, applications must not use the value null
,
* the empty string ""
or the string literals "null"
or "undefined"
as model name.
* @param {string|any} sName - name of the model to be retrieved
* @returns {sap.ui.model.Model} oModel
*/
public getModel(sName?: string|any): sap.ui.model.Model;
/**
* Get the object binding object for a specific model
* @param {string} sModelName - the name of the model
* @returns {sap.ui.model.Binding} the element binding for the given model name
*/
public getObjectBinding(sModelName: string): sap.ui.model.Binding;
/**
* Returns the origin info for the value of the given property.
*
* The origin info might contain additional information for translatable
* texts. The bookkeeping of this information is not active by default and must be
* activated by configuration. Even then, it might not be present for all properties
* and their values depending on where the value came form.
* @param {string} sPropertyName - the name of the property
* @returns {any} a map of properties describing the origin of this property value or null
*/
public getOriginInfo(sPropertyName: string): any;
/**
* Returns the parent managed object or null
if this object hasn't been added to a parent yet.
*
* The parent returned by this method is the technical parent used for data binding, invalidation,
* rendering etc. It might differ from the object on which the application originally added this object
* (the so called 'API parent'): some composite controls internally use hidden controls or containers
* to store their children. This method will return the innermost container that technically contains this
* object as a child.
*
* Example:
*
* Assume that a Dialog
internally uses a (hidden) VerticalLayout
to store its content:
*
*
* Dialog (API parent)
* \__ VerticalLayout (hidden composite part)
* \__ Text (API child)
*
*
* If you add some content by calling the Dialog.prototype.addContent
API, this will lead
* to the following observations:
*
*
* oDialog.addContent(oText);
* console.log(oText.getParent() === oDialog); // false
* console.log(oText.getParent() instanceof VerticalLayout); // true
* console.log(oText.getParent().getParent() === oDialog); // true now, but might fail with later versions
*
*
* Technically, from API perspective, oText
is added as a child to Dialog
.
* But internally, the Dialog
adds the child to the hidden VerticalLayout
container.
* If you now call the getParent
method of the child, you will get the internal
* VerticalLayout
object and not the Dialog
API parent.
*
* Note: The internal (hidden) structure of a composite control is not fixed and may be changed
* (see also our "Compatibility Rules"). Therefore, you should never rely on a specific structure or
* object being returned by getParent
.
*
* Note: There is no API to determine the original API parent.
* @returns {sap.ui.base.ManagedObject} The technical parent managed object or null
*/
public getParent(): sap.ui.base.ManagedObject;
/**
* get propagation listeners
* @returns {any[]} aPropagationListeners Returns registered propagationListeners
*/
protected getPropagationListeners(): any[];
/**
* Returns the value for the property with the given sPropertyName
.
*
* Note: This method is a low-level API as described in the class documentation.
* Applications or frameworks must not use this method to generically retrieve the value of a property.
* Use the concrete method getXYZ for property 'XYZ' instead.
* @param {string} sPropertyName - the name of the property
* @returns {any} the value of the property
*/
protected getProperty(sPropertyName: string): any;
/**
* Check if any model is set to the ManagedObject or to one of its parents (including UIArea and Core).
*
* Note: A ManagedObject inherits models from the Core only when it is a descendant of a UIArea.
* @returns {boolean} whether a model reference exists or not
*/
public hasModel(): boolean;
/**
* Searches for the provided ManagedObject in the named aggregation and returns its
* 0-based index if found, or -1 otherwise. Returns -2 if the given named aggregation
* is of cardinality 0..1 and doesn't reference the given object.
*
* Note: This method is a low-level API as described in the class documentation.
* Applications or frameworks must not use this method to generically determine the position of an object in an aggregation.
* Use the concrete method indexOfXYZ for aggregation 'XYZ' instead.
* @param {string} sAggregationName - the name of the aggregation
* @param {sap.ui.base.ManagedObject} oObject - the ManagedObject whose index is looked for.
* @returns {number} the index of the provided managed object in the aggregation.
*/
protected indexOfAggregation(sAggregationName: string, oObject: sap.ui.base.ManagedObject): number;
/**
* Inserts managed object oObject
to the aggregation named sAggregationName
at
* position iIndex
.
*
* If the given object is not valid with regard to the aggregation (if it is not an instance
* of the type specified for that aggregation) or when the method is called for an aggregation
* of cardinality 0..1, then an Error is thrown (see {@link #validateAggregation}.
*
* If the given index is out of range with respect to the current content of the aggregation,
* it is clipped to that range (0 for iIndex < 0, n for iIndex > n).
*
* Please note that this method does not work as expected when an object is added
* that is already part of the aggregation. In order to change the index of an object
* inside an aggregation, first remove it, then insert it again.
*
* Note: This method is a low-level API as described in the class documentation.
* Applications or frameworks must not use this method to generically insert an object into an aggregation.
* Use the concrete method insertXYZ for aggregation 'XYZ' instead.
* @param {string} sAggregationName - the string identifying the aggregation the managed object oObject
should be inserted into.
* @param {sap.ui.base.ManagedObject} oObject - the ManagedObject to add; if empty, nothing is inserted.
* @param {number} iIndex - the 0
-based index the managed object should be inserted at; for a negative value iIndex
, oObject
is inserted at position 0; for a value greater than the current size of the aggregation, oObject
is inserted at the last position
* @param {boolean} bSuppressInvalidate - if true, this ManagedObject as well as the added child are not marked as changed
* @returns {sap.ui.base.ManagedObject} Returns this
to allow method chaining
*/
protected insertAggregation(sAggregationName: string, oObject: sap.ui.base.ManagedObject, iIndex: number, bSuppressInvalidate?: boolean): sap.ui.base.ManagedObject;
/**
* This triggers rerendering of itself and its children.
As sap.ui.base.ManagedObject
"bubbles up" the
* invalidate, changes to child-Elements
will also result in rerendering of the whole sub tree.
*/
protected invalidate(): void;
/**
* Find out whether a property or aggregation is bound
* @param {string} sName - the name of the property or aggregation
* @returns {boolean} whether a binding exists for the given name
*/
public isBound(sName: string): boolean;
/**
* Returns whether rerendering is currently suppressed on this ManagedObject
* @returns {any} boolean
*/
protected isInvalidateSuppressed(): any;
/**
* Returns whether the given property value is initial and has not been explicitly set or bound.
* Even after setting the default value or setting null/undefined (which also causes the default value to be set),
* the property is no longer initial. A property can be reset to initial state by calling resetProperty(sPropertyName)
.
* @param {string} sPropertyName - the name of the property
* @returns {boolean} true if the property is initial
*/
protected isPropertyInitial(sPropertyName: string): boolean;
/**
* This method is used internally and should only be overridden by a tree managed object which utilizes the tree binding.
* In this case and if the aggregation is a tree node the overridden method should then return true.
* If true is returned the tree binding will be used instead of the list binding.
* @param {string} sName - the aggregation to bind (e.g. nodes for a tree managed object)
* @returns {boolean} whether tree binding should be used or list binding. Default is false. Override method to change this behavior.
*/
protected isTreeBinding(sName: string): boolean;
/**
* Generic method which is called, whenever messages for this object exists.
* @param {string} sName - The property name
* @param {string[]} aMessages - The messages
*/
protected propagateMessages(sName: string, aMessages: string[]): void;
/**
* Generic method which can be called, when an aggregation needs to be refreshed.
* This method does not make any change on the aggregation, but just calls the
* getContexts
method of the binding to trigger fetching of new data.
*
* Subclasses should call this method only in the implementation of a named refresh method
* and for no other purposes. The framework might change the conditions under which the method
* is called and the method implementation might rely on those conditions.
* @param {string} sName - name of the aggregation to refresh
*/
protected refreshAggregation(sName: string): void;
/**
* Removes an object from the aggregation named sAggregationName
with cardinality 0..n.
*
* The removed object is not destroyed nor is it marked as changed.
*
* If the given object is found in the aggregation, it is removed, it's parent relationship
* is unset and this ManagedObject is marked as changed. The removed object is returned as
* result of this method. If the object could not be found, undefined
is returned.
*
* This method must only be called for aggregations of cardinality 0..n. The only way to remove objects
* from a 0..1 aggregation is to set a null
value for them.
*
* Note: This method is a low-level API as described in the class documentation.
* Applications or frameworks must not use this method to generically remove an object from an aggregation.
* Use the concrete method removeXYZ for aggregation 'XYZ' instead.
* @param {string} sAggregationName - the string identifying the aggregation that the given object should be removed from
* @param {number|string|sap.ui.base.ManagedObject} vObject - the position or ID of the ManagedObject that should be removed or that ManagedObject itself; if vObject
is invalid, a negative value or a value greater or equal than the current size of the aggregation, nothing is removed.
* @param {boolean} bSuppressInvalidate - if true, this ManagedObject is not marked as changed
* @returns {sap.ui.base.ManagedObject} the removed object or null
*/
protected removeAggregation(sAggregationName: string, vObject: number|string|sap.ui.base.ManagedObject, bSuppressInvalidate?: boolean): sap.ui.base.ManagedObject;
/**
* Removes all objects from the 0..n-aggregation named sAggregationName
.
*
* The removed objects are not destroyed nor are they marked as changed.
*
* Additionally, it clears the parent relationship of all removed objects, marks this
* ManagedObject as changed and returns an array with the removed objects.
*
* If the aggregation did not contain any objects, an empty array is returned and this
* ManagedObject is not marked as changed.
*
* Note: This method is a low-level API as described in the class documentation.
* Applications or frameworks must not use this method to generically remove all objects from an aggregation.
* Use the concrete method removeAllXYZ for aggregation 'XYZ' instead.
* @param {string} sAggregationName - the name of the aggregation
* @param {boolean} bSuppressInvalidate - if true, this ManagedObject is not marked as changed
* @returns {any[]} an array of the removed elements (might be empty)
*/
protected removeAllAggregation(sAggregationName: string, bSuppressInvalidate?: boolean): any[];
/**
* Removes all the objects in the 0..n-association named sAssociationName
and returns an array
* with their IDs. This ManagedObject is marked as changed, if the association contained any objects.
*
* Note: This method is a low-level API as described in the class documentation.
* Applications or frameworks must not use this method to generically remove all object from an association.
* Use the concrete method removeAllXYZ for association 'XYZ' instead.
* @param {string} sAssociationName - the name of the association
* @param {boolean} bSuppressInvalidate - if true, this ManagedObject is not marked as changed
* @returns {any[]} an array with the IDs of the removed objects (might be empty)
*/
protected removeAllAssociation(sAssociationName: string, bSuppressInvalidate?: boolean): any[];
/**
* Removes a ManagedObject
from the association named sAssociationName
.
*
* If an object is removed, the ID of that object is returned and this ManagedObject
is
* marked as changed. Otherwise null
is returned.
*
* If the same object was added multiple times to the same association, only a single
* occurrence of it will be removed by this method. If the object is not found or if the
* parameter can't be interpreted neither as a ManagedObject
(or ID) nor as an index in
* the association, nothing will be removed. The same is true if an index is given and if
* that index is out of range for the association.
*
* Note: This method is a low-level API as described in the class documentation.
* Applications or frameworks must not use this method to generically remove an object from an association.
* Use the concrete method removeXYZ for association 'XYZ' instead.
* @param {string} sAssociationName - the string identifying the association the ManagedObject
should be removed from.
* @param {number|string|sap.ui.base.ManagedObject} vObject - the position or ID of the ManagedObject
to remove or the ManagedObject
itself; if vObject
is invalid input, a negative value or a value greater or equal than the current size of the association, nothing is removed
* @param {boolean} bSuppressInvalidate - if true
, the managed object is not marked as changed
* @returns {string|null} ID of the removed ManagedObject
or null
*/
protected removeAssociation(sAssociationName: string, vObject: number|string|sap.ui.base.ManagedObject, bSuppressInvalidate?: boolean): string|null;
/**
* remove a propagation listener
* @param {Function} listener - function
* @returns {sap.ui.base.ManagedObject} Returns this
to allow method chaining
*/
protected removePropagationListener(listener: Function): sap.ui.base.ManagedObject;
/**
* Resets the given property to the default value and also restores the "initial" state (like it has never been set).
* @param {string} sPropertyName - the name of the property
* @returns {sap.ui.base.ManagedObject} Returns this
to allow method chaining
*/
protected resetProperty(sPropertyName: string): sap.ui.base.ManagedObject;
/**
* Sets a new object in the named 0..1 aggregation of this ManagedObject and
* marks this ManagedObject as changed.
*
* If the given object is not valid with regard to the aggregation (if it is not an instance
* of the type specified for that aggregation) or when the method is called for an aggregation
* of cardinality 0..n, then an Error is thrown (see {@link #validateAggregation}.
*
* If the new object is the same as the currently aggregated object, then the internal state
* is not modified and this ManagedObject is not marked as changed.
*
* If the given object is different, the parent of a previously aggregated object is cleared
* (it must have been this ManagedObject before), the parent of the given object is set to this
* ManagedObject and {@link #invalidate} is called for this object.
*
* Note that this method does neither return nor destroy the previously aggregated object.
* This behavior is inherited by named set methods (see below) in subclasses.
* To avoid memory leaks, applications therefore should first get the aggregated object,
* keep a reference to it or destroy it, depending on their needs, and only then set a new
* object.
*
* Note that ManagedObject only implements a single level of change tracking: if a first
* call to setAggregation recognizes a change, 'invalidate' is called. If another call to
* setAggregation reverts that change, invalidate() will be called again, the new status
* is not recognized as being 'clean' again.
*
* Note: This method is a low-level API as described in the class documentation.
* Applications or frameworks must not use this method to generically set an object in an aggregation.
* Use the concrete method setXYZ for aggregation 'XYZ' or the generic {@link #applySettings} instead.
* @param {string} sAggregationName - name of an 0..1 aggregation
* @param {any} oObject - the managed object that is set as aggregated object
* @param {boolean} bSuppressInvalidate - if true, this ManagedObject is not marked as changed
* @returns {sap.ui.base.ManagedObject} Returns this
to allow method chaining
*/
protected setAggregation(sAggregationName: string, oObject: any, bSuppressInvalidate?: boolean): sap.ui.base.ManagedObject;
/**
* Sets the associated object for the given managed association of cardinality '0..1' and
* marks this ManagedObject as changed.
*
* The associated object can either be given by itself or by its id. If null
or
* undefined
is given, the association is cleared.
*
* Note: This method is a low-level API as described in the class documentation.
* Applications or frameworks must not use this method to generically set an object in an association.
* Use the concrete method setXYZ for association 'XYZ' or the generic {@link #applySettings} instead.
* @param {string} sAssociationName - name of the association
* @param {string|sap.ui.base.ManagedObject} sId - the ID of the managed object that is set as an association, or the managed object itself or null
* @param {boolean} bSuppressInvalidate - if true, the managed objects invalidate method is not called
* @returns {sap.ui.base.ManagedObject} Returns this
to allow method chaining
*/
protected setAssociation(sAssociationName: string, sId: string|sap.ui.base.ManagedObject, bSuppressInvalidate?: boolean): sap.ui.base.ManagedObject;
/**
* Set the binding context for this ManagedObject for the model with the given name.
*
* Note: to be compatible with future versions of this API, applications must not use the value null
,
* the empty string ""
or the string literals "null"
or "undefined"
as model name.
*
* Note: A ManagedObject inherits binding contexts from the Core only when it is a descendant of a UIArea.
* @param {sap.ui.model.Context} oContext - the new binding context for this object
* @param {string} sModelName - the name of the model to set the context for or undefined
* @returns {sap.ui.base.ManagedObject} reference to the instance itself
*/
public setBindingContext(oContext: sap.ui.model.Context, sModelName?: string): sap.ui.base.ManagedObject;
/**
* Sets or unsets a model for the given model name for this ManagedObject.
*
* The sName
must either be undefined
(or omitted) or a non-empty string.
* When the name is omitted, the default model is set/unset.
*
* When oModel
is null
or undefined
, a previously set model
* with that name is removed from this ManagedObject. If an ancestor (parent, UIArea or Core) has a model
* with that name, this ManagedObject will immediately inherit that model from its ancestor.
*
* All local bindings that depend on the given model name are updated (created if the model references
* became complete now; updated, if any model reference has changed; removed if the model references
* became incomplete now).
*
* Any change (new model, removed model, inherited model) is also applied to all aggregated descendants
* as long as a descendant doesn't have its own model set for the given name.
*
* Note: to be compatible with future versions of this API, applications must not use the value null
,
* the empty string ""
or the string literals "null"
or "undefined"
as model name.
*
* Note: By design, it is not possible to hide an inherited model by setting a null
or
* undefined
model. Applications can set an empty model to achieve the same.
*
* Note: A ManagedObject inherits models from the Core only when it is a descendant of a UIArea.
* @param {sap.ui.model.Model} oModel - the model to be set or null
or undefined
* @param {string} sName - the name of the model or undefined
* @returns {sap.ui.base.ManagedObject} this
to allow method chaining
*/
public setModel(oModel: sap.ui.model.Model, sName?: string): sap.ui.base.ManagedObject;
/**
* Sets the given value for the given property after validating and normalizing it,
* marks this object as changed.
*
* If the value is not valid with regard to the declared data type of the property,
* an Error is thrown. In case null
or undefined
is passed,
* the default value for this property is used (see {@link #validateProperty}). To fully
* reset the property to initial state, use {@link #resetProperty} instead.
* If the validated and normalized oValue
equals the current value of the property,
* the internal state of this object is not changed (apart from the result of {@link #isPropertyInitial}).
* If the value changes, it is stored internally
* and the {@link #invalidate} method is called on this object. In the case of TwoWay
* databinding, the bound model is informed about the property change.
*
* Note that ManagedObject only implements a single level of change tracking: if a first
* call to setProperty recognizes a change, 'invalidate' is called. If another call to
* setProperty reverts that change, invalidate() will be called again, the new status
* is not recognized as being 'clean' again.
*
* Note: This method is a low level API as described in the class documentation.
* Applications or frameworks must not use this method to generically set a property.
* Use the concrete method setXYZ for property 'XYZ' or the generic {@link #applySettings} instead.
* @param {string} sPropertyName - name of the property to set
* @param {any} oValue - value to set the property to
* @param {boolean} bSuppressInvalidate - if true, the managed object is not marked as changed
* @returns {sap.ui.base.ManagedObject} Returns this
to allow method chaining
*/
protected setProperty(sPropertyName: string, oValue: any, bSuppressInvalidate?: boolean): sap.ui.base.ManagedObject;
/**
* Returns a simple string representation of this managed object.
*
* Mainly useful for tracing purposes.
* @returns {string} a string description of this managed object
*/
public toString(): string;
/**
* Unbind the aggregation from the model
* @param {string} sName - the name of the aggregation
* @param {boolean} bSuppressReset - whether the reset to empty aggregation when unbinding should be suppressed
* @returns {sap.ui.base.ManagedObject} reference to the instance itself
*/
public unbindAggregation(sName: string, bSuppressReset: boolean): sap.ui.base.ManagedObject;
/**
* Removes the defined binding context of this object, all bindings will now resolve
* relative to the parent context again.
* @param {string} sModelName - name of the model to remove the context for.
* @returns {sap.ui.base.ManagedObject} reference to the instance itself
*/
public unbindContext(sModelName?: string): sap.ui.base.ManagedObject;
/**
* Removes the defined binding context of this object, all bindings will now resolve
* relative to the parent context again.
* @param {string} sModelName - name of the model to remove the context for.
* @returns {sap.ui.base.ManagedObject} reference to the instance itself
*/
public unbindObject(sModelName?: string): sap.ui.base.ManagedObject;
/**
* Unbind the property from the model
* @param {string} sName - the name of the property
* @param {boolean} bSuppressReset - whether the reset to the default value when unbinding should be suppressed
* @returns {sap.ui.base.ManagedObject} reference to the instance itself
*/
public unbindProperty(sName: string, bSuppressReset: boolean): sap.ui.base.ManagedObject;
/**
* Generic method which is called whenever an aggregation binding has changed.
*
* Depending on the type of the list binding and on additional configuration, this method either
* destroys all elements in the aggregation sName
and recreates them anew
* or tries to reuse as many existing objects as possible. It is up to the method which
* strategy it uses.
*
* In case a managed object needs special handling for an aggregation binding, it can create
* a named update method (e.g. updateRows
for an aggregation rows
)
* which then will be called by the framework instead of this generic method.
*
* Subclasses should call this method only in the implementation of such a named update method
* and for no other purposes. The framework might change the conditions under which the method
* is called and the method implementation might rely on those conditions.
* @param {string} sName - name of the aggregation to update
*/
protected updateAggregation(sName: string): void;
/**
* Checks whether the given value is of the proper type for the given aggregation name.
*
* This method is already called by {@link #setAggregation}, {@link #addAggregation} and {@link #insertAggregation}.
* In many cases, subclasses of ManagedObject don't need to call it again in their mutator methods.
* @param {string} sAggregationName - the name of the aggregation
* @param {sap.ui.base.ManagedObject|any} oObject - the aggregated object or a primitive value
* @param {boolean} bMultiple - whether the caller assumes the aggregation to have cardinality 0..n
* @returns {sap.ui.base.ManagedObject|any} the passed object
*/
protected validateAggregation(sAggregationName: string, oObject: sap.ui.base.ManagedObject|any, bMultiple: boolean): sap.ui.base.ManagedObject|any;
/**
* Checks whether the given value is of the proper type for the given property name.
*
* In case null
or undefined
is passed, the default value for
* this property is used as value. If no default value is defined for the property, the
* default value of the type of the property is used.
*
* If the property has a data type that is an instance of sap.ui.base.DataType and if
* a normalize
function is defined for that type, that function will be
* called with the resulting value as only argument. The result of the function call is
* then used instead of the raw value.
*
* This method is called by {@link #setProperty}. In many cases, subclasses of
* ManagedObject don't need to call it themselves.
* @param {string} sPropertyName - the name of the property
* @param {any} oValue - the value
* @returns {any} the normalized value for the passed value or for the default value if null or undefined was passed
*/
protected validateProperty(sPropertyName: string, oValue: any): any;
}
/**
* Note about Info Objects
*
* Several methods in this class return info objects that describe a property,
* aggregation, association or event of the class described by this metadata object.
* The type, structure and behavior of these info objects is not yet documented and
* not part of the stable, public API.
*
* Code using such methods and the returned info objects therefore needs to be aware
* of the following restrictions:
*
*
* - the set of properties exposed by each info object, their type and value
* might change as well as the class of the info object itself.
*
* Properties that represent settings provided during class definition
* (in the oClassInfo parameter of the 'extend' call, e.g. 'type', 'multiple'
* of an aggregation) are more likely to stay the same than additional, derived
* properties like '_iKind'.
*
* - info objects must not be modified / enriched although they technically could.
*
* - the period of validity of info objects is not defined. They should be
* referenced only for a short time and not be kept as members of long living
* objects or closures.
*
*
*/
export class ManagedObjectMetadata {
/**
* Creates a new metadata object that describes a subclass of ManagedObject.
*
* Note: Code outside the sap.ui.base
namespace must not call this
* constructor directly. Instances will be created automatically when a new class is
* defined with one of the {@link sap.ui.base.ManagedObject.extend SomeClass.extend}
* methods.
*
* Note: throughout this class documentation, the described subclass of ManagedObject
* is referenced as the described class.
* @param {string} sClassName - fully qualified name of the described class
* @param {any} oClassInfo - static info to construct the metadata from
*/
public constructor(sClassName: string, oClassInfo: any);
/**
* Returns an info object for the named public aggregation of the described class
* no matter whether the aggregation was defined by the class itself or by one of its
* ancestor classes.
*
* If neither the class nor its ancestor classes define a public aggregation with the given
* name, undefined
is returned.
*
* If the name is not given (or has a falsy value), then it is substituted by the
* name of the default aggregation of the 'described class' (if any).
*
* Warning: Type, structure and behavior of the returned info objects is not documented
* and therefore not part of the API. See the {@link #constructor Notes about Info objects}
* in the constructor documentation of this class.
* @param {string} sName - name of the aggregation or empty
* @returns {Object} An info object describing the aggregation or undefined
*/
public getAggregation(sName?: string): Object;
/**
* Returns a map of info objects for the public aggregations of the described class.
* Aggregations declared by ancestor classes are not included.
*
* The returned map keys the aggregation info objects by their name.
* In case of 0..1 aggregations this is the singular name, otherwise it is the plural name.
*
* Warning: Type, structure and behavior of the returned info objects is not documented
* and therefore not part of the API. See the {@link #constructor Notes about Info objects}
* in the constructor documentation of this class.
* @returns {{ [key: string]: any }} Map of aggregation info objects keyed by aggregation names
*/
public getAggregations(): { [key: string]: any };
/**
* Returns a map of info objects for all public aggregations of the described class,
* including public aggregations form the ancestor classes.
*
* The returned map keys the aggregation info objects by their name.
* In case of 0..1 aggregations this is the singular name, otherwise it is the plural
* name.
*
* Warning: Type, structure and behavior of the returned info objects is not documented
* and therefore not part of the API. See the {@link #constructor Notes about Info objects}
* in the constructor documentation of this class.
* @returns {{ [key: string]: any }} Map of aggregation info objects keyed by aggregation names
*/
public getAllAggregations(): { [key: string]: any };
/**
* Returns a map of info objects for all public associations of the described class,
* including public associations form the ancestor classes.
*
* The returned map keys the association info objects by their name.
* In case of 0..1 associations this is the singular name, otherwise it is the plural name.
*
* Warning: Type, structure and behavior of the returned info objects is not documented
* and therefore not part of the API. See the {@link #constructor Notes about Info objects}
* in the constructor documentation of this class.
* @returns {{ [key: string]: any }} Map of association info objects keyed by association names
*/
public getAllAssociations(): { [key: string]: any };
/**
* Returns a map of info objects for all public events of the described class,
* including public events form the ancestor classes.
*
* The returned map keys the event info objects by their name.
*
* Warning: Type, structure and behavior of the returned info objects is not documented
* and therefore not part of the API. See the {@link #constructor Notes about Info objects}
* in the constructor documentation of this class.
* @returns {{ [key: string]: any }} Map of event info objects keyed by event names
*/
public getAllEvents(): { [key: string]: any };
/**
* Returns a map of info objects for all private (hidden) aggregations of the described class,
* including private aggregations from the ancestor classes.
*
* The returned map contains aggregation info objects keyed by the aggregation name.
* In case of 0..1 aggregations this is the singular name, otherwise it is the plural name.
*
* Warning: Type, structure and behavior of the returned info objects is not documented
* and therefore not part of the API. See the {@link #constructor Notes about Info objects}
* in the constructor documentation of this class.
* @returns {{ [key: string]: any }} Map of aggregation infos keyed by aggregation names
*/
protected getAllPrivateAggregations(): { [key: string]: any };
/**
* Returns a map of info objects for all public properties of the described class,
* including public properties from the ancestor classes.
*
* The returned map keys the property info objects by their name.
*
* Warning: Type, structure and behavior of the returned info objects is not documented
* and therefore not part of the API. See the {@link #constructor Notes about Info objects}
* in the constructor documentation of this class.
* @returns {{ [key: string]: any }} Map of property info objects keyed by the property names
*/
public getAllProperties(): { [key: string]: any };
/**
* Returns an info object for the named public association of the described class,
* no matter whether the association was defined by the class itself or by one of its
* ancestor classes.
*
* If neither the described class nor its ancestor classes define an association with
* the given name, undefined
is returned.
*
* Warning: Type, structure and behavior of the returned info objects is not documented
* and therefore not part of the API. See the {@link #constructor Notes about Info objects}
* in the constructor documentation of this class.
* @param {string} sName - name of the association
* @returns {Object} An info object describing the association or undefined
*/
public getAssociation(sName: string): Object;
/**
* Returns a map of info objects for all public associations of the described class.
* Associations declared by ancestor classes are not included.
*
* The returned map keys the association info objects by their name.
* In case of 0..1 associations this is the singular name, otherwise it is the plural name.
*
* Warning: Type, structure and behavior of the returned info objects is not documented
* and therefore not part of the API. See the {@link #constructor Notes about Info objects}
* in the constructor documentation of this class.
* @returns {{ [key: string]: any }} Map of association info objects keyed by association names
*/
public getAssociations(): { [key: string]: any };
/**
* Returns an info object for the named public event of the described class,
* no matter whether the event was defined by the class itself or by one of its
* ancestor classes.
*
* If neither the described class nor its ancestor classes define an event with the
* given name, undefined
is returned.
*
* Warning: Type, structure and behavior of the returned info objects is not documented
* and therefore not part of the API. See the {@link #constructor Notes about Info objects}
* in the constructor documentation of this class.
* @param {string} sName - name of the event
* @returns {Object} An info object describing the event or undefined
*/
public getEvent(sName: string): Object;
/**
* Returns a map of info objects for the public events of the described class.
* Events declared by ancestor classes are not included.
*
* The returned map keys the event info objects by their name.
*
* Warning: Type, structure and behavior of the returned info objects is not documented
* and therefore not part of the API. See the {@link #constructor Notes about Info objects}
* in the constructor documentation of this class.
* @returns {{ [key: string]: any }} Map of event info objects keyed by event names
*/
public getEvents(): { [key: string]: any };
/**
* Returns the name of the library that contains the described UIElement.
* @returns {string} the name of the library
*/
public getLibraryName(): string;
/**
* Returns the info object for the named public or private aggregation declared by the
* described class or by any of its ancestors.
*
* If the name is not given (or has a falsy value), then it is substituted by the
* name of the default aggregation of the described class (if it is defined).
*
* Warning: Type, structure and behavior of the returned info objects is not documented
* and therefore not part of the API. See the {@link #constructor Notes about Info objects}
* in the constructor documentation of this class.
* @param {string} sAggregationName - name of the aggregation to be retrieved or empty
* @returns {any} aggregation info object or undefined
*/
protected getManagedAggregation(sAggregationName: string): any;
/**
* Returns a map of info objects for the public properties of the described class.
* Properties declared by ancestor classes are not included.
*
* The returned map keys the property info objects by their name.
*
* Warning: Type, structure and behavior of the returned info objects is not documented
* and therefore not part of the API. See the {@link #constructor Notes about Info objects}
* in the constructor documentation of this class.
* @returns {{ [key: string]: any }} Map of property info objects keyed by the property names
*/
public getProperties(): { [key: string]: any };
/**
* Returns an info object for the named public property of the described class,
* no matter whether the property was defined by the class itself or by one of its
* ancestor classes.
*
* If neither the described class nor its ancestor classes define a property with the
* given name, undefined
is returned.
*
* Warning: Type, structure and behavior of the returned info objects is not documented
* and therefore not part of the API. See the {@link #constructor Notes about Info objects}
* in the constructor documentation of this class.
* @param {string} sName - name of the property
* @returns {Object} An info object describing the property or undefined
*/
public getProperty(sName: string): Object;
/**
* Returns a map of default values for all properties declared by the
* described class and its ancestors, keyed by the property name.
* @returns {{ [key: string]: any }} Map of default values keyed by property names
*/
public getPropertyDefaults(): { [key: string]: any };
/**
* Returns an info object for a public setting with the given name that either is
* a managed property or a managed aggregation of cardinality 0..1 and with at least
* one simple alternative type. The setting can be defined by the class itself or
* by one of its ancestor classes.
*
* If neither the described class nor its ancestor classes define a suitable setting
* with the given name, undefined
is returned.
*
* Warning: Type, structure and behavior of the returned info objects is not documented
* and therefore not part of the API. See the {@link #constructor Notes about Info objects}
* in the constructor documentation of this class.
* @param {string} sName - name of the property like setting
* @returns {Object} An info object describing the property or aggregation or undefined
*/
public getPropertyLikeSetting(sName: string): Object;
/**
* Checks the existence of the given aggregation by its name.
* @param {string} sName - name of the aggregation
* @returns {boolean} true, if the aggregation exists
*/
public hasAggregation(sName: string): boolean;
/**
* Checks the existence of the given association by its name
* @param {string} sName - name of the association
* @returns {boolean} true, if the association exists
*/
public hasAssociation(sName: string): boolean;
/**
* Checks the existence of the given event by its name
* @param {string} sName - name of the event
* @returns {boolean} true, if the event exists
*/
public hasEvent(sName: string): boolean;
/**
* Checks the existence of the given property by its name
* @param {string} sName - name of the property
* @returns {boolean} true, if the property exists
*/
public hasProperty(sName: string): boolean;
/**
* Test whether a given ID looks like it was automatically generated.
*
* Examples:
*
* True for:
* "foo--__bar04--baz"
* "foo--__bar04"
* "__bar04--baz"
* "__bar04"
* "__bar04--"
* "__bar04--foo"
* False for:
* "foo__bar04"
* "foo__bar04--baz"
*
*
* See {@link sap.ui.base.ManagedObjectMetadata.prototype.uid} for details on ID generation.
* @param {string} sId - the ID that should be tested
* @returns {boolean} whether the ID is likely to be generated
*/
public static isGeneratedId(sId: string): boolean;
/**
* Load and returns the design time metadata asynchronously.
*
* Be aware that ManagedObjects do not ensure to have unique IDs. This may lead to
* issues if you would like to persist DesignTime based information. In that case
* you need to take care of identification yourself.
* @returns {Promise} A promise which will return the loaded design time metadata
*/
protected loadDesignTime(): Promise;
/**
* Calculates a new ID for an instance of this class.
*
* Note that the calculated short name part is usually not unique across
* all classes, but doesn't have to be. It might even be empty when the
* class name consists of invalid characters only.
* @returns {string} A (hopefully unique) control ID
*/
public uid(): string;
/**
* Calculates a new ID based on a prefix.
*
* To guarantee uniqueness of the generated IDs across all ID prefixes,
* prefixes must not end with digits.
* @param {string} sIdPrefix - prefix for the new ID
* @returns {string} A (hopefully unique) control id
*/
public static uid(sIdPrefix: string): string;
}
/**
* Use the ManagedObjectObserver to get notified when properties, aggregations or associations of a
* ManagedObject instance have changed.
*
* Use the {@link #observe} method to add instances of ManagedObject that should be observed or to enhance
* the set of observed properties, aggregations etc. for an already observed instance.
*
* Use the {@link #unobserve} method to stop observing an instance of ManagedObject or to reduce the set of
* observed properties, aggregations etc. for an observed instance.
*
* Use the {@link #disconnect} method to completely stop observing all instances of ManagedObject hat previously
* had been added to this observer.
*
* The only parameter to the constructor is a function fnCallback
which will be called for every
* observed change. Depending on the type of the change, different change objects are passed to the callback:
*
* Property Change
* {string}
* change.name the name of the property that changed
* {string}
* change.type 'property'
* {object}
* change.object the managed object instance on which the change occurred
* {any}
* change.old the old value
* {any}
* change.current the new value
*
* Aggregation Change
* {string}
* change.name the name of the aggregation that changed
* {string}
* change.type 'aggregation'
* {object}
* change.object the managed object instance on which the change occurred
* {any}
* change.mutation 'remove' or 'insert'
* {sap.ui.base.ManagedObject}
* change.child the child managed object instance
*
* Association Change
* {string}
* change.name the name of the association that changed
* {string}
* change.type 'association'
* {object}
* change.object the managed object instance on which the change occurred
* {any}
* change.mutation 'remove' or 'insert'
* {string|string[]}
* change.ids the ids that changed
*/
export class ManagedObjectObserver {
/**
* Constructor for a new ManagedObjectObserver.
* @param {Function} fnCallback - Callback function for this observer, to be called whenever a change happens
*/
protected constructor(fnCallback: Function);
/**
* Disconnect the observer from all objects.
*/
protected disconnect(): void;
/**
* Creates a new subclass of class sap.ui.base.ManagedObjectObserver with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.base.ManagedObjectObserver.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks whether a given configuration set for a control is observed.
*
* All given settings must be observed for the method to return true.
* @param {sap.ui.base.ManagedObject} oObject - the managed object instance that was observed
* @param {any} oConfiguration - a mandatory configuration specifying the settings to stop observing for the object
* @returns {boolean} true
if configuration is observed
*/
protected isObserved(oObject: sap.ui.base.ManagedObject, oConfiguration: any): boolean;
/**
* Starts observing the given object. A configuration is used to specify the meta data settings that should be observed.
* Configuration should be as specific as possible to avoid negative performance impact.
* Observing all settings (properties, aggregations, associations) should be avoided.
* @param {sap.ui.base.ManagedObject} oObject - the managed object instance to be observed
* @param {any} oConfiguration - a mandatory configuration specifying the settings to observe for the object
*/
protected observe(oObject: sap.ui.base.ManagedObject, oConfiguration: any): void;
/**
* Stops observing the given object. A configuration is used to specify the meta data settings that should be ignored. Configuration should be as
* specific as possible to avoid negative performance impact. Observing all settings (properties, aggregations, associations) should be avoided.
* @param {sap.ui.base.ManagedObject} oObject - the managed object instance that was observed
* @param {any} oConfiguration - a mandatory configuration specifying the settings to stop observing for the object
*/
protected unobserve(oObject: sap.ui.base.ManagedObject, oConfiguration: any): void;
}
/**
* Metadata for a class.
*/
export class Metadata {
/**
* Creates a new metadata object from the given static infos.
*
* Note: throughout this class documentation, the described subclass of Object
* is referenced as the described class.
* @param {string} sClassName - fully qualified name of the described class
* @param {any} oClassInfo - info to construct the class and its metadata from
*/
public constructor(sClassName: string, oClassInfo: any);
/**
* Returns an array with the names of all public methods declared by the described class
* and its ancestors.
* @returns {string[]} array with names of all public methods provided by the described class and its ancestors
*/
public getAllPublicMethods(): string[];
/**
* Returns the (constructor of the) described class
* @returns {Function} class described by this metadata
*/
public getClass(): Function;
/**
* Returns the fully qualified name of the described class
* @returns {string} name of the described class
*/
public getName(): string;
/**
* Returns the metadata object of the base class of the described class
* or null if the class has no (documented) base class.
* @returns {sap.ui.base.Metadata} metadata of the base class
*/
public getParent(): sap.ui.base.Metadata;
/**
* Returns an array with the names of the public methods declared by the described class.
* @returns {string[]} array with names of public methods declared by the described class
*/
public getPublicMethods(): string[];
/**
* Returns whether the described class is abstract
* @returns {boolean} whether the class is abstract
*/
public isAbstract(): boolean;
/**
* Whether the described class is deprecated and should not be used any more
* @returns {boolean} whether the class is considered deprecated
*/
public isDeprecated(): boolean;
/**
* Returns whether the described class is final
* @returns {boolean} whether the class is final
*/
public isFinal(): boolean;
/**
* Checks whether the described class or one of its ancestor classes implements the given interface.
* @param {string} sInterface - name of the interface to test for (in dot notation)
* @returns {boolean} whether this class implements the interface
*/
public isInstanceOf(sInterface: string): boolean;
}
/**
* Base class for all SAPUI5 Objects
*/
export class Object {
/**
* Constructor for an sap.ui.base.Object.
*/
public constructor();
/**
* Creates metadata for a given class and attaches it to the constructor and prototype of that class.
*
* After creation, metadata can be retrieved with getMetadata().
*
* The static info can at least contain the following entries:
*
* - baseType: {string} fully qualified name of a base class or empty
*
- publicMethods: {string} an array of method names that will be visible in the interface proxy returned by {@link #getInterface}
*
* @param {string} sClassName - name of an (already declared) constructor function
* @param {any} oStaticInfo - static info used to create the metadata object
* @param {Function} FNMetaImpl - constructor function for the metadata object. If not given, it defaults to sap.ui.base.Metadata.
* @returns {sap.ui.base.Metadata} the created metadata object
*/
public static defineClass(sClassName: string, oStaticInfo: any, FNMetaImpl?: Function): sap.ui.base.Metadata;
/**
* Destructor method for objects
*/
public destroy(): void;
/**
* Creates a subclass of class sap.ui.base.Object with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain three kinds of informations:
*
* metadata:
an (optional) object literal with metadata about the class.
* The information in the object literal will be wrapped by an instance of {@link sap.ui.base.Metadata Metadata}
* and might contain the following information
*
* interfaces:
{string[]} (optional) set of names of implemented interfaces (defaults to no interfaces)
* publicMethods:
{string[]} (optional) list of methods that should be part of the public
* facade of the class
* abstract:
{boolean} (optional) flag that marks the class as abstract (purely informational, defaults to false)
* final:
{boolean} (optional) flag that marks the class as final (defaults to false)
*
* Subclasses of sap.ui.base.Object can enrich the set of supported metadata (e.g. see {@link sap.ui.core.Element.extend}).
*
*
* constructor:
a function that serves as a constructor function for the new class.
* If no constructor function is given, the framework creates a default implementation that delegates all
* its arguments to the constructor function of the base class.
*
*
* - any-other-name: any other property in the
oClassInfo
is copied into the prototype
* object of the newly created class. Callers can thereby add methods or properties to all instances of the
* class. But be aware that the given values are shared between all instances of the class. Usually, it doesn't
* make sense to use primitive values here other than to declare public constants.
*
*
*
*
* The prototype object of the newly created class uses the same prototype as instances of the base class
* (prototype chaining).
*
* A metadata object is always created, even if there is no metadata
entry in the oClassInfo
* object. A getter for the metadata is always attached to the prototype and to the class (constructor function)
* itself.
*
* Last but not least, with the third argument FNMetaImpl
the constructor of a metadata class
* can be specified. Instances of that class will be used to represent metadata for the newly created class
* and for any subclass created from it. Typically, only frameworks will use this parameter to enrich the
* metadata for a new class hierarchy they introduce (e.g. {@link sap.ui.core.Element.extend Element}).
* @param {string} sClassName - name of the class to be created
* @param {any} oClassInfo - structured object with informations about the class
* @param {Function} FNMetaImpl - constructor function for the metadata object. If not given, it defaults to sap.ui.base.Metadata.
* @returns {Function} the created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the public interface of the object.
* @returns {sap.ui.base.Interface} the public interface of the object
*/
public getInterface(): sap.ui.base.Interface;
/**
* Returns the metadata for the class that this object belongs to.
*
* This method is only defined when metadata has been declared by using {@link sap.ui.base.Object.defineClass}
* or {@link sap.ui.base.Object.extend}.
* @returns {sap.ui.base.Metadata} {sap.ui.base.Metadata] metadata for the class of the object
*/
public getMetadata(): sap.ui.base.Metadata;
}
/**
* Manages a pool of objects all of the same type;
* the type has to be specified at pool construction time.
*
* Maintains a list of free objects of the given type.
* If {@link sap.ui.base.ObjectPool.prototype.borrowObject} is called, an existing free object
* is taken from the pool and the init
method is called on this
* object.
*
* When no longer needed, any borrowed object should be returned to
* the pool by calling {@link #returnObject}. At that point in time,
* the reset method is called on the object and the object is added to the
* list of free objects.
*
* See {@link sap.ui.base.Poolable} for a description of the contract for poolable objects.
*
* Example:
*
* this.oEventPool = new sap.ui.base.ObjectPool(sap.ui.base.Event);
* var oEvent = this.oEventPool.borrowObject(iEventId, mParameters);
*
*/
export class ObjectPool extends sap.ui.base.Object {
/**
* Creates an ObjectPool instance based on the given oObjectClass.<br/>
* If there is a free pooled instance, returns that one, otherwise creates a new one.<br/>
* In order to be maintained by the ObjectPool, oObjectClass must implement
* methods described in the class description.
* @param {Function} oObjectClass - constructor for the class of objects that this pool should manage
*/
public constructor(oObjectClass: Function);
/**
* Borrows a free object from the pool. Any arguments to this method
* are forwarded to the init method of the borrowed object.
* @param {any} any - optional initialization parameters for the borrowed object
* @returns {any} the borrowed object of the same type that has been specified for this pool
*/
public borrowObject(any?: any): any;
/**
* Creates a new subclass of class sap.ui.base.ObjectPool with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.base.ObjectPool.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns an object to the pool. The object must have been borrowed from this
* pool beforehand. The reset method is called on the object before it is added
* to the set of free objects.
* @param {any} oObject - the object to return to the pool
*/
public returnObject(oObject: any): void;
}
/**
* Contract for objects that can be pooled by ObjectPool
*/
export interface Poolable {
/**
* Called by the object pool when this instance will be actived for a caller.
* The same method will be called after a new instance has been created by an otherwise
* exhausted pool.
*
* If the caller provided any arguments to {@link sap.ui.base.ObjectPool#borrowObject}
* all arguments will be propagated to this method.
*/
init(): void;
/**
* Called by the object pool when an instance is returned to the pool.
* While no specific implementation is required, poolable objects in general
* should clean all caller specific state (set to null) in this method to
* avoid memory leaks and to enforce garbage collection of the caller state.
*/
reset(): void;
}
}
/**
* Common basic controls, mainly intended for desktop scenarios
*/
namespace commons {
/**
* Level of a title.
*/
var TitleLevel: any;
/**
* Contains N sections, acting as containers for any library control
*/
export class Accordion extends sap.ui.core.Control {
/**
* Constructor for a new Accordion.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some section to the aggregation {@link #getSections sections}.
* @param {sap.ui.commons.AccordionSection} oSection - the section to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
public addSection(oSection: sap.ui.commons.AccordionSection): sap.ui.commons.Accordion;
/**
* Attaches event handler fnFunction
to the {@link #event:sectionClose sectionClose} event of this sap.ui.commons.Accordion
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Accordion
itself.
*
* Event is triggered when the user closes a section.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Accordion
itself
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
public attachSectionClose(fnFunction: Function, oListener?: any): sap.ui.commons.Accordion;
/**
* Attaches event handler fnFunction
to the {@link #event:sectionClose sectionClose} event of this sap.ui.commons.Accordion
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Accordion
itself.
*
* Event is triggered when the user closes a section.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Accordion
itself
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
public attachSectionClose(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.Accordion;
/**
* Attaches event handler fnFunction
to the {@link #event:sectionOpen sectionOpen} event of this sap.ui.commons.Accordion
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Accordion
itself.
*
* Event is triggered when the user opens a section.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Accordion
itself
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
public attachSectionOpen(fnFunction: Function, oListener?: any): sap.ui.commons.Accordion;
/**
* Attaches event handler fnFunction
to the {@link #event:sectionOpen sectionOpen} event of this sap.ui.commons.Accordion
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Accordion
itself.
*
* Event is triggered when the user opens a section.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Accordion
itself
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
public attachSectionOpen(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.Accordion;
/**
* Attaches event handler fnFunction
to the {@link #event:sectionsReorder sectionsReorder} event of this sap.ui.commons.Accordion
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Accordion
itself.
*
* Event is triggered when the user changes the position of a section.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Accordion
itself
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
public attachSectionsReorder(fnFunction: Function, oListener?: any): sap.ui.commons.Accordion;
/**
* Attaches event handler fnFunction
to the {@link #event:sectionsReorder sectionsReorder} event of this sap.ui.commons.Accordion
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Accordion
itself.
*
* Event is triggered when the user changes the position of a section.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Accordion
itself
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
public attachSectionsReorder(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.Accordion;
/**
* Closes a section and opens the default one
* @param {string} sSectionId - Id of the section that is being closed
*/
public closeSection(sSectionId: string): void;
/**
* Destroys all the sections in the aggregation {@link #getSections sections}.
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
public destroySections(): sap.ui.commons.Accordion;
/**
* Detaches event handler fnFunction
from the {@link #event:sectionClose sectionClose} event of this sap.ui.commons.Accordion
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
public detachSectionClose(fnFunction: Function, oListener: any): sap.ui.commons.Accordion;
/**
* Detaches event handler fnFunction
from the {@link #event:sectionOpen sectionOpen} event of this sap.ui.commons.Accordion
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
public detachSectionOpen(fnFunction: Function, oListener: any): sap.ui.commons.Accordion;
/**
* Detaches event handler fnFunction
from the {@link #event:sectionsReorder sectionsReorder} event of this sap.ui.commons.Accordion
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
public detachSectionsReorder(fnFunction: Function, oListener: any): sap.ui.commons.Accordion;
/**
* Creates a new subclass of class sap.ui.commons.Accordion with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:sectionClose sectionClose} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
protected fireSectionClose(mParameters?: any): sap.ui.commons.Accordion;
/**
* Fires event {@link #event:sectionOpen sectionOpen} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
protected fireSectionOpen(mParameters?: any): sap.ui.commons.Accordion;
/**
* Fires event {@link #event:sectionsReorder sectionsReorder} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
protected fireSectionsReorder(mParameters?: any): sap.ui.commons.Accordion;
/**
* Returns a metadata object for class sap.ui.commons.Accordion.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getOpenedSectionsId openedSectionsId}.
*
* Section IDs that are opened by default at application start
* @returns {string} Value of property openedSectionsId
*/
public getOpenedSectionsId(): string;
/**
* Gets content of aggregation {@link #getSections sections}.
*
* Empty container used to display any library control
* @returns {sap.ui.commons.AccordionSection[]}
*/
public getSections(): sap.ui.commons.AccordionSection[];
/**
* Gets current value of property {@link #getWidth width}.
*
* When the specified width is less than the width of a section content, a horizontal scroll bar is provided.
*
* Default value is 200px
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.commons.AccordionSection
in the aggregation {@link #getSections sections}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.AccordionSection} oSection - The section whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSection(oSection: sap.ui.commons.AccordionSection): number;
/**
* Inserts a section into the aggregation {@link #getSections sections}.
* @param {sap.ui.commons.AccordionSection} oSection - the section to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the section should be inserted at; for a negative value of iIndex
, the section is inserted at position 0; for a value greater than the current size of the aggregation, the section is inserted at the last position
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
public insertSection(oSection: sap.ui.commons.AccordionSection, iIndex: number): sap.ui.commons.Accordion;
/**
* Opens a section
* @param {string} sSectionId - Id of the section that is being opened
*/
public openSection(sSectionId: string): void;
/**
* Removes all the controls from the aggregation {@link #getSections sections}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.AccordionSection[]} An array of the removed elements (might be empty)
*/
public removeAllSections(): sap.ui.commons.AccordionSection[];
/**
* Removes a section from the aggregation {@link #getSections sections}.
* @param {number|string|sap.ui.commons.AccordionSection} vSection - The section to remove or its index or id
* @returns {sap.ui.commons.AccordionSection} The removed section or null
*/
public removeSection(vSection: number|string|sap.ui.commons.AccordionSection): sap.ui.commons.AccordionSection;
/**
* Redefinition of the method to add additional handling
* @param {string} sOpenedSectionsId - New value for property openedSectionsId
* @returns {sap.ui.commons.Accordion} 'this' to allow method chaining
*/
public setOpenedSectionsId(sOpenedSectionsId: string): sap.ui.commons.Accordion;
/**
* Sets a new value for property {@link #getWidth width}.
*
* When the specified width is less than the width of a section content, a horizontal scroll bar is provided.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 200px
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.Accordion} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.Accordion;
}
/**
* Represents a panel which is a container for other controls. The container does not have any layout function.
*/
export class AccordionSection extends sap.ui.core.Element {
/**
* Constructor for a new AccordionSection.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.commons.AccordionSection} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.commons.AccordionSection;
/**
* Attaches event handler fnFunction
to the {@link #event:scroll scroll} event of this sap.ui.commons.AccordionSection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.AccordionSection
itself.
*
* Event is fired when the user scrolls the panel
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.AccordionSection
itself
* @returns {sap.ui.commons.AccordionSection} Reference to this
in order to allow method chaining
*/
public attachScroll(fnFunction: Function, oListener?: any): sap.ui.commons.AccordionSection;
/**
* Attaches event handler fnFunction
to the {@link #event:scroll scroll} event of this sap.ui.commons.AccordionSection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.AccordionSection
itself.
*
* Event is fired when the user scrolls the panel
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.AccordionSection
itself
* @returns {sap.ui.commons.AccordionSection} Reference to this
in order to allow method chaining
*/
public attachScroll(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.AccordionSection;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.commons.AccordionSection} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.commons.AccordionSection;
/**
* Detaches event handler fnFunction
from the {@link #event:scroll scroll} event of this sap.ui.commons.AccordionSection
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.AccordionSection} Reference to this
in order to allow method chaining
*/
public detachScroll(fnFunction: Function, oListener: any): sap.ui.commons.AccordionSection;
/**
* Creates a new subclass of class sap.ui.commons.AccordionSection with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:scroll scroll} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.AccordionSection} Reference to this
in order to allow method chaining
*/
protected fireScroll(mParameters?: any): sap.ui.commons.AccordionSection;
/**
* Gets current value of property {@link #getCollapsed collapsed}.
*
* It is recommended to adjust the settings for the width when the section is set to 'collapsed'.
*
* Default value is false
.
* @returns {boolean} Value of property collapsed
*/
public getCollapsed(): boolean;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Aggregates the controls that are contained in the panel. The control layout is browser-dependent.
* For a stable content layout, use a layout control as direct single child.
* When the panel dimensions are set, the child control may have width and height of 100%;
* when the panel dimensions are not set, the child defines the panel size.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* It is required that the used theme supports the control.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getMaxHeight maxHeight}.
*
* When the section content exceeds maxHeight, a vertical scroll bar appears.
* @returns {sap.ui.core.CSSSize} Value of property maxHeight
*/
public getMaxHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.commons.AccordionSection.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTitle title}.
*
* Text for the section header
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.commons.AccordionSection} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.commons.AccordionSection;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Property setter for the "collapsed" state
* @param {boolean} bCollapsed - Whether the AccordionSection is collapsed or not
* @returns {sap.ui.commons.AccordionSection} 'this' to allow method chaining
*/
public setCollapsed(bCollapsed: boolean): sap.ui.commons.AccordionSection;
/**
* Property setter for the "enabled" state
* @param {boolean} bEnabled - Whether the AccordionSection is enabled or not
* @returns {sap.ui.commons.AccordionSection} 'this' to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.AccordionSection;
/**
* Sets a new value for property {@link #getMaxHeight maxHeight}.
*
* When the section content exceeds maxHeight, a vertical scroll bar appears.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sMaxHeight - New value for property maxHeight
* @returns {sap.ui.commons.AccordionSection} Reference to this
in order to allow method chaining
*/
public setMaxHeight(sMaxHeight: sap.ui.core.CSSSize): sap.ui.commons.AccordionSection;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Text for the section header
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.commons.AccordionSection} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.commons.AccordionSection;
}
/**
* The application header control stands on the top of any application page. It consists of 4 areas: Logo area, Function area provided by application, Search area, Logout area.
*/
export class ApplicationHeader extends sap.ui.core.Control {
/**
* Constructor for a new ApplicationHeader.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:logoff logoff} event of this sap.ui.commons.ApplicationHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.ApplicationHeader
itself.
*
* Fires an event to log off the user from the application.
* No parameters.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.ApplicationHeader
itself
* @returns {sap.ui.commons.ApplicationHeader} Reference to this
in order to allow method chaining
*/
public attachLogoff(fnFunction: Function, oListener?: any): sap.ui.commons.ApplicationHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:logoff logoff} event of this sap.ui.commons.ApplicationHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.ApplicationHeader
itself.
*
* Fires an event to log off the user from the application.
* No parameters.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.ApplicationHeader
itself
* @returns {sap.ui.commons.ApplicationHeader} Reference to this
in order to allow method chaining
*/
public attachLogoff(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.ApplicationHeader;
/**
* Detaches event handler fnFunction
from the {@link #event:logoff logoff} event of this sap.ui.commons.ApplicationHeader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.ApplicationHeader} Reference to this
in order to allow method chaining
*/
public detachLogoff(fnFunction: Function, oListener: any): sap.ui.commons.ApplicationHeader;
/**
* Creates a new subclass of class sap.ui.commons.ApplicationHeader with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:logoff logoff} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.ApplicationHeader} Reference to this
in order to allow method chaining
*/
protected fireLogoff(mParameters?: any): sap.ui.commons.ApplicationHeader;
/**
* Gets current value of property {@link #getDisplayLogoff displayLogoff}.
*
* Determines if the logoff area will be displayed at the right hand side of the application header.
*
* Default value is true
.
* @returns {boolean} Value of property displayLogoff
*/
public getDisplayLogoff(): boolean;
/**
* Gets current value of property {@link #getDisplayWelcome displayWelcome}.
*
* Determines if the welcome text is displayed
*
* Default value is true
.
* @returns {boolean} Value of property displayWelcome
*/
public getDisplayWelcome(): boolean;
/**
* Gets current value of property {@link #getLogoSrc logoSrc}.
*
* Path (src) to the logo icon to be displayed in the application header.
* @returns {sap.ui.core.URI} Value of property logoSrc
*/
public getLogoSrc(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getLogoText logoText}.
*
* The text that will be displayed beside the logo in the application header. This property is optional.
* @returns {string} Value of property logoText
*/
public getLogoText(): string;
/**
* Returns a metadata object for class sap.ui.commons.ApplicationHeader.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getUserName userName}.
*
* User name that will be displayed beside the welcome text
* @returns {string} Value of property userName
*/
public getUserName(): string;
/**
* Sets a new value for property {@link #getDisplayLogoff displayLogoff}.
*
* Determines if the logoff area will be displayed at the right hand side of the application header.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bDisplayLogoff - New value for property displayLogoff
* @returns {sap.ui.commons.ApplicationHeader} Reference to this
in order to allow method chaining
*/
public setDisplayLogoff(bDisplayLogoff: boolean): sap.ui.commons.ApplicationHeader;
/**
* Sets a new value for property {@link #getDisplayWelcome displayWelcome}.
*
* Determines if the welcome text is displayed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bDisplayWelcome - New value for property displayWelcome
* @returns {sap.ui.commons.ApplicationHeader} Reference to this
in order to allow method chaining
*/
public setDisplayWelcome(bDisplayWelcome: boolean): sap.ui.commons.ApplicationHeader;
/**
* Sets a new value for property {@link #getLogoSrc logoSrc}.
*
* Path (src) to the logo icon to be displayed in the application header.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sLogoSrc - New value for property logoSrc
* @returns {sap.ui.commons.ApplicationHeader} Reference to this
in order to allow method chaining
*/
public setLogoSrc(sLogoSrc: sap.ui.core.URI): sap.ui.commons.ApplicationHeader;
/**
* Sets a new value for property {@link #getLogoText logoText}.
*
* The text that will be displayed beside the logo in the application header. This property is optional.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sLogoText - New value for property logoText
* @returns {sap.ui.commons.ApplicationHeader} Reference to this
in order to allow method chaining
*/
public setLogoText(sLogoText: string): sap.ui.commons.ApplicationHeader;
/**
* Sets a new value for property {@link #getUserName userName}.
*
* User name that will be displayed beside the welcome text
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sUserName - New value for property userName
* @returns {sap.ui.commons.ApplicationHeader} Reference to this
in order to allow method chaining
*/
public setUserName(sUserName: string): sap.ui.commons.ApplicationHeader;
}
/**
* Used for defining areas in an image map. At runtime, the user can trigger an action, or start a URL, from the single image areas.
*/
export class Area extends sap.ui.core.Element {
/**
* Constructor for a new Area.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.Area with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAlt alt}.
*
* Alternative text that is displayed in the case the image is not available
* @returns {string} Value of property alt
*/
public getAlt(): string;
/**
* Gets current value of property {@link #getCoords coords}.
*
* Coordinates of the area
* @returns {string} Value of property coords
*/
public getCoords(): string;
/**
* Gets current value of property {@link #getHref href}.
*
* Hyper link that is executed when the area is clicked
* @returns {sap.ui.core.URI} Value of property href
*/
public getHref(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.ui.commons.Area.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShape shape}.
*
* The value is a string and can be 'rect' for rectangle, 'poly' for poligon, 'circle', or default.
* @returns {string} Value of property shape
*/
public getShape(): string;
/**
* Sets a new value for property {@link #getAlt alt}.
*
* Alternative text that is displayed in the case the image is not available
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAlt - New value for property alt
* @returns {sap.ui.commons.Area} Reference to this
in order to allow method chaining
*/
public setAlt(sAlt: string): sap.ui.commons.Area;
/**
* Sets a new value for property {@link #getCoords coords}.
*
* Coordinates of the area
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sCoords - New value for property coords
* @returns {sap.ui.commons.Area} Reference to this
in order to allow method chaining
*/
public setCoords(sCoords: string): sap.ui.commons.Area;
/**
* Sets a new value for property {@link #getHref href}.
*
* Hyper link that is executed when the area is clicked
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sHref - New value for property href
* @returns {sap.ui.commons.Area} Reference to this
in order to allow method chaining
*/
public setHref(sHref: sap.ui.core.URI): sap.ui.commons.Area;
/**
* Sets a new value for property {@link #getShape shape}.
*
* The value is a string and can be 'rect' for rectangle, 'poly' for poligon, 'circle', or default.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sShape - New value for property shape
* @returns {sap.ui.commons.Area} Reference to this
in order to allow method chaining
*/
public setShape(sShape: string): sap.ui.commons.Area;
}
/**
* Textfield with list based text completion.
*/
export class AutoComplete extends sap.ui.commons.ComboBox {
/**
* Constructor for a new AutoComplete.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:suggest suggest} event of this sap.ui.commons.AutoComplete
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.AutoComplete
itself.
*
* Fired when the user has changed the value and a suggestion list update should occur.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.AutoComplete
itself
* @returns {sap.ui.commons.AutoComplete} Reference to this
in order to allow method chaining
*/
public attachSuggest(fnFunction: Function, oListener?: any): sap.ui.commons.AutoComplete;
/**
* Attaches event handler fnFunction
to the {@link #event:suggest suggest} event of this sap.ui.commons.AutoComplete
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.AutoComplete
itself.
*
* Fired when the user has changed the value and a suggestion list update should occur.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.AutoComplete
itself
* @returns {sap.ui.commons.AutoComplete} Reference to this
in order to allow method chaining
*/
public attachSuggest(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.AutoComplete;
/**
* Detaches event handler fnFunction
from the {@link #event:suggest suggest} event of this sap.ui.commons.AutoComplete
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.AutoComplete} Reference to this
in order to allow method chaining
*/
public detachSuggest(fnFunction: Function, oListener: any): sap.ui.commons.AutoComplete;
/**
* Creates a new subclass of class sap.ui.commons.AutoComplete with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.commons.ComboBox.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:suggest suggest} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.AutoComplete} Reference to this
in order to allow method chaining
*/
protected fireSuggest(mParameters?: any): sap.ui.commons.AutoComplete;
/**
* Gets current value of property {@link #getEnableScrolling enableScrolling}.
*
* Determines whether scrolling should be enabled when the number of items is higher than maxPopupItems.
* If set to false only the first n items (n=maxPopupItems) are shown.
*
* Default value is true
.
* @returns {boolean} Value of property enableScrolling
*/
public getEnableScrolling(): boolean;
/**
* @returns {sap.ui.core.ID}
*/
public getListBox(): sap.ui.core.ID;
/**
* Returns a metadata object for class sap.ui.commons.AutoComplete.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* @returns {string}
*/
public getSelectedItemId(): string;
/**
* @returns {string}
*/
public getSelectedKey(): string;
/**
* Sets a new value for property {@link #getEnableScrolling enableScrolling}.
*
* Determines whether scrolling should be enabled when the number of items is higher than maxPopupItems.
* If set to false only the first n items (n=maxPopupItems) are shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableScrolling - New value for property enableScrolling
* @returns {sap.ui.commons.AutoComplete} Reference to this
in order to allow method chaining
*/
public setEnableScrolling(bEnableScrolling: boolean): sap.ui.commons.AutoComplete;
/**
* Sets a custom filter function for items. Default is to check whether the item text begins with the typed value.
*
* Example:
*
* function(sValue, oItem){
* return jQuery.sap.startsWithIgnoreCase(oItem.getText(), sValue);
* }
*
* @param {Function} fFilter - The filter function. If not set the default filter function will be used.
*/
public setFilterFunction(fFilter?: Function): void;
/**
* @returns {sap.ui.commons.AutoComplete}
*/
public setListBox(): sap.ui.commons.AutoComplete;
/**
* @returns {sap.ui.commons.AutoComplete}
*/
public setSelectedItemId(): sap.ui.commons.AutoComplete;
/**
* @returns {sap.ui.commons.AutoComplete}
*/
public setSelectedKey(): sap.ui.commons.AutoComplete;
}
/**
* Enables users to trigger actions such as save or print. For the button UI, you can define some text or an icon, or both.
*/
export class Button extends sap.ui.core.Control {
/**
* Constructor for a new Button.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.Button;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.Button;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.commons.Button
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Button
itself.
*
* Event is fired when the user presses the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Button
itself
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.ui.commons.Button;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.commons.Button
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Button
itself.
*
* Event is fired when the user presses the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Button
itself
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.Button;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.ui.commons.Button
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.ui.commons.Button;
/**
* Creates a new subclass of class sap.ui.commons.Button with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.ui.commons.Button;
/**
* Puts the focus to the button.
*/
public focus(): void;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Boolean property to enable the control (default is true). Buttons that are disabled have other colors than enabled ones, depending on custom settings.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* Specifies the button height. If this property is set, the height which is specified by the underlying theme is not used any longer.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getHelpId helpId}.
*
* Unique identifier used for help service
*
* Default value is
.
* @returns {string} Value of property helpId
*/
public getHelpId(): string;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Icon to be displayed as graphical element within the button.
* This can be a URI to an image or an icon font URI.
*
* Default value is
.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconFirst iconFirst}.
*
* If set to true (default), the display sequence is 1. icon 2. control text .
*
* Default value is true
.
* @returns {boolean} Value of property iconFirst
*/
public getIconFirst(): boolean;
/**
* Gets current value of property {@link #getIconHovered iconHovered}.
*
* Icon to be displayed as graphical element within the button when it is hovered (only if also a base icon was specified). If not specified the base icon is used.
* If an icon font icon is used, this property is ignored.
*
* Default value is
.
* @returns {sap.ui.core.URI} Value of property iconHovered
*/
public getIconHovered(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconSelected iconSelected}.
*
* Icon to be displayed as graphical element within the button when it is selected (only if also a base icon was specified). If not specified the base or hovered icon is used.
* If an icon font icon is used, this property is ignored.
*
* Default value is
.
* @returns {sap.ui.core.URI} Value of property iconSelected
*/
public getIconSelected(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getLite lite}.
*
* The button is rendered as lite button.
*
* Default value is false
.
* @returns {boolean} Value of property lite
*/
public getLite(): boolean;
/**
* Returns a metadata object for class sap.ui.commons.Button.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getStyle style}.
*
* Style of the button.
* (e.g. emphasized)
*
* Default value is Default
.
* @returns {sap.ui.commons.ButtonStyle} Value of property style
*/
public getStyle(): sap.ui.commons.ButtonStyle;
/**
* Gets current value of property {@link #getStyled styled}.
*
* Indicates if the button is styled. If not it is rendered as native HTML-button. In this case a custom styling can be added usig addStyleClass.
*
* Default value is true
.
* @returns {boolean} Value of property styled
*/
public getStyled(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* Button text displayed at runtime.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Control width as common CSS-size (px or % as unit, for example)
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Boolean property to enable the control (default is true). Buttons that are disabled have other colors than enabled ones, depending on custom settings.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.Button;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Specifies the button height. If this property is set, the height which is specified by the underlying theme is not used any longer.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.Button;
/**
* Sets a new value for property {@link #getHelpId helpId}.
*
* Unique identifier used for help service
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sHelpId - New value for property helpId
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public setHelpId(sHelpId: string): sap.ui.commons.Button;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Icon to be displayed as graphical element within the button.
* This can be a URI to an image or an icon font URI.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.commons.Button;
/**
* Sets a new value for property {@link #getIconFirst iconFirst}.
*
* If set to true (default), the display sequence is 1. icon 2. control text .
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconFirst - New value for property iconFirst
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public setIconFirst(bIconFirst: boolean): sap.ui.commons.Button;
/**
* Sets a new value for property {@link #getIconHovered iconHovered}.
*
* Icon to be displayed as graphical element within the button when it is hovered (only if also a base icon was specified). If not specified the base icon is used.
* If an icon font icon is used, this property is ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.URI} sIconHovered - New value for property iconHovered
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public setIconHovered(sIconHovered: sap.ui.core.URI): sap.ui.commons.Button;
/**
* Sets a new value for property {@link #getIconSelected iconSelected}.
*
* Icon to be displayed as graphical element within the button when it is selected (only if also a base icon was specified). If not specified the base or hovered icon is used.
* If an icon font icon is used, this property is ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.URI} sIconSelected - New value for property iconSelected
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public setIconSelected(sIconSelected: sap.ui.core.URI): sap.ui.commons.Button;
/**
* Sets a new value for property {@link #getLite lite}.
*
* The button is rendered as lite button.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bLite - New value for property lite
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public setLite(bLite: boolean): sap.ui.commons.Button;
/**
* Sets a new value for property {@link #getStyle style}.
*
* Style of the button.
* (e.g. emphasized)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Default
.
* @param {sap.ui.commons.ButtonStyle} sStyle - New value for property style
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public setStyle(sStyle: sap.ui.commons.ButtonStyle): sap.ui.commons.Button;
/**
* Sets a new value for property {@link #getStyled styled}.
*
* Indicates if the button is styled. If not it is rendered as native HTML-button. In this case a custom styling can be added usig addStyleClass.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bStyled - New value for property styled
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public setStyled(bStyled: boolean): sap.ui.commons.Button;
/**
* Sets a new value for property {@link #getText text}.
*
* Button text displayed at runtime.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sText - New value for property text
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.commons.Button;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Control width as common CSS-size (px or % as unit, for example)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.Button} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.Button;
}
/**
* different styles for a button.
*/
export enum ButtonStyle {
/**
* Accept button (normally green).
*/
Accept = "Accept",
/**
* default style (no special styling).
*/
Default = "Default",
/**
* Button is emphasized.
*/
Emph = "Emph",
/**
* Reject button (normally red).
*/
Reject = "Reject",
}
/**
* Callout is a small popup with some useful information and links that is shown when a mouse is hovered over a specific view element.
*/
export class Callout extends sap.ui.commons.CalloutBase {
/**
* Constructor for a new Callout.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Callout} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.commons.Callout;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.commons.Callout} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.commons.Callout;
/**
* Creates a new subclass of class sap.ui.commons.Callout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.commons.CalloutBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Determines the content of the Callout
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.ui.commons.Callout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.commons.Callout} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.commons.Callout;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
}
/**
* CalloutBase is a building block for Callout. Do not use it directly. Use the Callout control instead
*/
export class CalloutBase extends sap.ui.core.TooltipBase {
/**
* Constructor for a new CalloutBase.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adjust position of the already opened Callout window.
* Call this method each time when the size of the opened
* Callout window may be changed due to new or changed
* contents.
*/
public adjustPosition(): void;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.ui.commons.CalloutBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.CalloutBase
itself.
*
* Event is fired before a Callout is displayed. Call the preventDefault method of the event object to postpone opening. Application may use this event to start asynchronous Ajax call to load the Callout content
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.CalloutBase
itself
* @returns {sap.ui.commons.CalloutBase} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(fnFunction: Function, oListener?: any): sap.ui.commons.CalloutBase;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeOpen beforeOpen} event of this sap.ui.commons.CalloutBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.CalloutBase
itself.
*
* Event is fired before a Callout is displayed. Call the preventDefault method of the event object to postpone opening. Application may use this event to start asynchronous Ajax call to load the Callout content
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.CalloutBase
itself
* @returns {sap.ui.commons.CalloutBase} Reference to this
in order to allow method chaining
*/
public attachBeforeOpen(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.CalloutBase;
/**
* Attaches event handler fnFunction
to the {@link #event:close close} event of this sap.ui.commons.CalloutBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.CalloutBase
itself.
*
* Event is fired when the Callout window is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.CalloutBase
itself
* @returns {sap.ui.commons.CalloutBase} Reference to this
in order to allow method chaining
*/
public attachClose(fnFunction: Function, oListener?: any): sap.ui.commons.CalloutBase;
/**
* Attaches event handler fnFunction
to the {@link #event:close close} event of this sap.ui.commons.CalloutBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.CalloutBase
itself.
*
* Event is fired when the Callout window is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.CalloutBase
itself
* @returns {sap.ui.commons.CalloutBase} Reference to this
in order to allow method chaining
*/
public attachClose(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.CalloutBase;
/**
* Attaches event handler fnFunction
to the {@link #event:open open} event of this sap.ui.commons.CalloutBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.CalloutBase
itself.
*
* The event is fired when the popup is opened.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.CalloutBase
itself
* @returns {sap.ui.commons.CalloutBase} Reference to this
in order to allow method chaining
*/
public attachOpen(fnFunction: Function, oListener?: any): sap.ui.commons.CalloutBase;
/**
* Attaches event handler fnFunction
to the {@link #event:open open} event of this sap.ui.commons.CalloutBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.CalloutBase
itself.
*
* The event is fired when the popup is opened.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.CalloutBase
itself
* @returns {sap.ui.commons.CalloutBase} Reference to this
in order to allow method chaining
*/
public attachOpen(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.CalloutBase;
/**
* Attaches event handler fnFunction
to the {@link #event:opened opened} event of this sap.ui.commons.CalloutBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.CalloutBase
itself.
*
* Is fired when the Callout has been opened
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.CalloutBase
itself
* @returns {sap.ui.commons.CalloutBase} Reference to this
in order to allow method chaining
*/
public attachOpened(fnFunction: Function, oListener?: any): sap.ui.commons.CalloutBase;
/**
* Attaches event handler fnFunction
to the {@link #event:opened opened} event of this sap.ui.commons.CalloutBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.CalloutBase
itself.
*
* Is fired when the Callout has been opened
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.CalloutBase
itself
* @returns {sap.ui.commons.CalloutBase} Reference to this
in order to allow method chaining
*/
public attachOpened(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.CalloutBase;
/**
* Closes Callout
*/
public close(): void;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeOpen beforeOpen} event of this sap.ui.commons.CalloutBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.CalloutBase} Reference to this
in order to allow method chaining
*/
public detachBeforeOpen(fnFunction: Function, oListener: any): sap.ui.commons.CalloutBase;
/**
* Detaches event handler fnFunction
from the {@link #event:close close} event of this sap.ui.commons.CalloutBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.CalloutBase} Reference to this
in order to allow method chaining
*/
public detachClose(fnFunction: Function, oListener: any): sap.ui.commons.CalloutBase;
/**
* Detaches event handler fnFunction
from the {@link #event:open open} event of this sap.ui.commons.CalloutBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.CalloutBase} Reference to this
in order to allow method chaining
*/
public detachOpen(fnFunction: Function, oListener: any): sap.ui.commons.CalloutBase;
/**
* Detaches event handler fnFunction
from the {@link #event:opened opened} event of this sap.ui.commons.CalloutBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.CalloutBase} Reference to this
in order to allow method chaining
*/
public detachOpened(fnFunction: Function, oListener: any): sap.ui.commons.CalloutBase;
/**
* Creates a new subclass of class sap.ui.commons.CalloutBase with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.TooltipBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:beforeOpen beforeOpen} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireBeforeOpen(mParameters?: any): boolean;
/**
* Fires event {@link #event:close close} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.CalloutBase} Reference to this
in order to allow method chaining
*/
protected fireClose(mParameters?: any): sap.ui.commons.CalloutBase;
/**
* Fires event {@link #event:open open} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.CalloutBase} Reference to this
in order to allow method chaining
*/
protected fireOpen(mParameters?: any): sap.ui.commons.CalloutBase;
/**
* Fires event {@link #event:opened opened} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.CalloutBase} Reference to this
in order to allow method chaining
*/
protected fireOpened(mParameters?: any): sap.ui.commons.CalloutBase;
/**
* Returns a metadata object for class sap.ui.commons.CalloutBase.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Set position of the Callout window relative to the parent control.
* This function automatically calculates and sets the correct offset,
* use it instead of setMyPosition/setAtPosition
.
* @param {sap.ui.core.Dock} myPosition - docking position of the Callout
* @param {sap.ui.core.Dock} atPosition - docking position of the parent control
* @returns {sap.ui.commons.CalloutBase} this
to allow method chaining
*/
public setPosition(myPosition: sap.ui.core.Dock, atPosition: sap.ui.core.Dock): sap.ui.commons.CalloutBase;
}
/**
* Carousel holds multiple controls and displays them vertically or horizontally next to each other. You can define how many content items should be displayed at once or let the Carousel determine that for you. Navigation is done through buttons or keys.
*/
export class Carousel extends sap.ui.core.Control {
/**
* Constructor for a new Carousel.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {Object} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: Object);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Carousel} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.commons.Carousel;
/**
* Binds aggregation {@link #getContent content} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.commons.Carousel} Reference to this
in order to allow method chaining
*/
public bindContent(oBindingInfo: any): sap.ui.commons.Carousel;
/**
* Calculates and sets the size of the carousel, its items and its buttons
*/
public calculateAndSetSize(): void;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.commons.Carousel} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.commons.Carousel;
/**
* Creates a new subclass of class sap.ui.commons.Carousel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAnimationDuration animationDuration}.
*
* Duration for animation when navigating through the contents of the Carousel
*
* Default value is 500
.
* @returns {number} Value of property animationDuration
*/
public getAnimationDuration(): number;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Controls which are displayed inside the Carousel
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getDefaultItemHeight defaultItemHeight}.
*
* Default height of the item in a carousel if no height can be determined
*
* Default value is 150
.
* @returns {number} Value of property defaultItemHeight
*/
public getDefaultItemHeight(): number;
/**
* Gets current value of property {@link #getDefaultItemWidth defaultItemWidth}.
*
* Default width of the item in a carousel if no height can be determined
*
* Default value is 150
.
* @returns {number} Value of property defaultItemWidth
*/
public getDefaultItemWidth(): number;
/**
* Gets current value of property {@link #getFirstVisibleIndex firstVisibleIndex}.
*
* The index of the element in the content aggreation which is displayed first on rendering
*
* Default value is 0
.
* @returns {number} Value of property firstVisibleIndex
*/
public getFirstVisibleIndex(): number;
/**
* Returns the focused DOM element
* @returns {HTMLElement} The focused DOM element
*/
public getFocusDomRef(): HTMLElement;
/**
* Gets current value of property {@link #getHandleSize handleSize}.
*
* Determines the size of the handle in pixels. (Height for vertical carousel, width for horizontal carousel)
*
* Default value is 22
.
* @returns {number} Value of property handleSize
*/
public getHandleSize(): number;
/**
* Gets current value of property {@link #getHeight height}.
*
* Determines the height of the Carousel
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.commons.Carousel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getOrientation orientation}.
*
* Determines the orientation of the Carousel. Can be either "horizontal" or "vertical"
*
* Default value is horizontal
.
* @returns {sap.ui.commons.enums.Orientation} Value of property orientation
*/
public getOrientation(): sap.ui.commons.enums.Orientation;
/**
* Gets current value of property {@link #getVisibleItems visibleItems}.
*
* If defined, the carousel displays the number of items defined. Items will be resized to fit the area.
* @returns {number} Value of property visibleItems
*/
public getVisibleItems(): number;
/**
* Gets current value of property {@link #getWidth width}.
*
* Determines the width of the Carousel
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.commons.Carousel} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.commons.Carousel;
/**
* If the device supports touch gestures and left swipe is triggered shows the next carousel item
* @param {JQueryEventObject} oEvent
*/
public onswipeleft(oEvent: JQueryEventObject): void;
/**
* If the device supports touch gestures and right swipe is triggered shows the previous carousel item
* @param {JQueryEventObject} oEvent
*/
public onswiperight(oEvent: JQueryEventObject): void;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getAnimationDuration animationDuration}.
*
* Duration for animation when navigating through the contents of the Carousel
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 500
.
* @param {number} iAnimationDuration - New value for property animationDuration
* @returns {sap.ui.commons.Carousel} Reference to this
in order to allow method chaining
*/
public setAnimationDuration(iAnimationDuration: number): sap.ui.commons.Carousel;
/**
* Sets a new value for property {@link #getDefaultItemHeight defaultItemHeight}.
*
* Default height of the item in a carousel if no height can be determined
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 150
.
* @param {number} iDefaultItemHeight - New value for property defaultItemHeight
* @returns {sap.ui.commons.Carousel} Reference to this
in order to allow method chaining
*/
public setDefaultItemHeight(iDefaultItemHeight: number): sap.ui.commons.Carousel;
/**
* Sets a new value for property {@link #getDefaultItemWidth defaultItemWidth}.
*
* Default width of the item in a carousel if no height can be determined
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 150
.
* @param {number} iDefaultItemWidth - New value for property defaultItemWidth
* @returns {sap.ui.commons.Carousel} Reference to this
in order to allow method chaining
*/
public setDefaultItemWidth(iDefaultItemWidth: number): sap.ui.commons.Carousel;
/**
* Setter for property firstVisibleIndex
.
*
* Default value is 0
* @param {number} iFirstVisibleIndex - new value for property firstVisibleIndex
* @returns {sap.ui.commons.Carousel} this
to allow method chaining
*/
public setFirstVisibleIndex(iFirstVisibleIndex: number): sap.ui.commons.Carousel;
/**
* Sets a new value for property {@link #getHandleSize handleSize}.
*
* Determines the size of the handle in pixels. (Height for vertical carousel, width for horizontal carousel)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 22
.
* @param {number} iHandleSize - New value for property handleSize
* @returns {sap.ui.commons.Carousel} Reference to this
in order to allow method chaining
*/
public setHandleSize(iHandleSize: number): sap.ui.commons.Carousel;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Determines the height of the Carousel
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.commons.Carousel} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.Carousel;
/**
* Sets a new value for property {@link #getOrientation orientation}.
*
* Determines the orientation of the Carousel. Can be either "horizontal" or "vertical"
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is horizontal
.
* @param {sap.ui.commons.enums.Orientation} sOrientation - New value for property orientation
* @returns {sap.ui.commons.Carousel} Reference to this
in order to allow method chaining
*/
public setOrientation(sOrientation: sap.ui.commons.enums.Orientation): sap.ui.commons.Carousel;
/**
* Sets a new value for property {@link #getVisibleItems visibleItems}.
*
* If defined, the carousel displays the number of items defined. Items will be resized to fit the area.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iVisibleItems - New value for property visibleItems
* @returns {sap.ui.commons.Carousel} Reference to this
in order to allow method chaining
*/
public setVisibleItems(iVisibleItems: number): sap.ui.commons.Carousel;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Determines the width of the Carousel
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.Carousel} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.Carousel;
/**
* Shows the element with the specified Id. This can be only used after the component is rendered.
* @param {string} sElementId - Id of the element to slide to.
*/
public showElementWithId(sElementId: string): void;
/**
* Shows the next item in carousel. This can be only used after the component is rendered.
*/
public showNext(): void;
/**
* Shows the previous item in carousel. This can be only used after the component is rendered.
*/
public showPrevious(): void;
/**
* Unbinds aggregation {@link #getContent content} from model data.
* @returns {sap.ui.commons.Carousel} Reference to this
in order to allow method chaining
*/
public unbindContent(): sap.ui.commons.Carousel;
}
/**
* Provides a box which can be flagged, the box has a label. A check box can either stand alone, or in a group with other check boxes. As an option, the boxes can initially be set to status 'Not Editable'.
*/
export class CheckBox extends sap.ui.core.Control {
/**
* Constructor for a new CheckBox.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.CheckBox;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.CheckBox;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.commons.CheckBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.CheckBox
itself.
*
* Event is triggered when the control status is changed by the user by flagging or unflagging the checkbox.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.CheckBox
itself
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.ui.commons.CheckBox;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.commons.CheckBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.CheckBox
itself.
*
* Event is triggered when the control status is changed by the user by flagging or unflagging the checkbox.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.CheckBox
itself
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.CheckBox;
/**
* Binds property {@link #getChecked checked} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a
* detailed description of the possible properties of oBindingInfo
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
public bindChecked(oBindingInfo: any): sap.ui.commons.CheckBox;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.ui.commons.CheckBox
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.ui.commons.CheckBox;
/**
* Creates a new subclass of class sap.ui.commons.CheckBox with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.ui.commons.CheckBox;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getChecked checked}.
*
* Contains the state of the control whether it is flagged with a check mark, or not
*
* Default value is false
.
* @returns {boolean} Value of property checked
*/
public getChecked(): boolean;
/**
* Gets current value of property {@link #getEditable editable}.
*
* Specifies whether the user shall be allowed to select the check box.
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Using this property, the control could be disabled, if required.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Returns a metadata object for class sap.ui.commons.CheckBox.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* The 'name' property to be used in the HTML code, for example for HTML forms that send data to the server via submit.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets current value of property {@link #getText text}.
*
* Defines the text displayed next to the check box
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* The value can be set to LTR or RTL. Otherwise, the control inherits the text direction from its parent control.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Accepts the core enumeration ValueState.type that supports 'None', 'Error', 'Warning' and 'Success'.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getWidth width}.
*
* The width can be set to an absolute value. If no value is set, the control width results from the text length.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getChecked checked}.
*
* Contains the state of the control whether it is flagged with a check mark, or not
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bChecked - New value for property checked
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
public setChecked(bChecked: boolean): sap.ui.commons.CheckBox;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Specifies whether the user shall be allowed to select the check box.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.ui.commons.CheckBox;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Using this property, the control could be disabled, if required.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.CheckBox;
/**
* Sets a new value for property {@link #getName name}.
*
* The 'name' property to be used in the HTML code, for example for HTML forms that send data to the server via submit.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.ui.commons.CheckBox;
/**
* Sets a new value for property {@link #getText text}.
*
* Defines the text displayed next to the check box
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.commons.CheckBox;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* The value can be set to LTR or RTL. Otherwise, the control inherits the text direction from its parent control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.ui.commons.CheckBox;
/**
* Sets a new value for property {@link #getValueState valueState}.
*
* Accepts the core enumeration ValueState.type that supports 'None', 'Error', 'Warning' and 'Success'.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sValueState - New value for property valueState
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
public setValueState(sValueState: sap.ui.core.ValueState): sap.ui.commons.CheckBox;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The width can be set to an absolute value. If no value is set, the control width results from the text length.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.CheckBox;
/**
* Inverts the current value of the control.
* @returns {sap.ui.commons.CheckBox}
*/
public toggle(): sap.ui.commons.CheckBox;
/**
* Unbinds property {@link #getChecked checked} from model data.
* @returns {sap.ui.commons.CheckBox} Reference to this
in order to allow method chaining
*/
public unbindChecked(): sap.ui.commons.CheckBox;
}
/**
* This control gives the user the opportunity to choose a color. The color can be defined using HEX-, RGB- or HSV-values or a CSS colorname.
*/
export class ColorPicker extends sap.ui.core.Control {
/**
* Constructor for a new ColorPicker.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.ColorPicker with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.ColorPicker.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* different styles for a ColorPicker.
*/
export enum ColorPickerMode {
}
/**
* The control provides a field that allows end users to either enter some text, or to choose an entry out of a list of pre-defined items.
* The choosable items can be provided in the form of a complete ListBox
, single ListItems
.
*/
export class ComboBox extends sap.ui.commons.TextField {
/**
* Constructor for a new ComboBox.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Compares the previous value with the current value and fires the "Change" event
* if the ComboBox is editable and the value has changed or whether the value has been changed
* e.g. via up/down or auto-complete feature
* @param {JQueryEventObject} oEvent - The event object.
* @param {boolean} bImmediate - indicate whether the check should happen immediately or delayed (e.g. to avoid focusout / click double event processing)
*/
protected _checkChange(oEvent: JQueryEventObject, bImmediate?: boolean): void;
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.ui.core.ListItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.ui.commons.ComboBox} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.ui.core.ListItem): sap.ui.commons.ComboBox;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.commons.ComboBox} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.ui.commons.ComboBox;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.ui.commons.ComboBox} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.ui.commons.ComboBox;
/**
* Creates a new subclass of class sap.ui.commons.ComboBox with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.commons.TextField.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event change to attached listeners.
*
* Expects following event parameters:
*
* - 'newValue' of type
string
The new / changed value of the textfield.
* - 'selectedItem' of type
sap.ui.core.ListItem
selected item
*
* @param {{ [key: string]: any }} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.commons.ComboBox} this
to allow method chaining
*/
protected fireChange(mArguments?: { [key: string]: any }): sap.ui.commons.ComboBox;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getDisplaySecondaryValues displaySecondaryValues}.
*
* Indicates whether the additionalText
property that is available for sap.ui.core.ListItem
shall be displayed in the list.
*
* Default value is false
.
* @returns {boolean} Value of property displaySecondaryValues
*/
public getDisplaySecondaryValues(): boolean;
/**
* Returns the DomRef which represents the icon for value help.
* Could be overwritten in child-classes
* @returns {Element} The F4-element's DOM reference or null
*/
protected getF4ButtonDomRef(): Element;
/**
* Gets content of aggregation {@link #getItems items}.
*
* ListItems
(see sap.ui.core.ListBox
) that shall be displayed in the list.
* @returns {sap.ui.core.ListItem[]}
*/
public getItems(): sap.ui.core.ListItem[];
/**
* ID of the element which is the current target of the association {@link #getListBox listBox}, or null
.
* @returns {sap.ui.core.ID}
*/
public getListBox(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getMaxPopupItems maxPopupItems}.
*
* Defines the number of items that shall be displayed at once. If the overall number of items is higher than this setting, a scrollbar is provided.
*
* Default value is 10
.
* @returns {number} Value of property maxPopupItems
*/
public getMaxPopupItems(): number;
/**
* Returns a metadata object for class sap.ui.commons.ComboBox.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSelectedItemId selectedItemId}.
*
* Id of the selected item. If the value has no corresponding item, the selectedItemId
is empty.
*
* If the selectedItemId
is set to a not existing item, it will not be changed.
* @returns {string} Value of property selectedItemId
*/
public getSelectedItemId(): string;
/**
* Gets current value of property {@link #getSelectedKey selectedKey}.
*
* Key of the selected item.
*
* If the value has no corresponding item the key is empty.
*
* If duplicate keys exists the first item matching the key is used.
*
* If the key is set to a not existing value it will not be changed.
* @returns {string} Value of property selectedKey
*/
public getSelectedKey(): string;
/**
* Checks for the provided sap.ui.core.ListItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.ListItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.core.ListItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.ui.core.ListItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.ui.commons.ComboBox} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.ui.core.ListItem, iIndex: number): sap.ui.commons.ComboBox;
/**
* Handle sapenter pseudo events on the control
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onsapenter(oEvent: JQueryEventObject): void;
/**
* Handle sapescape pseudo events on the control
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onsapescape(oEvent: JQueryEventObject): void;
/**
* Handle saphide pseudo events on the control
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onsaphide(oEvent: JQueryEventObject): void;
/**
* Handle sapnextmodifiers pseudo events on the control
* if in toolbar prevent item navigation if popup is opened.
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onsapnextmodifiers(oEvent: JQueryEventObject): void;
/**
* Handle sapshow pseudo events on the control
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onsapshow(oEvent: JQueryEventObject): void;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.ListItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.ui.core.ListItem[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.ui.core.ListItem} vItem - The item to remove or its index or id
* @returns {sap.ui.core.ListItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.ui.core.ListItem): sap.ui.core.ListItem;
/**
* Sets a new value for property {@link #getDisplaySecondaryValues displaySecondaryValues}.
*
* Indicates whether the additionalText
property that is available for sap.ui.core.ListItem
shall be displayed in the list.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bDisplaySecondaryValues - New value for property displaySecondaryValues
* @returns {sap.ui.commons.ComboBox} Reference to this
in order to allow method chaining
*/
public setDisplaySecondaryValues(bDisplaySecondaryValues: boolean): sap.ui.commons.ComboBox;
/**
* Sets the associated {@link #getListBox listBox}.
* @param {sap.ui.core.ID|sap.ui.commons.ListBox} oListBox - ID of an element which becomes the new target of this listBox association; alternatively, an element instance may be given
* @returns {sap.ui.commons.ComboBox} Reference to this
in order to allow method chaining
*/
public setListBox(oListBox: sap.ui.core.ID|sap.ui.commons.ListBox): sap.ui.commons.ComboBox;
/**
* Sets a new value for property {@link #getMaxPopupItems maxPopupItems}.
*
* Defines the number of items that shall be displayed at once. If the overall number of items is higher than this setting, a scrollbar is provided.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 10
.
* @param {number} iMaxPopupItems - New value for property maxPopupItems
* @returns {sap.ui.commons.ComboBox} Reference to this
in order to allow method chaining
*/
public setMaxPopupItems(iMaxPopupItems: number): sap.ui.commons.ComboBox;
/**
* Sets a new value for property {@link #getSelectedItemId selectedItemId}.
*
* Id of the selected item. If the value has no corresponding item, the selectedItemId
is empty.
*
* If the selectedItemId
is set to a not existing item, it will not be changed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sSelectedItemId - New value for property selectedItemId
* @returns {sap.ui.commons.ComboBox} Reference to this
in order to allow method chaining
*/
public setSelectedItemId(sSelectedItemId: string): sap.ui.commons.ComboBox;
/**
* Sets a new value for property {@link #getSelectedKey selectedKey}.
*
* Key of the selected item.
*
* If the value has no corresponding item the key is empty.
*
* If duplicate keys exists the first item matching the key is used.
*
* If the key is set to a not existing value it will not be changed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sSelectedKey - New value for property selectedKey
* @returns {sap.ui.commons.ComboBox} Reference to this
in order to allow method chaining
*/
public setSelectedKey(sSelectedKey: string): sap.ui.commons.ComboBox;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.ui.commons.ComboBox} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.ui.commons.ComboBox;
}
/**
* Allows end users to interact with dates.
* Entries can directly be written in, or selected from a calendar pad.
* Note: Dates can always be manually entered in the fix YYYYMMDD format, on top of the flexible "locale" format.
* If the value is provided via data binding, using a Date.type the formatter of the Date.type is used.
* Since version 1.22 the unified.Calendar is used inside the datePicker. So applications using the DatePicker should load the unified library. Otherwise it will be loaded the first time a DatePicker is opened.
*/
export class DatePicker extends sap.ui.commons.TextField {
/**
* Constructor for a new DatePicker.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.DatePicker with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.commons.TextField.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event change to attached listeners.
*
* Provides the following event parameters:
*
* - 'newValue' of type
string
The new / changed value of the DatePicker.
* - 'newYyyymmdd' of type
string
The new / changed Yyyymmdd of the DatePicker.
* - 'invalidValue' of type
boolean
The new / changed value of the DatePicker is not a valid date.
*
* @param {boolean} bInvalidValue - true is value is invalid
* @returns {sap.ui.commons.DatePicker} this
to allow method chaining
*/
protected fireChange(bInvalidValue: boolean): sap.ui.commons.DatePicker;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getLocale locale}.
*
* Defines the locale (language and country), e.g. "en-US", whose translations and Date formatters should be used to render the DatePicker.If the value property is bound to a model using a Date type the locale will be ignored, because the locale information of the model are used.
* @returns {string} Value of property locale
*/
public getLocale(): string;
/**
* Returns a metadata object for class sap.ui.commons.DatePicker.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getYyyymmdd yyyymmdd}.
*
* Defines the date as a "yyyymmdd" string, independent from the format used. The inherited textField "value" attribute uses the date format as configured via the locale.
* The date is interpreted as gregorian date
* @returns {string} Value of property yyyymmdd
*/
public getYyyymmdd(): string;
/**
* Sets a new value for property {@link #getLocale locale}.
*
* Defines the locale (language and country), e.g. "en-US", whose translations and Date formatters should be used to render the DatePicker.If the value property is bound to a model using a Date type the locale will be ignored, because the locale information of the model are used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sLocale - New value for property locale
* @returns {sap.ui.commons.DatePicker} Reference to this
in order to allow method chaining
*/
public setLocale(sLocale: string): sap.ui.commons.DatePicker;
/**
* Sets a new value for property {@link #getYyyymmdd yyyymmdd}.
*
* Defines the date as a "yyyymmdd" string, independent from the format used. The inherited textField "value" attribute uses the date format as configured via the locale.
* The date is interpreted as gregorian date
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sYyyymmdd - New value for property yyyymmdd
* @returns {sap.ui.commons.DatePicker} Reference to this
in order to allow method chaining
*/
public setYyyymmdd(sYyyymmdd: string): sap.ui.commons.DatePicker;
}
/**
* An interactive window appearing on request displaying information to the user. The API supports features such as popups with fixed sizes, popups with unlimited width, scrolling bars for large windows, and control nesting (for example, a drop-down list can be included in the window).
*/
export class Dialog extends sap.ui.core.Control {
/**
* Constructor for a new Dialog.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some button to the aggregation {@link #getButtons buttons}.
* @param {sap.ui.core.Control} oButton - the button to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public addButton(oButton: sap.ui.core.Control): sap.ui.commons.Dialog;
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.commons.Dialog;
/**
* Attaches event handler fnFunction
to the {@link #event:closed closed} event of this sap.ui.commons.Dialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Dialog
itself.
*
* Event is fired when the dialog has been closed (after closing-animation etc.). Event parameters provide information about last position and last size.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Dialog
itself
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public attachClosed(fnFunction: Function, oListener?: any): sap.ui.commons.Dialog;
/**
* Attaches event handler fnFunction
to the {@link #event:closed closed} event of this sap.ui.commons.Dialog
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Dialog
itself.
*
* Event is fired when the dialog has been closed (after closing-animation etc.). Event parameters provide information about last position and last size.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Dialog
itself
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public attachClosed(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.Dialog;
/**
* Closes the dialog control instance.
*/
public close(): void;
/**
* Destroys all the buttons in the aggregation {@link #getButtons buttons}.
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public destroyButtons(): sap.ui.commons.Dialog;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.commons.Dialog;
/**
* Detaches event handler fnFunction
from the {@link #event:closed closed} event of this sap.ui.commons.Dialog
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public detachClosed(fnFunction: Function, oListener: any): sap.ui.commons.Dialog;
/**
* Creates a new subclass of class sap.ui.commons.Dialog with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:closed closed} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
protected fireClosed(mParameters?: any): sap.ui.commons.Dialog;
/**
* Gets current value of property {@link #getAccessibleRole accessibleRole}.
*
* The ARIA role for the control. E.g. for alert-style Dialogs this can be set to "AlertDialog".
*
* Default value is Dialog
.
* @returns {sap.ui.core.AccessibleRole} Value of property accessibleRole
*/
public getAccessibleRole(): sap.ui.core.AccessibleRole;
/**
* Gets current value of property {@link #getApplyContentPadding applyContentPadding}.
*
* Padding is theme-dependent. When set to "false", the content extends to the dialog borders.
*
* Default value is true
.
* @returns {boolean} Value of property applyContentPadding
*/
public getApplyContentPadding(): boolean;
/**
* Gets current value of property {@link #getAutoClose autoClose}.
*
* If this property is set to true the Dialog will close if the Dialog loses its focus
*
* Default value is false
.
* @returns {boolean} Value of property autoClose
*/
public getAutoClose(): boolean;
/**
* Gets content of aggregation {@link #getButtons buttons}.
*
* Aggregation of the buttons to display at the bottom of the dialog, for example OK and Cancel. Association defaultButton can be used for one of the defined buttons.
* @returns {sap.ui.core.Control[]}
*/
public getButtons(): sap.ui.core.Control[];
/**
* Gets content of aggregation {@link #getContent content}.
*
* Aggregation of the content of the dialog (one or more controls).
*
* Warning: when content is added with width given as a percentage, the Dialog itself should have a width set.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getContentBorderDesign contentBorderDesign}.
*
* Specifies the border design. Border design is theme dependent.
*
* Default value is None
.
* @returns {sap.ui.commons.enums.BorderDesign} Value of property contentBorderDesign
*/
public getContentBorderDesign(): sap.ui.commons.enums.BorderDesign;
/**
* ID of the element which is the current target of the association {@link #getDefaultButton defaultButton}, or null
.
* @returns {sap.ui.core.ID}
*/
public getDefaultButton(): sap.ui.core.ID;
/**
* Determines whether the dialog is currently enabled or not.
*
* Applications can't control the enabled state via a property. A dialog is implicitly
* enabled depending on its openState
. Descendant controls that honor the
* enabled state of their ancestors will appear disabled after the dialog is closed.
* @returns {boolean} indicates whether the dialog is currently enabled or not.
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* Outer height of dialog window. When not set and not constrained by one of the height parameters (minHeight/maxHeight), the window size is automatically adapted to the content.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* ID of the element which is the current target of the association {@link #getInitialFocus initialFocus}, or null
.
* @returns {sap.ui.core.ID}
*/
public getInitialFocus(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getKeepInWindow keepInWindow}.
*
* Specifies whether Dialog movement should be restricted to the visible area of the window. This only affects drag&drop movements by the user. This doesn't affect modal dialogs -> modal dialogs always stay in the window.
*
* Default value is false
.
* @returns {boolean} Value of property keepInWindow
*/
public getKeepInWindow(): boolean;
/**
* Gets current value of property {@link #getMaxHeight maxHeight}.
*
* Maximum outer height of the dialog window. If set, neither the user nor some layout settings can make the window larger.
* @returns {sap.ui.core.CSSSize} Value of property maxHeight
*/
public getMaxHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getMaxWidth maxWidth}.
*
* Maximum outer width of the dialog window. If set, neither the user nor some layout settings can make the window larger.
* @returns {sap.ui.core.CSSSize} Value of property maxWidth
*/
public getMaxWidth(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.commons.Dialog.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinHeight minHeight}.
*
* Minimum outer height of the dialog window. When set, neither the user nor some layout settings can make the window smaller.
* @returns {sap.ui.core.CSSSize} Value of property minHeight
*/
public getMinHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getMinWidth minWidth}.
*
* Minimum outer width of the dialog window. When set, neither the user nor some layout settings can make the window smaller.
* @returns {sap.ui.core.CSSSize} Value of property minWidth
*/
public getMinWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getModal modal}.
*
* Specifies whether the dialog should be modal, or not. In case of true
the focus is kept inside the dialog.
*
* Default value is false
.
* @returns {boolean} Value of property modal
*/
public getModal(): boolean;
/**
* Indicates whether the Dialog is currently open, closed, or transitioning between these states.
* @returns {sap.ui.core.OpenState}
*/
public getOpenState(): sap.ui.core.OpenState;
/**
* Gets current value of property {@link #getResizable resizable}.
*
* Specifies whether the dialog window can be resized by the user. The dialog frame contains the visual symbol.
*
* Default value is true
.
* @returns {boolean} Value of property resizable
*/
public getResizable(): boolean;
/**
* Gets current value of property {@link #getScrollLeft scrollLeft}.
*
* Scroll position from left to right. "0" means leftmost position.
*
* Default value is 0
.
* @returns {number} Value of property scrollLeft
*/
public getScrollLeft(): number;
/**
* Gets current value of property {@link #getScrollTop scrollTop}.
*
* Scroll position from top to bottom. "0" means topmost position.
*
* Default value is 0
.
* @returns {number} Value of property scrollTop
*/
public getScrollTop(): number;
/**
* Gets current value of property {@link #getShowCloseButton showCloseButton}.
*
* Displays a close button in the title bar.
*
* Default value is true
.
* @returns {boolean} Value of property showCloseButton
*/
public getShowCloseButton(): boolean;
/**
* Gets current value of property {@link #getTitle title}.
*
* Dialog title displayed in the header.
*
* Default value is
.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Outer width of dialog window. When not set and not constrained by one of the width parameters (minWidth/maxWidth), the window size is automatically adapted to the content.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getButtons buttons}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oButton - The button whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfButton(oButton: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a button into the aggregation {@link #getButtons buttons}.
* @param {sap.ui.core.Control} oButton - the button to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the button should be inserted at; for a negative value of iIndex
, the button is inserted at position 0; for a value greater than the current size of the aggregation, the button is inserted at the last position
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public insertButton(oButton: sap.ui.core.Control, iIndex: number): sap.ui.commons.Dialog;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.commons.Dialog;
/**
* Indicates whether the Dialog is open (this includes opening and closing animations).
* For more detailed information about the current state check Dialog.getOpenState().
* @returns {boolean}
*/
public isOpen(): boolean;
/**
* Opens the dialog control instance.
*/
public open(): void;
/**
* Removes all the controls from the aggregation {@link #getButtons buttons}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllButtons(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a button from the aggregation {@link #getButtons buttons}.
* @param {number|string|sap.ui.core.Control} vButton - The button to remove or its index or id
* @returns {sap.ui.core.Control} The removed button or null
*/
public removeButton(vButton: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getAccessibleRole accessibleRole}.
*
* The ARIA role for the control. E.g. for alert-style Dialogs this can be set to "AlertDialog".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Dialog
.
* @param {sap.ui.core.AccessibleRole} sAccessibleRole - New value for property accessibleRole
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setAccessibleRole(sAccessibleRole: sap.ui.core.AccessibleRole): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getApplyContentPadding applyContentPadding}.
*
* Padding is theme-dependent. When set to "false", the content extends to the dialog borders.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bApplyContentPadding - New value for property applyContentPadding
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setApplyContentPadding(bApplyContentPadding: boolean): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getAutoClose autoClose}.
*
* If this property is set to true the Dialog will close if the Dialog loses its focus
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bAutoClose - New value for property autoClose
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setAutoClose(bAutoClose: boolean): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getContentBorderDesign contentBorderDesign}.
*
* Specifies the border design. Border design is theme dependent.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.commons.enums.BorderDesign} sContentBorderDesign - New value for property contentBorderDesign
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setContentBorderDesign(sContentBorderDesign: sap.ui.commons.enums.BorderDesign): sap.ui.commons.Dialog;
/**
* Sets the associated {@link #getDefaultButton defaultButton}.
* @param {sap.ui.core.ID|sap.ui.commons.Button} oDefaultButton - ID of an element which becomes the new target of this defaultButton association; alternatively, an element instance may be given
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setDefaultButton(oDefaultButton: sap.ui.core.ID|sap.ui.commons.Button): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Outer height of dialog window. When not set and not constrained by one of the height parameters (minHeight/maxHeight), the window size is automatically adapted to the content.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.Dialog;
/**
* Sets the associated {@link #getInitialFocus initialFocus}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oInitialFocus - ID of an element which becomes the new target of this initialFocus association; alternatively, an element instance may be given
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setInitialFocus(oInitialFocus: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getKeepInWindow keepInWindow}.
*
* Specifies whether Dialog movement should be restricted to the visible area of the window. This only affects drag&drop movements by the user. This doesn't affect modal dialogs -> modal dialogs always stay in the window.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bKeepInWindow - New value for property keepInWindow
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setKeepInWindow(bKeepInWindow: boolean): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getMaxHeight maxHeight}.
*
* Maximum outer height of the dialog window. If set, neither the user nor some layout settings can make the window larger.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sMaxHeight - New value for property maxHeight
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setMaxHeight(sMaxHeight: sap.ui.core.CSSSize): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getMaxWidth maxWidth}.
*
* Maximum outer width of the dialog window. If set, neither the user nor some layout settings can make the window larger.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sMaxWidth - New value for property maxWidth
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setMaxWidth(sMaxWidth: sap.ui.core.CSSSize): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getMinHeight minHeight}.
*
* Minimum outer height of the dialog window. When set, neither the user nor some layout settings can make the window smaller.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sMinHeight - New value for property minHeight
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setMinHeight(sMinHeight: sap.ui.core.CSSSize): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getMinWidth minWidth}.
*
* Minimum outer width of the dialog window. When set, neither the user nor some layout settings can make the window smaller.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sMinWidth - New value for property minWidth
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setMinWidth(sMinWidth: sap.ui.core.CSSSize): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getModal modal}.
*
* Specifies whether the dialog should be modal, or not. In case of true
the focus is kept inside the dialog.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bModal - New value for property modal
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setModal(bModal: boolean): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getResizable resizable}.
*
* Specifies whether the dialog window can be resized by the user. The dialog frame contains the visual symbol.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bResizable - New value for property resizable
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setResizable(bResizable: boolean): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getScrollLeft scrollLeft}.
*
* Scroll position from left to right. "0" means leftmost position.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iScrollLeft - New value for property scrollLeft
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setScrollLeft(iScrollLeft: number): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getScrollTop scrollTop}.
*
* Scroll position from top to bottom. "0" means topmost position.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iScrollTop - New value for property scrollTop
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setScrollTop(iScrollTop: number): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getShowCloseButton showCloseButton}.
*
* Displays a close button in the title bar.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowCloseButton - New value for property showCloseButton
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setShowCloseButton(bShowCloseButton: boolean): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Dialog title displayed in the header.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.commons.Dialog;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Outer width of dialog window. When not set and not constrained by one of the width parameters (minWidth/maxWidth), the window size is automatically adapted to the content.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.Dialog} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.Dialog;
}
/**
* The control provides a field that allows end users to an entry out of a list of pre-defined items.
* The choosable items can be provided in the form of a complete ListBox
, single ListItems
.
*/
export class DropdownBox extends sap.ui.commons.ComboBox {
/**
* Constructor for a new DropdownBox.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:searchHelp searchHelp} event of this sap.ui.commons.DropdownBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.DropdownBox
itself.
*
* Event fired whenever the configured searchHelpItem is clicked or the searchHelpItem is configured and F4 key is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.DropdownBox
itself
* @returns {sap.ui.commons.DropdownBox} Reference to this
in order to allow method chaining
*/
public attachSearchHelp(fnFunction: Function, oListener?: any): sap.ui.commons.DropdownBox;
/**
* Attaches event handler fnFunction
to the {@link #event:searchHelp searchHelp} event of this sap.ui.commons.DropdownBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.DropdownBox
itself.
*
* Event fired whenever the configured searchHelpItem is clicked or the searchHelpItem is configured and F4 key is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.DropdownBox
itself
* @returns {sap.ui.commons.DropdownBox} Reference to this
in order to allow method chaining
*/
public attachSearchHelp(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.DropdownBox;
/**
* Using this method the history of the DropdownBox can be cleared.
* This might be necessary if the items of the DropdownBox have changed. Otherwise invalid items may appear in the history.
*/
public clearHistory(): void;
/**
* Detaches event handler fnFunction
from the {@link #event:searchHelp searchHelp} event of this sap.ui.commons.DropdownBox
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.DropdownBox} Reference to this
in order to allow method chaining
*/
public detachSearchHelp(fnFunction: Function, oListener: any): sap.ui.commons.DropdownBox;
/**
* Creates a new subclass of class sap.ui.commons.DropdownBox with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.commons.ComboBox.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:searchHelp searchHelp} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.DropdownBox} Reference to this
in order to allow method chaining
*/
protected fireSearchHelp(mParameters?: any): sap.ui.commons.DropdownBox;
/**
* Gets current value of property {@link #getMaxHistoryItems maxHistoryItems}.
*
* Maximum number of history items in the list.
*
* If 0 no history is displayed or stored. The history is locally stored on the client.
* Therefore do not activate this feature when this control handles confidential data.
*
* Default value is 0
.
* @returns {number} Value of property maxHistoryItems
*/
public getMaxHistoryItems(): number;
/**
* Returns a metadata object for class sap.ui.commons.DropdownBox.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSearchHelpAdditionalText searchHelpAdditionalText}.
*
* (optional) The additional Text to use for the search help entry.
* @returns {string} Value of property searchHelpAdditionalText
*/
public getSearchHelpAdditionalText(): string;
/**
* Gets current value of property {@link #getSearchHelpEnabled searchHelpEnabled}.
*
* Whether the DropdownBox's search help should be enabled.
*
* Default value is false
.
* @returns {boolean} Value of property searchHelpEnabled
*/
public getSearchHelpEnabled(): boolean;
/**
* Gets current value of property {@link #getSearchHelpIcon searchHelpIcon}.
*
* (optional) The URI of the icon to use for the search help entry.
* @returns {sap.ui.core.URI} Value of property searchHelpIcon
*/
public getSearchHelpIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getSearchHelpText searchHelpText}.
*
* (optional) The text to use for the search help entry.
* @returns {string} Value of property searchHelpText
*/
public getSearchHelpText(): string;
/**
* Extends the method inherited from sap.ui.core.Element by providing information on Search Help access (if needed)
* @returns {string} string tooltip or undefined
*/
public getTooltip_AsString(): string;
/**
* Ensure that handed in ListBoxes are taken from the visible UI immediately.
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onAfterRendering(oEvent: JQueryEventObject): void;
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
protected onAfterRendering(...args: any[]): any;
/**
* Handle the click event happening in the DropdownBox
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onclick(oEvent: JQueryEventObject): void;
/**
* Handle focusin event
* Ensures the text gets selected when focus gets into the field
* @param {JQueryEventObject} oEvent - the occuring event
*/
protected onfocusin(oEvent: JQueryEventObject): void;
/**
* Handle keydown event
* @param {JQueryEventObject} oEvent - the occuring event
*/
protected onkeydown(oEvent: JQueryEventObject): void;
/**
* Handle keypress event
* @param {JQueryEventObject} oEvent - the occuring event
*/
protected onkeypress(oEvent: JQueryEventObject): void;
/**
* Handle keyup event
* This must only be considered if it is from Backspace-key in IE or after paste.
* In case there is a keyup with a tab this results from being entered via tabbing and can be ignored, too.
* @param {JQueryEventObject} oEvent - the occuring event
*/
protected onkeyup(oEvent: JQueryEventObject): void;
/**
* Handle paste event
* @param {JQueryEventObject} oEvent - the occuring event
*/
protected onpaste(oEvent: JQueryEventObject): void;
/**
* Handle pseudo event onsapdelete.
* If triggered with open dropdown and current item provided by history feature,
* removes the selected item from this instance's history.
* @param {JQueryEventObject} oEvent - the occuring event
*/
protected onsapdelete(oEvent: JQueryEventObject): void;
/**
* Handle pseudo event onsaphome
* @param {JQueryEventObject} oEvent - the occuring event
*/
protected onsaphome(oEvent: JQueryEventObject): void;
/**
* Move the cursor one step to the left (and adapt selection)
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onsapleft(oEvent: JQueryEventObject): void;
/**
* Move the cursor one step to the right (and adapt selection)
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onsapright(oEvent: JQueryEventObject): void;
/**
* Handle sapshow pseudo events on the control
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onsapshow(oEvent: JQueryEventObject): void;
/**
* Handle the select event happening in the DropdownBox
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onselect(oEvent: JQueryEventObject): void;
/**
* Sets a new value for property {@link #getMaxHistoryItems maxHistoryItems}.
*
* Maximum number of history items in the list.
*
* If 0 no history is displayed or stored. The history is locally stored on the client.
* Therefore do not activate this feature when this control handles confidential data.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iMaxHistoryItems - New value for property maxHistoryItems
* @returns {sap.ui.commons.DropdownBox} Reference to this
in order to allow method chaining
*/
public setMaxHistoryItems(iMaxHistoryItems: number): sap.ui.commons.DropdownBox;
/**
* Overwrite of Setter for property searchHelpAdditionalText
.
*
* Default value is empty/undefined
* @param {string} sSearchHelpAdditionalText - new value for property searchHelpAdditionalText
* @returns {sap.ui.commons.DropdownBox} this
to allow method chaining
*/
public setSearchHelpAdditionalText(sSearchHelpAdditionalText: string): sap.ui.commons.DropdownBox;
/**
* Overwrite of Setter for property searchHelpEnabled
.
* This method accepts additional parameter to be compatiple with the
* previous functionality
*
* Default value is false
* @param {boolean} bEnabled - new value for property searchHelpEnabled
* @param {string} sText - new value for property searchHelpText
* @param {string} sAdditionalText - new value for property searchHelpAdditionalText
* @param {string} sIcon - new value for property searchHelpIcon
* @returns {sap.ui.commons.DropdownBox} this
to allow method chaining
*/
public setSearchHelpEnabled(bEnabled: boolean, sText: string, sAdditionalText: string, sIcon: string): sap.ui.commons.DropdownBox;
/**
* Overwrite of Setter for property searchHelpIcon
.
*
* Default value is empty/undefined
* @param {sap.ui.core.URI} sSearchHelpIcon - new value for property searchHelpIcon
* @returns {sap.ui.commons.DropdownBox} this
to allow method chaining
*/
public setSearchHelpIcon(sSearchHelpIcon: sap.ui.core.URI): sap.ui.commons.DropdownBox;
/**
* Overwrite of Setter for property searchHelpText
.
*
* Default value is empty/undefined
* @param {string} sSearchHelpText - new value for property searchHelpText
* @returns {sap.ui.commons.DropdownBox} this
to allow method chaining
*/
public setSearchHelpText(sSearchHelpText: string): sap.ui.commons.DropdownBox;
}
/**
*/
namespace enums {
/**
* Value set for the background design of areas
*/
export enum AreaDesign {
/**
* Shows the label in a filled look
*/
Fill = "Fill",
/**
* Shows the area in a plain look
*/
Plain = "Plain",
/**
* Shows the background as transparent
*/
Transparent = "Transparent",
}
/**
* Value set for the border design of areas
*/
export enum BorderDesign {
/**
* Draws the border as a box around the area
*/
Box = "Box",
/**
* Suppresses the border
*/
None = "None",
}
/**
* Orientation of a UI element
*/
export enum Orientation {
/**
* Horizontal orientation
*/
horizontal = "horizontal",
/**
* Vertical orientation
*/
vertical = "vertical",
}
}
/**
* The framework generates an input field and a button with text "Browse ...". The API supports features such as on change uploads (the upload starts immediately after a file has been selected), file uploads with explicit calls, adjustable control sizes, text display after uploads, or tooltips containing complete file paths.
*/
export class FileUploader extends sap.ui.unified.FileUploader {
/**
* Constructor for a new FileUploader.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.FileUploader with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.unified.FileUploader.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.FileUploader.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Represents a parameter for the FileUploader which is rendered as a hidden inputfield.
*/
export class FileUploaderParameter extends sap.ui.unified.FileUploaderParameter {
/**
* Constructor for a new FileUploaderParameter.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.FileUploaderParameter with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.unified.FileUploaderParameter.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.FileUploaderParameter.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
*/
namespace form {
/**
* Form control.
* Holder for form control to be rendered in a specific form layout.
* A Form supports VariantLayoutData for it's conent to allow a simple switching of Layouts.
*/
export class Form extends sap.ui.layout.form.Form {
/**
* Constructor for a new form/Form.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.form.Form with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.form.Form.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.form.Form.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Getter for property visible
.
* Invisible Forms are not rendered.
*
* Default value is true
* @returns {boolean} the value of property visible
*/
public getVisible(): boolean;
/**
* Setter for property visible
.
*
* Default value is true
* @param {boolean} bVisible - new value for property visible
* @returns {sap.ui.commons.form.Form} this
to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.commons.form.Form;
}
/**
* Used to group form elements.
*/
export class FormContainer extends sap.ui.layout.form.FormContainer {
/**
* Constructor for a new form/FormContainer.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.form.FormContainer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.form.FormContainer.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.form.FormContainer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Getter for property visible
.
* Invisible FormContainers are not rendered.
*
* Default value is true
* @returns {boolean} the value of property visible
*/
public getVisible(): boolean;
/**
* Setter for property visible
.
*
* Default value is true
* @param {boolean} bVisible - new value for property visible
* @returns {sap.ui.commons.form.FormContainer} this
to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.commons.form.FormContainer;
}
/**
* A form element is a combination of one label and different controls associated to this label.
*/
export class FormElement extends sap.ui.layout.form.FormElement {
/**
* Constructor for a new form/FormElement.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.form.FormElement with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.form.FormElement.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.form.FormElement.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Getter for property visible
.
* Invisible FormElements are not rendered.
*
* Default value is true
* @returns {boolean} the value of property visible
*/
public getVisible(): boolean;
/**
* Setter for property visible
.
*
* Default value is true
* @param {boolean} bVisible - new value for property visible
* @returns {sap.ui.commons.form.FormElement} this
to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.commons.form.FormElement;
}
/**
* Base layout for Forms.
* Other Layouts must inherit from this one.
*/
export class FormLayout extends sap.ui.layout.form.FormLayout {
/**
* Constructor for a new form/FormLayout.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.form.FormLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.form.FormLayout.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.form.FormLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Grid layout specific properties for FormContainers.
* The width and height properties of the elements are ignored since the witdh and heights are defined by the grid cells.
*/
export class GridContainerData extends sap.ui.layout.form.GridContainerData {
/**
* Constructor for a new form/GridContainerData.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.form.GridContainerData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.form.GridContainerData.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.form.GridContainerData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* The grid specific layout data for FormElement fields.
* The width property of the elements is ignored since the width is defined by grid cells.
*/
export class GridElementData extends sap.ui.layout.form.GridElementData {
/**
* Constructor for a new form/GridElementData.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.form.GridElementData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.form.GridElementData.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.form.GridElementData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* This Layout implements a guideline 2.0 grid. This can be a 16 column grid or an 8 column grid.
*
* To adjust the content inside the GridLayout GridContainerData and GridElementData could be used.
*/
export class GridLayout extends sap.ui.layout.form.GridLayout {
/**
* Constructor for a new form/GridLayout.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.form.GridLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.form.GridLayout.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.form.GridLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Renders a form with responsive layout. Internally the ResponsiveFlowLayout is used.
*/
export class ResponsiveLayout extends sap.ui.layout.form.ResponsiveLayout {
/**
* Constructor for a new form/ResponsiveLayout.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.form.ResponsiveLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.form.ResponsiveLayout.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.form.ResponsiveLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Use the SimpleForm to create a form based on title, label and fields that are stacked in the content aggregation. Add Title to start a new FormContainer(Group). Add Label to start a new row in the container. Add Input/Display controls as needed. Use LayoutData to influence the layout for special cases in the Input/Display controls.
*/
export class SimpleForm extends sap.ui.layout.form.SimpleForm {
/**
* Constructor for a new form/SimpleForm.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.form.SimpleForm with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.form.SimpleForm.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Getter for property layout
.
* The FormLayout that is used to render the SimpleForm
*
* Default value is ResponsiveLayout
* @returns {sap.ui.layout.form.SimpleFormLayout} the value of property layout
*/
public getLayout(): sap.ui.layout.form.SimpleFormLayout;
/**
* Returns a metadata object for class sap.ui.commons.form.SimpleForm.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Setter for property layout
.
*
* Default value is ResponsiveLayout
* @param {sap.ui.layout.form.SimpleFormLayout} oLayout - new value for property layout
* @returns {sap.ui.commons.form.SimpleForm} this
to allow method chaining
*/
public setLayout(oLayout: sap.ui.layout.form.SimpleFormLayout): sap.ui.commons.form.SimpleForm;
}
}
/**
* The FormattedTextView control allows the usage of a limited set of HTML tags for display.
*/
export class FormattedTextView extends sap.ui.core.Control {
/**
* Constructor for a new FormattedTextView.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some control to the aggregation {@link #getControls controls}.
* @param {sap.ui.core.Control} oControl - the control to add; if empty, nothing is inserted
* @returns {sap.ui.commons.FormattedTextView} Reference to this
in order to allow method chaining
*/
public addControl(oControl: sap.ui.core.Control): sap.ui.commons.FormattedTextView;
/**
* Destroys all the controls in the aggregation {@link #getControls controls}.
* @returns {sap.ui.commons.FormattedTextView} Reference to this
in order to allow method chaining
*/
public destroyControls(): sap.ui.commons.FormattedTextView;
/**
* Creates a new subclass of class sap.ui.commons.FormattedTextView with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAccessibleRole accessibleRole}.
*
* The ARIA role for the control.
*
* Default value is Document
.
* @returns {sap.ui.core.AccessibleRole} Value of property accessibleRole
*/
public getAccessibleRole(): sap.ui.core.AccessibleRole;
/**
* Gets content of aggregation {@link #getControls controls}.
*
* Array of controls that should be replaced within htmlText.
* @returns {sap.ui.core.Control[]}
*/
public getControls(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getHtmlText htmlText}.
*
* Determines text with placeholders.
*
* Default value is
.
* @returns {string} Value of property htmlText
*/
public getHtmlText(): string;
/**
* Returns a metadata object for class sap.ui.commons.FormattedTextView.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Indicates whether the FormattedTextView contains other controls.
* @returns {boolean}
*/
public hasControls(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getControls controls}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oControl - The control whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfControl(oControl: sap.ui.core.Control): number;
/**
* Inserts a control into the aggregation {@link #getControls controls}.
* @param {sap.ui.core.Control} oControl - the control to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the control should be inserted at; for a negative value of iIndex
, the control is inserted at position 0; for a value greater than the current size of the aggregation, the control is inserted at the last position
* @returns {sap.ui.commons.FormattedTextView} Reference to this
in order to allow method chaining
*/
public insertControl(oControl: sap.ui.core.Control, iIndex: number): sap.ui.commons.FormattedTextView;
/**
* Removes all the controls from the aggregation {@link #getControls controls}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllControls(): sap.ui.core.Control[];
/**
* Removes a control from the aggregation {@link #getControls controls}.
* @param {number|string|sap.ui.core.Control} vControl - The control to remove or its index or id
* @returns {sap.ui.core.Control} The removed control or null
*/
public removeControl(vControl: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getAccessibleRole accessibleRole}.
*
* The ARIA role for the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Document
.
* @param {sap.ui.core.AccessibleRole} sAccessibleRole - New value for property accessibleRole
* @returns {sap.ui.commons.FormattedTextView} Reference to this
in order to allow method chaining
*/
public setAccessibleRole(sAccessibleRole: sap.ui.core.AccessibleRole): sap.ui.commons.FormattedTextView;
/**
* Sets text with placeholders and given array of controls.
* @param {string} sHtmlText - Contains the corresponding HTML text
* @param {sap.ui.commons.FormattedTextViewControl} aControls - Array of controls that should be used within given HTML text
*/
public setContent(sHtmlText: string, aControls: sap.ui.commons.FormattedTextViewControl): void;
/**
* Sets the HTML text to be displayed.
* @param {string} sText - HTML text as a string
*/
public setHtmlText(sText: string): void;
}
/**
* Marker interface for common controls which are suitable for use within a FormattedTextView.
*/
export interface FormattedTextViewControl {
}
/**
* Divides the screen in visual areas.
*/
export class HorizontalDivider extends sap.ui.core.Control {
/**
* Constructor for a new HorizontalDivider.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.HorizontalDivider with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getHeight height}.
*
* Defines the height of the divider.
*
* Default value is Medium
.
* @returns {sap.ui.commons.HorizontalDividerHeight} Value of property height
*/
public getHeight(): sap.ui.commons.HorizontalDividerHeight;
/**
* Returns a metadata object for class sap.ui.commons.HorizontalDivider.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getType type}.
*
* Defines the type of the divider.
*
* Default value is Area
.
* @returns {sap.ui.commons.HorizontalDividerType} Value of property type
*/
public getType(): sap.ui.commons.HorizontalDividerType;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the divider.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Defines the height of the divider.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Medium
.
* @param {sap.ui.commons.HorizontalDividerHeight} sHeight - New value for property height
* @returns {sap.ui.commons.HorizontalDivider} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.commons.HorizontalDividerHeight): sap.ui.commons.HorizontalDivider;
/**
* Sets a new value for property {@link #getType type}.
*
* Defines the type of the divider.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Area
.
* @param {sap.ui.commons.HorizontalDividerType} sType - New value for property type
* @returns {sap.ui.commons.HorizontalDivider} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.ui.commons.HorizontalDividerType): sap.ui.commons.HorizontalDivider;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the divider.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.HorizontalDivider} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.HorizontalDivider;
}
/**
* Enumeration of possible HorizontalDivider height settings.
*/
export enum HorizontalDividerHeight {
/**
* Divider gets a large top and bottom margin.
*/
Large = "Large",
/**
* Divider gets a medium top and bottom margin.
*/
Medium = "Medium",
/**
* Divider gets no top and bottom margin.
*/
Ruleheight = "Ruleheight",
/**
* Divider gets a small top and bottom margin.
*/
Small = "Small",
}
/**
* Enumeration of possible HorizontalDivider types.
*/
export enum HorizontalDividerType {
/**
* Type Area
*/
Area = "Area",
/**
* Type Page
*/
Page = "Page",
}
/**
* A wrapper around the IMG tag. The image can be loaded from a remote or local server.
* There are various size setting options available, and the images can be combined with actions.
*/
export class Image extends sap.ui.core.Control {
/**
* Constructor for a new Image.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.commons.Image
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Image
itself.
*
* Event is fired when the user clicks on the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Image
itself
* @returns {sap.ui.commons.Image} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.ui.commons.Image;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.commons.Image
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Image
itself.
*
* Event is fired when the user clicks on the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Image
itself
* @returns {sap.ui.commons.Image} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.Image;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.ui.commons.Image
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.Image} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.ui.commons.Image;
/**
* Creates a new subclass of class sap.ui.commons.Image with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.Image} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.ui.commons.Image;
/**
* Gets current value of property {@link #getAlt alt}.
*
* The alternative text that is displayed in case the Image is not available, or cannot be displayed.
* If the image is set to decorative this property is ignored.
* @returns {string} Value of property alt
*/
public getAlt(): string;
/**
* Gets current value of property {@link #getDecorative decorative}.
*
* A decorative image is included for design reasons. Accessibility tools will ignore decorative images.
* Note: If the Image has an image map (useMap is set), this property will be overridden (the image will not be rendered as decorative).
* A decorative image has no ALT attribute, so the Alt property is ignored if the image is decorative.
*
* Default value is true
.
* @returns {boolean} Value of property decorative
*/
public getDecorative(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* When the empty value is kept, the original size is not changed. It is also possible to make settings for width or height only, the overall size is maintained then, considering the aspect ratio.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.commons.Image.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSrc src}.
*
* Relative or absolute path to URL where the image file is stored.
* @returns {sap.ui.core.URI} Value of property src
*/
public getSrc(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getUseMap useMap}.
*
* The name of the image map that defines the clickable areas
* @returns {string} Value of property useMap
*/
public getUseMap(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* When the empty value is kept, the original size is not changed. It is also possible to make settings for width or height only, the overall size is maintained then, considering the aspect ratio.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getAlt alt}.
*
* The alternative text that is displayed in case the Image is not available, or cannot be displayed.
* If the image is set to decorative this property is ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAlt - New value for property alt
* @returns {sap.ui.commons.Image} Reference to this
in order to allow method chaining
*/
public setAlt(sAlt: string): sap.ui.commons.Image;
/**
* Sets a new value for property {@link #getDecorative decorative}.
*
* A decorative image is included for design reasons. Accessibility tools will ignore decorative images.
* Note: If the Image has an image map (useMap is set), this property will be overridden (the image will not be rendered as decorative).
* A decorative image has no ALT attribute, so the Alt property is ignored if the image is decorative.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bDecorative - New value for property decorative
* @returns {sap.ui.commons.Image} Reference to this
in order to allow method chaining
*/
public setDecorative(bDecorative: boolean): sap.ui.commons.Image;
/**
* Sets a new value for property {@link #getHeight height}.
*
* When the empty value is kept, the original size is not changed. It is also possible to make settings for width or height only, the overall size is maintained then, considering the aspect ratio.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.commons.Image} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.Image;
/**
* Sets a new value for property {@link #getSrc src}.
*
* Relative or absolute path to URL where the image file is stored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sSrc - New value for property src
* @returns {sap.ui.commons.Image} Reference to this
in order to allow method chaining
*/
public setSrc(sSrc: sap.ui.core.URI): sap.ui.commons.Image;
/**
* Sets a new value for property {@link #getUseMap useMap}.
*
* The name of the image map that defines the clickable areas
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sUseMap - New value for property useMap
* @returns {sap.ui.commons.Image} Reference to this
in order to allow method chaining
*/
public setUseMap(sUseMap: string): sap.ui.commons.Image;
/**
* Sets a new value for property {@link #getWidth width}.
*
* When the empty value is kept, the original size is not changed. It is also possible to make settings for width or height only, the overall size is maintained then, considering the aspect ratio.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.Image} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.Image;
}
/**
* Combination of image areas where at runtime these areas are starting points for hyperlinks or actions
*/
export class ImageMap extends sap.ui.core.Control {
/**
* Constructor for a new ImageMap.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some area to the aggregation {@link #getAreas areas}.
* @param {sap.ui.commons.Area} oArea - the area to add; if empty, nothing is inserted
* @returns {sap.ui.commons.ImageMap} Reference to this
in order to allow method chaining
*/
public addArea(oArea: sap.ui.commons.Area): sap.ui.commons.ImageMap;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.commons.ImageMap
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.ImageMap
itself.
*
* Event for the areas that can be clicked in an ImageMap
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.ImageMap
itself
* @returns {sap.ui.commons.ImageMap} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.ui.commons.ImageMap;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.commons.ImageMap
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.ImageMap
itself.
*
* Event for the areas that can be clicked in an ImageMap
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.ImageMap
itself
* @returns {sap.ui.commons.ImageMap} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.ImageMap;
/**
* Adds areas to the Image Map.
*
* Each argument must be either a JSon object or a list of objects or the area element or elements.
* @param {any} content - Area content to add
* @returns {sap.ui.commons.ImageMap} this
to allow method chaining
*/
public createArea(content: any): sap.ui.commons.ImageMap;
/**
* Destroys all the areas in the aggregation {@link #getAreas areas}.
* @returns {sap.ui.commons.ImageMap} Reference to this
in order to allow method chaining
*/
public destroyAreas(): sap.ui.commons.ImageMap;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.ui.commons.ImageMap
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.ImageMap} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.ui.commons.ImageMap;
/**
* Creates a new subclass of class sap.ui.commons.ImageMap with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.ImageMap} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.ui.commons.ImageMap;
/**
* Gets content of aggregation {@link #getAreas areas}.
*
* Area representing the reference to the target location
* @returns {sap.ui.commons.Area[]}
*/
public getAreas(): sap.ui.commons.Area[];
/**
* Returns a metadata object for class sap.ui.commons.ImageMap.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* Name for the image that serves as reference
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Checks for the provided sap.ui.commons.Area
in the aggregation {@link #getAreas areas}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.Area} oArea - The area whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfArea(oArea: sap.ui.commons.Area): number;
/**
* Inserts a area into the aggregation {@link #getAreas areas}.
* @param {sap.ui.commons.Area} oArea - the area to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the area should be inserted at; for a negative value of iIndex
, the area is inserted at position 0; for a value greater than the current size of the aggregation, the area is inserted at the last position
* @returns {sap.ui.commons.ImageMap} Reference to this
in order to allow method chaining
*/
public insertArea(oArea: sap.ui.commons.Area, iIndex: number): sap.ui.commons.ImageMap;
/**
* Removes all the controls from the aggregation {@link #getAreas areas}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.Area[]} An array of the removed elements (might be empty)
*/
public removeAllAreas(): sap.ui.commons.Area[];
/**
* Removes a area from the aggregation {@link #getAreas areas}.
* @param {number|string|sap.ui.commons.Area} vArea - The area to remove or its index or id
* @returns {sap.ui.commons.Area} The removed area or null
*/
public removeArea(vArea: number|string|sap.ui.commons.Area): sap.ui.commons.Area;
/**
* Sets a new value for property {@link #getName name}.
*
* Name for the image that serves as reference
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.ui.commons.ImageMap} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.ui.commons.ImageMap;
}
/**
* The InPlaceEdit is a functionality to have text in display mode that can be changed in place.
*/
export class InPlaceEdit extends sap.ui.core.Control {
/**
* Constructor for a new InPlaceEdit.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.commons.InPlaceEdit
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.InPlaceEdit
itself.
*
* Event is fired when the text in the field has changed AND the focus leaves the InPlaceEdit or the Enter key is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.InPlaceEdit
itself
* @returns {sap.ui.commons.InPlaceEdit} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.ui.commons.InPlaceEdit;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.commons.InPlaceEdit
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.InPlaceEdit
itself.
*
* Event is fired when the text in the field has changed AND the focus leaves the InPlaceEdit or the Enter key is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.InPlaceEdit
itself
* @returns {sap.ui.commons.InPlaceEdit} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.InPlaceEdit;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.ui.commons.InPlaceEdit
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.InPlaceEdit
itself.
*
* This event if fired during typing into the InPlaceEdit and returns the currently entered value. This is not the content of the value property. The value property is only updated by ENTER and by leaving the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.InPlaceEdit
itself
* @returns {sap.ui.commons.InPlaceEdit} Reference to this
in order to allow method chaining
*/
public attachLiveChange(fnFunction: Function, oListener?: any): sap.ui.commons.InPlaceEdit;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.ui.commons.InPlaceEdit
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.InPlaceEdit
itself.
*
* This event if fired during typing into the InPlaceEdit and returns the currently entered value. This is not the content of the value property. The value property is only updated by ENTER and by leaving the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.InPlaceEdit
itself
* @returns {sap.ui.commons.InPlaceEdit} Reference to this
in order to allow method chaining
*/
public attachLiveChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.InPlaceEdit;
/**
* Clear the old text after a change to disable the undo functionality. If undoEnabled is false this has no effect.
*/
public clearOldText(): void;
/**
* Destroys the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.commons.InPlaceEdit} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.commons.InPlaceEdit;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.ui.commons.InPlaceEdit
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.InPlaceEdit} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.ui.commons.InPlaceEdit;
/**
* Detaches event handler fnFunction
from the {@link #event:liveChange liveChange} event of this sap.ui.commons.InPlaceEdit
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.InPlaceEdit} Reference to this
in order to allow method chaining
*/
public detachLiveChange(fnFunction: Function, oListener: any): sap.ui.commons.InPlaceEdit;
/**
* Creates a new subclass of class sap.ui.commons.InPlaceEdit with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.InPlaceEdit} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.ui.commons.InPlaceEdit;
/**
* Fires event {@link #event:liveChange liveChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.InPlaceEdit} Reference to this
in order to allow method chaining
*/
protected fireLiveChange(mParameters?: any): sap.ui.commons.InPlaceEdit;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Content control of the InPlaceEdit.
* The following controls are allowed:
* TextField, ComboBox, DropdownBox and Link
* @returns {sap.ui.core.Control}
*/
public getContent(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getDesign design}.
*
* Defines the visual appearance of the control.
* Currently this is not supported for Labels.
*
* Default value is Standard
.
* @returns {sap.ui.commons.TextViewDesign} Value of property design
*/
public getDesign(): sap.ui.commons.TextViewDesign;
/**
* Returns a metadata object for class sap.ui.commons.InPlaceEdit.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the tooltip for this InPlaceEdit if any or an undefined value.
* The tooltip can either be a simple string or a subclass of
* {@link sap.ui.core.TooltipBase}.
*
* Callers that are only interested in tooltips of type string (e.g. to render
* them as a title
attribute), should call the convenience method
* {@link #getTooltip_AsString} instead. If they want to get a tooltip text no
* matter where it comes from (be it a string tooltip or the text from a TooltipBase
* instance) then they could call {@link #getTooltip_Text} instead.
*
* If a content control is assigned to the InPlaceEdit the tooltip of this control
* is used. A directly set tooltip to the InPlaceEdit is ignored in this case.
* @returns {string|sap.ui.core.TooltipBase} The tooltip for this Element.
*/
public getTooltip(): string|sap.ui.core.TooltipBase;
/**
* Gets current value of property {@link #getUndoEnabled undoEnabled}.
*
* If undo is enabled after changing the text an undo button appears.
*
* Default value is true
.
* @returns {boolean} Value of property undoEnabled
*/
public getUndoEnabled(): boolean;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Visualizes warnings or errors related to the InPlaceEdit. Possible values: Warning, Error, Success.
* If the content control has an own valueState property this will be used.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Sets the aggregated {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - The content to set
* @returns {sap.ui.commons.InPlaceEdit} Reference to this
in order to allow method chaining
*/
public setContent(oContent: sap.ui.core.Control): sap.ui.commons.InPlaceEdit;
/**
* Sets a new value for property {@link #getDesign design}.
*
* Defines the visual appearance of the control.
* Currently this is not supported for Labels.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.ui.commons.TextViewDesign} sDesign - New value for property design
* @returns {sap.ui.commons.InPlaceEdit} Reference to this
in order to allow method chaining
*/
public setDesign(sDesign: sap.ui.commons.TextViewDesign): sap.ui.commons.InPlaceEdit;
/**
* Sets a new tooltip for this InPlaceEdit. The tooltip can either be a simple string
* (which in most cases will be rendered as the title
attribute of this
* Element) or an instance of {@link sap.ui.core.TooltipBase}.
*
* If a new tooltip is set, any previously set tooltip is deactivated.
*
* If a content control is assigned to the InPlaceEdit the tooltip of this control
* is used. A directly set tooltip to the InPlaceEdit is ignored in this case.
* @param {string|sap.ui.core.TooltipBase} oTooltip - Tooltip as string or RichTooltip.
*/
public setTooltip(oTooltip: string|sap.ui.core.TooltipBase): void;
/**
* Sets a new value for property {@link #getUndoEnabled undoEnabled}.
*
* If undo is enabled after changing the text an undo button appears.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bUndoEnabled - New value for property undoEnabled
* @returns {sap.ui.commons.InPlaceEdit} Reference to this
in order to allow method chaining
*/
public setUndoEnabled(bUndoEnabled: boolean): sap.ui.commons.InPlaceEdit;
/**
* Sets a new value for property {@link #getValueState valueState}.
*
* Visualizes warnings or errors related to the InPlaceEdit. Possible values: Warning, Error, Success.
* If the content control has an own valueState property this will be used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sValueState - New value for property valueState
* @returns {sap.ui.commons.InPlaceEdit} Reference to this
in order to allow method chaining
*/
public setValueState(sValueState: sap.ui.core.ValueState): sap.ui.commons.InPlaceEdit;
}
/**
* The control is used for labeling other controls. The API provides formatting options, for example, for bold display or alignment. A label can have an icon.
*/
export class Label extends sap.ui.core.Control {
/**
* Constructor for a new Label.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.Label with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getDesign design}.
*
* Defines whether the labels are in bold format.
*
* Default value is Standard
.
* @returns {sap.ui.commons.LabelDesign} Value of property design
*/
public getDesign(): sap.ui.commons.LabelDesign;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Determines the icon to be displayed in the control.
* This can be a URI to an image or an icon font URI.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* ID of the element which is the current target of the association {@link #getLabelFor labelFor}, or null
.
* @returns {sap.ui.core.ID}
*/
public getLabelFor(): sap.ui.core.ID;
/**
* Returns a metadata object for class sap.ui.commons.Label.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRequired required}.
*
* Allows to enforce the required indicator even when the associated control doesn't have a getRequired method (a required property) or when the flag is not set.
* If the associated control has a required property, the values of both required flags are combined with the OR operator, so a Label can't override a required=true value.
*
* Default value is false
.
* @returns {boolean} Value of property required
*/
public getRequired(): boolean;
/**
* Gets current value of property {@link #getRequiredAtBegin requiredAtBegin}.
*
* Determines whether the required indicator is at the beginning of the label (if set) or at the end (if not set).
* @returns {boolean} Value of property requiredAtBegin
*/
public getRequiredAtBegin(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* Determines the text to be displayed.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextAlign textAlign}.
*
* Determines the alignment of the text. Available options are Begin
, Center
, End
, Left
, and Right
.
*
* Default value is Begin
.
* @returns {sap.ui.core.TextAlign} Value of property textAlign
*/
public getTextAlign(): sap.ui.core.TextAlign;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Determines the text direction - right-to-left (RTL) and left-to-right (LTR).
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getWidth width}.
*
* Determines the control width as common CSS-size (for example, px or % as unit).
*
* Default value is
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getWrapping wrapping}.
*
* Specifies whether a line wrapping width shall be displayed when the text value is longer than the width is.
*
* Default value is false
.
* @returns {boolean} Value of property wrapping
*/
public getWrapping(): boolean;
/**
* Sets a new value for property {@link #getDesign design}.
*
* Defines whether the labels are in bold format.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.ui.commons.LabelDesign} sDesign - New value for property design
* @returns {sap.ui.commons.Label} Reference to this
in order to allow method chaining
*/
public setDesign(sDesign: sap.ui.commons.LabelDesign): sap.ui.commons.Label;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Determines the icon to be displayed in the control.
* This can be a URI to an image or an icon font URI.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.commons.Label} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.commons.Label;
/**
* Sets the associated {@link #getLabelFor labelFor}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oLabelFor - ID of an element which becomes the new target of this labelFor association; alternatively, an element instance may be given
* @returns {sap.ui.commons.Label} Reference to this
in order to allow method chaining
*/
public setLabelFor(oLabelFor: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.Label;
/**
* Sets a new value for property {@link #getRequired required}.
*
* Allows to enforce the required indicator even when the associated control doesn't have a getRequired method (a required property) or when the flag is not set.
* If the associated control has a required property, the values of both required flags are combined with the OR operator, so a Label can't override a required=true value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bRequired - New value for property required
* @returns {sap.ui.commons.Label} Reference to this
in order to allow method chaining
*/
public setRequired(bRequired: boolean): sap.ui.commons.Label;
/**
* Sets a new value for property {@link #getRequiredAtBegin requiredAtBegin}.
*
* Determines whether the required indicator is at the beginning of the label (if set) or at the end (if not set).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bRequiredAtBegin - New value for property requiredAtBegin
* @returns {sap.ui.commons.Label} Reference to this
in order to allow method chaining
*/
public setRequiredAtBegin(bRequiredAtBegin: boolean): sap.ui.commons.Label;
/**
* Sets a new value for property {@link #getText text}.
*
* Determines the text to be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sText - New value for property text
* @returns {sap.ui.commons.Label} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.commons.Label;
/**
* Sets a new value for property {@link #getTextAlign textAlign}.
*
* Determines the alignment of the text. Available options are Begin
, Center
, End
, Left
, and Right
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Begin
.
* @param {sap.ui.core.TextAlign} sTextAlign - New value for property textAlign
* @returns {sap.ui.commons.Label} Reference to this
in order to allow method chaining
*/
public setTextAlign(sTextAlign: sap.ui.core.TextAlign): sap.ui.commons.Label;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Determines the text direction - right-to-left (RTL) and left-to-right (LTR).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.ui.commons.Label} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.ui.commons.Label;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Determines the control width as common CSS-size (for example, px or % as unit).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.Label} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.Label;
/**
* Sets a new value for property {@link #getWrapping wrapping}.
*
* Specifies whether a line wrapping width shall be displayed when the text value is longer than the width is.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bWrapping - New value for property wrapping
* @returns {sap.ui.commons.Label} Reference to this
in order to allow method chaining
*/
public setWrapping(bWrapping: boolean): sap.ui.commons.Label;
}
/**
* Available label display modes.
*/
export enum LabelDesign {
/**
* Displays the label in bold.
*/
Bold = "Bold",
/**
* Displays the label in normal mode.
*/
Standard = "Standard",
}
/**
*/
namespace layout {
/**
* The Absolute Layout positions its child controls absolutely
*/
export class AbsoluteLayout extends sap.ui.core.Control {
/**
* Constructor for a new layout/AbsoluteLayout.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds the given control and a corresponding position container into the aggregation named 'positions'. Returns 'this' to allow method chaining.
* @param {sap.ui.core.Control} oContent - The content to add; if empty, nothing is inserted.
* @param {any} oPos - JSON-like object which defines the position of the child control in the layout. The object is expected to have one or more from the attribute set top, bottom, left, right; each with a value of type sap.ui.core.CSSSize. If no object is given, the default is left=0px,right=0px
* @returns {sap.ui.commons.layout.AbsoluteLayout}
*/
public addContent(oContent: sap.ui.core.Control, oPos: any): sap.ui.commons.layout.AbsoluteLayout;
/**
* Adds some position to the aggregation {@link #getPositions positions}.
* @param {sap.ui.commons.layout.PositionContainer} oPosition - the position to add; if empty, nothing is inserted
* @returns {sap.ui.commons.layout.AbsoluteLayout} Reference to this
in order to allow method chaining
*/
public addPosition(oPosition: sap.ui.commons.layout.PositionContainer): sap.ui.commons.layout.AbsoluteLayout;
/**
* Destroys all aggregated position containers and their child controls. Returns 'this' to allow method chaining.
* @returns {sap.ui.commons.layout.AbsoluteLayout}
*/
public destroyContent(): sap.ui.commons.layout.AbsoluteLayout;
/**
* Destroys all the positions in the aggregation {@link #getPositions positions}.
* @returns {sap.ui.commons.layout.AbsoluteLayout} Reference to this
in order to allow method chaining
*/
public destroyPositions(): sap.ui.commons.layout.AbsoluteLayout;
/**
* Creates a new subclass of class sap.ui.commons.layout.AbsoluteLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns an array of the controls contained in the aggregated position containers (might be empty).
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getHeight height}.
*
* The overall height of the control. When not set, 100% is automatically set.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getHorizontalScrolling horizontalScrolling}.
*
* 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
*
* Default value is Hidden
.
* @returns {sap.ui.core.Scrolling} Value of property horizontalScrolling
*/
public getHorizontalScrolling(): sap.ui.core.Scrolling;
/**
* Returns a metadata object for class sap.ui.commons.layout.AbsoluteLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getPositions positions}.
*
* Positioned child controls within the layout
* @returns {sap.ui.commons.layout.PositionContainer[]}
*/
public getPositions(): sap.ui.commons.layout.PositionContainer[];
/**
* Gets current value of property {@link #getVerticalScrolling verticalScrolling}.
*
* 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
*
* Default value is Hidden
.
* @returns {sap.ui.core.Scrolling} Value of property verticalScrolling
*/
public getVerticalScrolling(): sap.ui.core.Scrolling;
/**
* Gets current value of property {@link #getWidth width}.
*
* The overall width of the control. When not set, 100% is automatically set.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Control in the aggregated position containers, and returns the index of the container in the positions aggregation
* if found, or '-1' otherwise.
* @param {sap.ui.core.Control} oContent - The content of which the index is looked for
* @returns {number}
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.commons.layout.PositionContainer
in the aggregation {@link #getPositions positions}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.layout.PositionContainer} oPosition - The position whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfPosition(oPosition: sap.ui.commons.layout.PositionContainer): number;
/**
* Inserts the given control and a corresponding position container into the aggregation named 'positions'. Returns 'this' to allow method chaining.
* @param {sap.ui.core.Control} oContent - The content to insert; if empty, nothing is inserted
* @param {number} iIndex - The '0'-based index where the content shall be inserted at. For a negative value of iIndex, the content is inserted at position '0'; for a value greater than the current size of the aggregation, the content is inserted at the last position.
* @param {any} oPos - JSON-like object which defines the position of the child control within the layout. The object is expected to have one or more from the attribute set top, bottom, left, right; each with a value of type sap.ui.core.CSSSize. If no object is given, the default is left=0px,right=0px.
* @returns {sap.ui.commons.layout.AbsoluteLayout}
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number, oPos: any): sap.ui.commons.layout.AbsoluteLayout;
/**
* Inserts a position into the aggregation {@link #getPositions positions}.
* @param {sap.ui.commons.layout.PositionContainer} oPosition - the position to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the position should be inserted at; for a negative value of iIndex
, the position is inserted at position 0; for a value greater than the current size of the aggregation, the position is inserted at the last position
* @returns {sap.ui.commons.layout.AbsoluteLayout} Reference to this
in order to allow method chaining
*/
public insertPosition(oPosition: sap.ui.commons.layout.PositionContainer, iIndex: number): sap.ui.commons.layout.AbsoluteLayout;
/**
* Removes all aggregated position containers. Returns an array of the controls contained in the removed position containers (might be empty).
* @returns {sap.ui.core.Control[]}
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getPositions positions}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.layout.PositionContainer[]} An array of the removed elements (might be empty)
*/
public removeAllPositions(): sap.ui.commons.layout.PositionContainer[];
/**
* Removes the given control and its corresponding position container from the aggregation named 'positions'.
* @param {any} oContent - The content control to remove, its ID, or the index of the corresponding position container in the 'positions' aggregation.
* @returns {sap.ui.core.Control}
*/
public removeContent(oContent: any): sap.ui.core.Control;
/**
* Removes a position from the aggregation {@link #getPositions positions}.
* @param {number|string|sap.ui.commons.layout.PositionContainer} vPosition - The position to remove or its index or id
* @returns {sap.ui.commons.layout.PositionContainer} The removed position or null
*/
public removePosition(vPosition: number|string|sap.ui.commons.layout.PositionContainer): sap.ui.commons.layout.PositionContainer;
/**
* Sets a new value for property {@link #getHeight height}.
*
* The overall height of the control. When not set, 100% is automatically set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.commons.layout.AbsoluteLayout} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.layout.AbsoluteLayout;
/**
* Sets a new value for property {@link #getHorizontalScrolling horizontalScrolling}.
*
* 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Hidden
.
* @param {sap.ui.core.Scrolling} sHorizontalScrolling - New value for property horizontalScrolling
* @returns {sap.ui.commons.layout.AbsoluteLayout} Reference to this
in order to allow method chaining
*/
public setHorizontalScrolling(sHorizontalScrolling: sap.ui.core.Scrolling): sap.ui.commons.layout.AbsoluteLayout;
/**
* Allows to set or change the position information of the given child control
* @param {sap.ui.core.Control} oControl - The child control for which to change the position information; if empty or not aggregated, nothing is changed
* @param {any} oPos - JSON-like object which defines the position of the child control. The object is expected to have one or more from the attribute set top, bottom, left, right; each with a value of type sap.ui.core.CSSSize. If no object is given, the default is used which is left=0px,right=0px.
* @returns {boolean}
*/
public setPositionOfChild(oControl: sap.ui.core.Control, oPos: any): boolean;
/**
* Sets a new value for property {@link #getVerticalScrolling verticalScrolling}.
*
* 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Hidden
.
* @param {sap.ui.core.Scrolling} sVerticalScrolling - New value for property verticalScrolling
* @returns {sap.ui.commons.layout.AbsoluteLayout} Reference to this
in order to allow method chaining
*/
public setVerticalScrolling(sVerticalScrolling: sap.ui.core.Scrolling): sap.ui.commons.layout.AbsoluteLayout;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The overall width of the control. When not set, 100% is automatically set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.layout.AbsoluteLayout} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.layout.AbsoluteLayout;
}
/**
* Background design (i.e. color), e.g. of a layout cell.
*/
export enum BackgroundDesign {
/**
* A background design suitable for borders.
*/
Border = "Border",
/**
* An opaque background design that looks dark filled.
*/
Fill1 = "Fill1",
/**
* An opaque background design that looks medium filled.
*/
Fill2 = "Fill2",
/**
* An opaque background design that looks light filled.
*/
Fill3 = "Fill3",
/**
* A background design suitable for headers.
*/
Header = "Header",
/**
* A plain but opaque background design.
*/
Plain = "Plain",
/**
* A transparent background.
*/
Transparent = "Transparent",
}
/**
* Based upon the border layout as it comes with the Java standard. Using this layout, you are able to divide your available UI space into five areas whose sizes can be defined. These areas are: Top: Header; Bottom: Footer; Begin: Left/right-hand side panel; Center: Content area
* in the middle; End: Right/left-hand side panel.
*/
export class BorderLayout extends sap.ui.core.Control {
/**
* Constructor for a new layout/BorderLayout.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds controls to the specified area
* @param {sap.ui.commons.layout.BorderLayoutAreaTypes} oAreaId - Specifies the area where controls will be added
* @param {sap.ui.core.Control} oControls - N controls can be submitted to be added. Each control is submitted as one argument.
*/
public addContent(oAreaId: sap.ui.commons.layout.BorderLayoutAreaTypes, oControls: sap.ui.core.Control): void;
/**
* Creates the specified area and adds the given controls to it. Returns the created area.
* @param {sap.ui.commons.layout.BorderLayoutAreaTypes} oAreaId - Specifies which area will be created. If the area is already available, the method call is ignored.
* @param {sap.ui.core.Control} oControls - Any number of controls can be submitted to be added to the newly created area; where each control is submitted as one argument.
* @returns {sap.ui.commons.layout.BorderLayoutArea}
*/
public createArea(oAreaId: sap.ui.commons.layout.BorderLayoutAreaTypes, oControls: sap.ui.core.Control): sap.ui.commons.layout.BorderLayoutArea;
/**
* Destroys the begin in the aggregation {@link #getBegin begin}.
* @returns {sap.ui.commons.layout.BorderLayout} Reference to this
in order to allow method chaining
*/
public destroyBegin(): sap.ui.commons.layout.BorderLayout;
/**
* Destroys the bottom in the aggregation {@link #getBottom bottom}.
* @returns {sap.ui.commons.layout.BorderLayout} Reference to this
in order to allow method chaining
*/
public destroyBottom(): sap.ui.commons.layout.BorderLayout;
/**
* Destroys the center in the aggregation {@link #getCenter center}.
* @returns {sap.ui.commons.layout.BorderLayout} Reference to this
in order to allow method chaining
*/
public destroyCenter(): sap.ui.commons.layout.BorderLayout;
/**
* Destroys the content of the specified area
* @param {sap.ui.commons.layout.BorderLayoutAreaTypes} oAreaId - Specifies the area whose content will be destroyed
*/
public destroyContent(oAreaId: sap.ui.commons.layout.BorderLayoutAreaTypes): void;
/**
* Destroys the end in the aggregation {@link #getEnd end}.
* @returns {sap.ui.commons.layout.BorderLayout} Reference to this
in order to allow method chaining
*/
public destroyEnd(): sap.ui.commons.layout.BorderLayout;
/**
* Destroys the top in the aggregation {@link #getTop top}.
* @returns {sap.ui.commons.layout.BorderLayout} Reference to this
in order to allow method chaining
*/
public destroyTop(): sap.ui.commons.layout.BorderLayout;
/**
* Creates a new subclass of class sap.ui.commons.layout.BorderLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the area of the given type. If the area does not exist, it will be created when create is set to true.
* @param {sap.ui.commons.layout.BorderLayoutAreaTypes} oAreaId
* @param {boolean} bCreate
* @returns {sap.ui.commons.layout.BorderLayoutAreaTypes}
*/
public getArea(oAreaId: sap.ui.commons.layout.BorderLayoutAreaTypes, bCreate: boolean): sap.ui.commons.layout.BorderLayoutAreaTypes;
/**
* Returns the object of the specified area. If the area does not exist, the area will be created and returned.
* @param {sap.ui.commons.layout.BorderLayoutAreaTypes} oAreaId - Specifies the area whose object will be returned.
* @returns {sap.ui.commons.layout.BorderLayoutArea}
*/
public getAreaById(oAreaId: sap.ui.commons.layout.BorderLayoutAreaTypes): sap.ui.commons.layout.BorderLayoutArea;
/**
* Returns a JSON-like object that contains all property values of the requested area
* @param {sap.ui.commons.layout.BorderLayoutAreaTypes} oAreaId - Specifies the area whose data will be returned
* @returns {any}
*/
public getAreaData(oAreaId: sap.ui.commons.layout.BorderLayoutAreaTypes): any;
/**
* Gets content of aggregation {@link #getBegin begin}.
*
* Represents the Begin area
* @returns {sap.ui.commons.layout.BorderLayoutArea}
*/
public getBegin(): sap.ui.commons.layout.BorderLayoutArea;
/**
* Gets content of aggregation {@link #getBottom bottom}.
*
* Represents the Bottom area
* @returns {sap.ui.commons.layout.BorderLayoutArea}
*/
public getBottom(): sap.ui.commons.layout.BorderLayoutArea;
/**
* Gets content of aggregation {@link #getCenter center}.
*
* Represents the Center area
* @returns {sap.ui.commons.layout.BorderLayoutArea}
*/
public getCenter(): sap.ui.commons.layout.BorderLayoutArea;
/**
* Returns all controls inside the specified area inside an array
* @param {sap.ui.commons.layout.BorderLayoutAreaTypes} oAreaId - Specifies the area whose content controls shall be returned.
* @returns {sap.ui.core.Control[]}
*/
public getContent(oAreaId: sap.ui.commons.layout.BorderLayoutAreaTypes): sap.ui.core.Control[];
/**
* Gets content of aggregation {@link #getEnd end}.
*
* Represents the End area
* @returns {sap.ui.commons.layout.BorderLayoutArea}
*/
public getEnd(): sap.ui.commons.layout.BorderLayoutArea;
/**
* Gets current value of property {@link #getHeight height}.
*
* Defines the overall height of the layout
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.commons.layout.BorderLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRtl rtl}.
*
* The RTL setting swaps the areas Begin and End. Since version 1.5.2, this property is deprecated and ignored as it conflicts with the central configuration for the page.
*
* Default value is false
.
* @returns {boolean} Value of property rtl
*/
public getRtl(): boolean;
/**
* Gets content of aggregation {@link #getTop top}.
*
* Represents the Top area
* @returns {sap.ui.commons.layout.BorderLayoutArea}
*/
public getTop(): sap.ui.commons.layout.BorderLayoutArea;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the overall width of the layout
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Determines the index of a given content control
* @param {sap.ui.commons.layout.BorderLayoutAreaTypes} oAreaId - Specifies the area that will be searched
* @param {sap.ui.core.Control} oContent - Specifies the control whose index will be searched
* @returns {number}
*/
public indexOfContent(oAreaId: sap.ui.commons.layout.BorderLayoutAreaTypes, oContent: sap.ui.core.Control): number;
/**
* Inserts controls to an area at a given index.
* @param {sap.ui.commons.layout.BorderLayoutAreaTypes} oAreaId - Specifies the area where the controls shall be inserted.
* @param {number} iIndex - Specifies the index where the controls shall be added. For a negative value of iIndex, the content is inserted at position '0'; for a value greater than the current size of the aggregation, the content is inserted at the last position.
* @param {sap.ui.core.Control} oControl - N controls can be submitted to be added. Each control is submitted as one argument.
*/
public insertContent(oAreaId: sap.ui.commons.layout.BorderLayoutAreaTypes, iIndex: number, oControl: sap.ui.core.Control): void;
/**
* Removes all content from an area
* @param {sap.ui.commons.layout.BorderLayoutAreaTypes} oAreaId - Specifies the area whose content shall be removed
*/
public removeAllContent(oAreaId: sap.ui.commons.layout.BorderLayoutAreaTypes): void;
/**
* Removes the content with the given index from an area
* @param {sap.ui.commons.layout.BorderLayoutAreaTypes} oAreaId - Specifies the area whose content shall be removed
* @param {number} iIndex - Specifies the index of the control that shall be removed
*/
public removeContent(oAreaId: sap.ui.commons.layout.BorderLayoutAreaTypes, iIndex: number): void;
/**
* Sets the properties of the specified area with the given values
* @param {sap.ui.commons.layout.BorderLayoutAreaTypes} oAreaId - Specifies the area whose properties will be set
* @param {any} oData - JSON-like object that contains the values to be set
*/
public setAreaData(oAreaId: sap.ui.commons.layout.BorderLayoutAreaTypes, oData: any): void;
/**
* Sets the aggregated {@link #getBegin begin}.
* @param {sap.ui.commons.layout.BorderLayoutArea} oBegin - The begin to set
* @returns {sap.ui.commons.layout.BorderLayout} Reference to this
in order to allow method chaining
*/
public setBegin(oBegin: sap.ui.commons.layout.BorderLayoutArea): sap.ui.commons.layout.BorderLayout;
/**
* Sets the aggregated {@link #getBottom bottom}.
* @param {sap.ui.commons.layout.BorderLayoutArea} oBottom - The bottom to set
* @returns {sap.ui.commons.layout.BorderLayout} Reference to this
in order to allow method chaining
*/
public setBottom(oBottom: sap.ui.commons.layout.BorderLayoutArea): sap.ui.commons.layout.BorderLayout;
/**
* Sets the aggregated {@link #getCenter center}.
* @param {sap.ui.commons.layout.BorderLayoutArea} oCenter - The center to set
* @returns {sap.ui.commons.layout.BorderLayout} Reference to this
in order to allow method chaining
*/
public setCenter(oCenter: sap.ui.commons.layout.BorderLayoutArea): sap.ui.commons.layout.BorderLayout;
/**
* Sets the aggregated {@link #getEnd end}.
* @param {sap.ui.commons.layout.BorderLayoutArea} oEnd - The end to set
* @returns {sap.ui.commons.layout.BorderLayout} Reference to this
in order to allow method chaining
*/
public setEnd(oEnd: sap.ui.commons.layout.BorderLayoutArea): sap.ui.commons.layout.BorderLayout;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Defines the overall height of the layout
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.commons.layout.BorderLayout} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.layout.BorderLayout;
/**
* Sets a new value for property {@link #getRtl rtl}.
*
* The RTL setting swaps the areas Begin and End. Since version 1.5.2, this property is deprecated and ignored as it conflicts with the central configuration for the page.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bRtl - New value for property rtl
* @returns {sap.ui.commons.layout.BorderLayout} Reference to this
in order to allow method chaining
*/
public setRtl(bRtl: boolean): sap.ui.commons.layout.BorderLayout;
/**
* Sets the aggregated {@link #getTop top}.
* @param {sap.ui.commons.layout.BorderLayoutArea} oTop - The top to set
* @returns {sap.ui.commons.layout.BorderLayout} Reference to this
in order to allow method chaining
*/
public setTop(oTop: sap.ui.commons.layout.BorderLayoutArea): sap.ui.commons.layout.BorderLayout;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the overall width of the layout
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.layout.BorderLayout} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.layout.BorderLayout;
}
/**
* The BorderLayoutArea represents one area of a BorderLayout
*/
export class BorderLayoutArea extends sap.ui.core.Element {
/**
* Constructor for a new layout/BorderLayoutArea.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.commons.layout.BorderLayoutArea} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.commons.layout.BorderLayoutArea;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.commons.layout.BorderLayoutArea} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.commons.layout.BorderLayoutArea;
/**
* Creates a new subclass of class sap.ui.commons.layout.BorderLayoutArea with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAreaId areaId}.
*
* Defines which area the element represents: top, begin, center, end, bottom
*
* Default value is top
.
* @returns {sap.ui.commons.layout.BorderLayoutAreaTypes} Value of property areaId
*/
public getAreaId(): sap.ui.commons.layout.BorderLayoutAreaTypes;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Controls within the area
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getContentAlign contentAlign}.
*
* The content alignment as CSS value
*
* Default value is left
.
* @returns {string} Value of property contentAlign
*/
public getContentAlign(): string;
/**
* Returns a metadata object for class sap.ui.commons.layout.BorderLayoutArea.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getOverflowX overflowX}.
*
* The overflow mode of the area in horizontal direction as CSS value
*
* Default value is auto
.
* @returns {string} Value of property overflowX
*/
public getOverflowX(): string;
/**
* Gets current value of property {@link #getOverflowY overflowY}.
*
* The overflow mode of the area in vertical direction as CSS value
*
* Default value is auto
.
* @returns {string} Value of property overflowY
*/
public getOverflowY(): string;
/**
* Gets current value of property {@link #getSize size}.
*
* Defines the height or the width. Is not used when the area element is in Center.
*
* Default value is 100px
.
* @returns {sap.ui.core.CSSSize} Value of property size
*/
public getSize(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Invisible controls are not rendered
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.commons.layout.BorderLayoutArea} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.commons.layout.BorderLayoutArea;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getAreaId areaId}.
*
* Defines which area the element represents: top, begin, center, end, bottom
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is top
.
* @param {sap.ui.commons.layout.BorderLayoutAreaTypes} sAreaId - New value for property areaId
* @returns {sap.ui.commons.layout.BorderLayoutArea} Reference to this
in order to allow method chaining
*/
public setAreaId(sAreaId: sap.ui.commons.layout.BorderLayoutAreaTypes): sap.ui.commons.layout.BorderLayoutArea;
/**
* Sets a new value for property {@link #getContentAlign contentAlign}.
*
* The content alignment as CSS value
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is left
.
* @param {string} sContentAlign - New value for property contentAlign
* @returns {sap.ui.commons.layout.BorderLayoutArea} Reference to this
in order to allow method chaining
*/
public setContentAlign(sContentAlign: string): sap.ui.commons.layout.BorderLayoutArea;
/**
* Sets a new value for property {@link #getOverflowX overflowX}.
*
* The overflow mode of the area in horizontal direction as CSS value
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {string} sOverflowX - New value for property overflowX
* @returns {sap.ui.commons.layout.BorderLayoutArea} Reference to this
in order to allow method chaining
*/
public setOverflowX(sOverflowX: string): sap.ui.commons.layout.BorderLayoutArea;
/**
* Sets a new value for property {@link #getOverflowY overflowY}.
*
* The overflow mode of the area in vertical direction as CSS value
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {string} sOverflowY - New value for property overflowY
* @returns {sap.ui.commons.layout.BorderLayoutArea} Reference to this
in order to allow method chaining
*/
public setOverflowY(sOverflowY: string): sap.ui.commons.layout.BorderLayoutArea;
/**
* Sets a new value for property {@link #getSize size}.
*
* Defines the height or the width. Is not used when the area element is in Center.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100px
.
* @param {sap.ui.core.CSSSize} sSize - New value for property size
* @returns {sap.ui.commons.layout.BorderLayoutArea} Reference to this
in order to allow method chaining
*/
public setSize(sSize: sap.ui.core.CSSSize): sap.ui.commons.layout.BorderLayoutArea;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Invisible controls are not rendered
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.ui.commons.layout.BorderLayoutArea} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.commons.layout.BorderLayoutArea;
}
/**
* The type (=position) of a BorderLayoutArea
*/
export enum BorderLayoutAreaTypes {
/**
* Value to identify the begin area.
*/
begin = "begin",
/**
* Value to identify the bottom area.
*/
bottom = "bottom",
/**
* Value to identify the center area.
*/
center = "center",
/**
* Value to identify the end area.
*/
end = "end",
/**
* Value to identify the top area.
*/
top = "top",
}
/**
* Horizontal alignment, e.g. of a layout cell's content within the cell's borders.
* Note that some values depend on the current locale's writing direction while
* others do not.
*/
export enum HAlign {
/**
* Aligned towards the beginning of a line, in the current locale's writing direction.
*/
Begin = "Begin",
/**
* Horizontally centered.
*/
Center = "Center",
/**
* Aligned towards the end of a line, in the current locale's writing direction.
*/
End = "End",
/**
* Left aligned, regardless of the current locale's writing direction.
*/
Left = "Left",
/**
* Right aligned, regardless of the current locale's writing direction.
*/
Right = "Right",
}
/**
* A layout that provides support for horizontal alignment of controls
*/
export class HorizontalLayout extends sap.ui.layout.HorizontalLayout {
/**
* Constructor for a new layout/HorizontalLayout.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.layout.HorizontalLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.HorizontalLayout.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.layout.HorizontalLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
*
* A matrix layout arranges controls in a grid structure, using rows which
* need not have the same number of cells.
*
*
*
* It uses predefined cell classes that guarantee appropriate distances
* between cells in the grid. The cell's vGutter
property lets
* you specify additional horizontal distances easily. You can set these
* additional distances (known as gutters) with or without separators.
* The distance for each cell is specified by assigning a specific
* enumeration value of the class LayoutCellSeparator
of the
* matrix data object.
*
*
*
* You should avoid nesting matrix layouts. You should only use a
* matrix layout if you need to align controls horizontally across rows.
*
*/
export class MatrixLayout extends sap.ui.core.Control {
/**
* Constructor for a new layout/MatrixLayout.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some row to the aggregation {@link #getRows rows}.
* @param {sap.ui.commons.layout.MatrixLayoutRow} oRow - the row to add; if empty, nothing is inserted
* @returns {sap.ui.commons.layout.MatrixLayout} Reference to this
in order to allow method chaining
*/
public addRow(oRow: sap.ui.commons.layout.MatrixLayoutRow): sap.ui.commons.layout.MatrixLayout;
/**
* Creates a new matrix layout row and appends it to this matrix layout.
*
* Each argument must be either a matrix layout cell, which is added to the row
* "as is", or an arbitrary content control, which is wrapped with a new
* (default) matrix layout cell first and then added to the row.
* @param {sap.ui.core.Control|sap.ui.commons.layout.MatrixLayoutCell|string} rowContent - to add
* @returns {sap.ui.commons.layout.MatrixLayout} this
to allow method chaining
*/
public createRow(rowContent: sap.ui.core.Control|sap.ui.commons.layout.MatrixLayoutCell|string): sap.ui.commons.layout.MatrixLayout;
/**
* Destroys all the rows in the aggregation {@link #getRows rows}.
* @returns {sap.ui.commons.layout.MatrixLayout} Reference to this
in order to allow method chaining
*/
public destroyRows(): sap.ui.commons.layout.MatrixLayout;
/**
* Creates a new subclass of class sap.ui.commons.layout.MatrixLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getColumns columns}.
*
* Number of columns. If not specified, the number of columns will be determined from the given cells.
* @returns {number} Value of property columns
*/
public getColumns(): number;
/**
* Gets current value of property {@link #getHeight height}.
*
* CSS height of the matrix layout.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getLayoutFixed layoutFixed}.
*
* Sets the table layout. If fixed the width parameter of a column has priority, if not the width of the content of the colums has priority.
* The default is "fixed".
* If the fixed layout is used an adequate width of the MatrixLayout should be provided. Otherwise the column width displayed could be different than the given ones because of browser dependend optimazations.
*
* Default value is true
.
* @returns {boolean} Value of property layoutFixed
*/
public getLayoutFixed(): boolean;
/**
* Returns a metadata object for class sap.ui.commons.layout.MatrixLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getRows rows}.
*
* The matrix layout's individual rows.
* @returns {sap.ui.commons.layout.MatrixLayoutRow[]}
*/
public getRows(): sap.ui.commons.layout.MatrixLayoutRow[];
/**
* Gets current value of property {@link #getWidth width}.
*
* CSS width of the matrix layout.
* If the LayoutFixed = true an adequate width should be provided.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getWidths widths}.
*
* Widths of the columns. Use an array to define the widths of the columns.
* If a column shall have an automatical sizing enter "auto" for this column width.
* @returns {sap.ui.core.CSSSize[]} Value of property widths
*/
public getWidths(): sap.ui.core.CSSSize[];
/**
* Checks for the provided sap.ui.commons.layout.MatrixLayoutRow
in the aggregation {@link #getRows rows}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.layout.MatrixLayoutRow} oRow - The row whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfRow(oRow: sap.ui.commons.layout.MatrixLayoutRow): number;
/**
* Inserts a row into the aggregation {@link #getRows rows}.
* @param {sap.ui.commons.layout.MatrixLayoutRow} oRow - the row to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the row should be inserted at; for a negative value of iIndex
, the row is inserted at position 0; for a value greater than the current size of the aggregation, the row is inserted at the last position
* @returns {sap.ui.commons.layout.MatrixLayout} Reference to this
in order to allow method chaining
*/
public insertRow(oRow: sap.ui.commons.layout.MatrixLayoutRow, iIndex: number): sap.ui.commons.layout.MatrixLayout;
/**
* Removes all the controls from the aggregation {@link #getRows rows}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.layout.MatrixLayoutRow[]} An array of the removed elements (might be empty)
*/
public removeAllRows(): sap.ui.commons.layout.MatrixLayoutRow[];
/**
* Removes a row from the aggregation {@link #getRows rows}.
* @param {number|string|sap.ui.commons.layout.MatrixLayoutRow} vRow - The row to remove or its index or id
* @returns {sap.ui.commons.layout.MatrixLayoutRow} The removed row or null
*/
public removeRow(vRow: number|string|sap.ui.commons.layout.MatrixLayoutRow): sap.ui.commons.layout.MatrixLayoutRow;
/**
* Sets a new value for property {@link #getColumns columns}.
*
* Number of columns. If not specified, the number of columns will be determined from the given cells.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iColumns - New value for property columns
* @returns {sap.ui.commons.layout.MatrixLayout} Reference to this
in order to allow method chaining
*/
public setColumns(iColumns: number): sap.ui.commons.layout.MatrixLayout;
/**
* Sets a new value for property {@link #getHeight height}.
*
* CSS height of the matrix layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.commons.layout.MatrixLayout} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.layout.MatrixLayout;
/**
* Sets a new value for property {@link #getLayoutFixed layoutFixed}.
*
* Sets the table layout. If fixed the width parameter of a column has priority, if not the width of the content of the colums has priority.
* The default is "fixed".
* If the fixed layout is used an adequate width of the MatrixLayout should be provided. Otherwise the column width displayed could be different than the given ones because of browser dependend optimazations.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bLayoutFixed - New value for property layoutFixed
* @returns {sap.ui.commons.layout.MatrixLayout} Reference to this
in order to allow method chaining
*/
public setLayoutFixed(bLayoutFixed: boolean): sap.ui.commons.layout.MatrixLayout;
/**
* Sets a new value for property {@link #getWidth width}.
*
* CSS width of the matrix layout.
* If the LayoutFixed = true an adequate width should be provided.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.layout.MatrixLayout} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.layout.MatrixLayout;
/**
* Sets a new value for property {@link #getWidths widths}.
*
* Widths of the columns. Use an array to define the widths of the columns.
* If a column shall have an automatical sizing enter "auto" for this column width.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize[]} sWidths - New value for property widths
* @returns {sap.ui.commons.layout.MatrixLayout} Reference to this
in order to allow method chaining
*/
public setWidths(sWidths: sap.ui.core.CSSSize[]): sap.ui.commons.layout.MatrixLayout;
}
/**
* Non-control element used as part of a matrix layout's inner structure.
*/
export class MatrixLayoutCell extends sap.ui.core.Element {
/**
* Constructor for a new layout/MatrixLayoutCell.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.commons.layout.MatrixLayoutCell} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.commons.layout.MatrixLayoutCell;
/**
* The string given as "sStyleClass" will be added to the "class" attribute of this element's root HTML element.
*
* This method is intended to be used to mark controls as being of a special type for which
* special styling can be provided using CSS selectors that reference this style class name.
*
*
* Example:
* myButton.addStyleClass("myRedTextButton"); // add a CSS class to one button instance
*
* ...and in CSS:
* .myRedTextButton {
* color: red;
* }
*
*
* This will add the CSS class "myRedTextButton" to the Button HTML and the CSS code above will then
* make the text in this particular button red.
*
* Only characters allowed inside HTML attributes are allowed.
* Quotes are not allowed and this method will ignore any strings containing quotes.
* Strings containing spaces are interpreted as ONE custom style class (even though CSS selectors interpret them
* as different classes) and can only removed later by calling removeStyleClass() with exactly the
* same (space-containing) string as parameter.
* Multiple calls with the same sStyleClass will have no different effect than calling once.
* If sStyleClass is null, the call is ignored.
*
* Returns this
to allow method chaining
* @param {string} sStyleClass - the CSS class name to be added
* @returns {sap.ui.commons.layout.MatrixLayoutCell}
*/
public addStyleClass(sStyleClass: string): sap.ui.commons.layout.MatrixLayoutCell;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.commons.layout.MatrixLayoutCell} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.commons.layout.MatrixLayoutCell;
/**
* Creates a new subclass of class sap.ui.commons.layout.MatrixLayoutCell with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getBackgroundDesign backgroundDesign}.
*
* Determines the matrix layout cell's background design.
*
* Default value is Transparent
.
* @returns {sap.ui.commons.layout.BackgroundDesign} Value of property backgroundDesign
*/
public getBackgroundDesign(): sap.ui.commons.layout.BackgroundDesign;
/**
* Gets current value of property {@link #getColSpan colSpan}.
*
* Determines how many columns of the underlying grid structure are occupied
* by this matrix layout cell.
*
* Default value is 1
.
* @returns {number} Value of property colSpan
*/
public getColSpan(): number;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The matrix layout cell's content (arbitrary controls).
*
* If the matrix row has a defined height and the matrix has layoutFixed = true, the controls inside of a cell should all use the same unit for its height property.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getHAlign hAlign}.
*
* Determines the horizontal alignment of the matrix layout cell's content
* with the cell's borders.
*
* Default value is Begin
.
* @returns {sap.ui.commons.layout.HAlign} Value of property hAlign
*/
public getHAlign(): sap.ui.commons.layout.HAlign;
/**
* Returns a metadata object for class sap.ui.commons.layout.MatrixLayoutCell.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPadding padding}.
*
* Determines the padding of the matrix layout cell's content within the
* cell's borders. The default value is appropriate for all cells in a
* form-like layout. Consider to remove the padding on the outer layout in
* case of nesting.
*
* Default value is End
.
* @returns {sap.ui.commons.layout.Padding} Value of property padding
*/
public getPadding(): sap.ui.commons.layout.Padding;
/**
* Gets current value of property {@link #getRowSpan rowSpan}.
*
* Determines how many rows of the underlying grid structure are occupied by this matrix layout cell.
* In case a row-height is used, all rows affected by the RowSpan must have the same unit.
*
* Default value is 1
.
* @returns {number} Value of property rowSpan
*/
public getRowSpan(): number;
/**
* Gets current value of property {@link #getSeparation separation}.
*
* Determines how a matrix layout cell is separated from its predecessor,
* via a vertical gutter of variable width, with or without a vertical line.
*
* Default value is None
.
* @returns {sap.ui.commons.layout.Separation} Value of property separation
*/
public getSeparation(): sap.ui.commons.layout.Separation;
/**
* Gets current value of property {@link #getVAlign vAlign}.
*
* Determines the vertical alignment of the matrix layout cell's content
* with the cell's borders.
*
* Default value is Middle
.
* @returns {sap.ui.commons.layout.VAlign} Value of property vAlign
*/
public getVAlign(): sap.ui.commons.layout.VAlign;
/**
* Returns true if the given style class string is valid and if this Element has this style class set via a previous call to addStyleClass().
* @param {string} sStyleClass - the style to check for
* @returns {boolean}
*/
public hasStyleClass(sStyleClass: string): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.commons.layout.MatrixLayoutCell} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.commons.layout.MatrixLayoutCell;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes the given string from the list of custom style classes that have been set previously.
* Regular style classes like "sapUiBtn" cannot be removed.
*
* Returns this
to allow method chaining
* @param {string} sStyleClass - the style to be removed
* @returns {sap.ui.commons.layout.MatrixLayoutCell}
*/
public removeStyleClass(sStyleClass: string): sap.ui.commons.layout.MatrixLayoutCell;
/**
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
*
* Determines the matrix layout cell's background design.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Transparent
.
* @param {sap.ui.commons.layout.BackgroundDesign} sBackgroundDesign - New value for property backgroundDesign
* @returns {sap.ui.commons.layout.MatrixLayoutCell} Reference to this
in order to allow method chaining
*/
public setBackgroundDesign(sBackgroundDesign: sap.ui.commons.layout.BackgroundDesign): sap.ui.commons.layout.MatrixLayoutCell;
/**
* Sets a new value for property {@link #getColSpan colSpan}.
*
* Determines how many columns of the underlying grid structure are occupied
* by this matrix layout cell.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} iColSpan - New value for property colSpan
* @returns {sap.ui.commons.layout.MatrixLayoutCell} Reference to this
in order to allow method chaining
*/
public setColSpan(iColSpan: number): sap.ui.commons.layout.MatrixLayoutCell;
/**
* Sets a new value for property {@link #getHAlign hAlign}.
*
* Determines the horizontal alignment of the matrix layout cell's content
* with the cell's borders.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Begin
.
* @param {sap.ui.commons.layout.HAlign} sHAlign - New value for property hAlign
* @returns {sap.ui.commons.layout.MatrixLayoutCell} Reference to this
in order to allow method chaining
*/
public setHAlign(sHAlign: sap.ui.commons.layout.HAlign): sap.ui.commons.layout.MatrixLayoutCell;
/**
* Sets a new value for property {@link #getPadding padding}.
*
* Determines the padding of the matrix layout cell's content within the
* cell's borders. The default value is appropriate for all cells in a
* form-like layout. Consider to remove the padding on the outer layout in
* case of nesting.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is End
.
* @param {sap.ui.commons.layout.Padding} sPadding - New value for property padding
* @returns {sap.ui.commons.layout.MatrixLayoutCell} Reference to this
in order to allow method chaining
*/
public setPadding(sPadding: sap.ui.commons.layout.Padding): sap.ui.commons.layout.MatrixLayoutCell;
/**
* Sets a new value for property {@link #getRowSpan rowSpan}.
*
* Determines how many rows of the underlying grid structure are occupied by this matrix layout cell.
* In case a row-height is used, all rows affected by the RowSpan must have the same unit.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} iRowSpan - New value for property rowSpan
* @returns {sap.ui.commons.layout.MatrixLayoutCell} Reference to this
in order to allow method chaining
*/
public setRowSpan(iRowSpan: number): sap.ui.commons.layout.MatrixLayoutCell;
/**
* Sets a new value for property {@link #getSeparation separation}.
*
* Determines how a matrix layout cell is separated from its predecessor,
* via a vertical gutter of variable width, with or without a vertical line.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.commons.layout.Separation} sSeparation - New value for property separation
* @returns {sap.ui.commons.layout.MatrixLayoutCell} Reference to this
in order to allow method chaining
*/
public setSeparation(sSeparation: sap.ui.commons.layout.Separation): sap.ui.commons.layout.MatrixLayoutCell;
/**
* Sets a new value for property {@link #getVAlign vAlign}.
*
* Determines the vertical alignment of the matrix layout cell's content
* with the cell's borders.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Middle
.
* @param {sap.ui.commons.layout.VAlign} sVAlign - New value for property vAlign
* @returns {sap.ui.commons.layout.MatrixLayoutCell} Reference to this
in order to allow method chaining
*/
public setVAlign(sVAlign: sap.ui.commons.layout.VAlign): sap.ui.commons.layout.MatrixLayoutCell;
}
/**
* Non-control element used as part of a matrix layout's inner structure.
*/
export class MatrixLayoutRow extends sap.ui.core.Element {
/**
* Constructor for a new layout/MatrixLayoutRow.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some cell to the aggregation {@link #getCells cells}.
* @param {sap.ui.commons.layout.MatrixLayoutCell} oCell - the cell to add; if empty, nothing is inserted
* @returns {sap.ui.commons.layout.MatrixLayoutRow} Reference to this
in order to allow method chaining
*/
public addCell(oCell: sap.ui.commons.layout.MatrixLayoutCell): sap.ui.commons.layout.MatrixLayoutRow;
/**
* The string given as "sStyleClass" will be added to the "class" attribute of this element's root HTML element.
*
* This method is intended to be used to mark controls as being of a special type for which
* special styling can be provided using CSS selectors that reference this style class name.
*
*
* Example:
* myButton.addStyleClass("myRedTextButton"); // add a CSS class to one button instance
*
* ...and in CSS:
* .myRedTextButton {
* color: red;
* }
*
*
* This will add the CSS class "myRedTextButton" to the Button HTML and the CSS code above will then
* make the text in this particular button red.
*
* Only characters allowed inside HTML attributes are allowed.
* Quotes are not allowed and this method will ignore any strings containing quotes.
* Strings containing spaces are interpreted as ONE custom style class (even though CSS selectors interpret them
* as different classes) and can only removed later by calling removeStyleClass() with exactly the
* same (space-containing) string as parameter.
* Multiple calls with the same sStyleClass will have no different effect than calling once.
* If sStyleClass is null, the call is ignored.
*
* Returns this
to allow method chaining
* @param {string} sStyleClass - the CSS class name to be added
* @returns {sap.ui.commons.layout.MatrixLayoutRow}
*/
public addStyleClass(sStyleClass: string): sap.ui.commons.layout.MatrixLayoutRow;
/**
* Destroys all the cells in the aggregation {@link #getCells cells}.
* @returns {sap.ui.commons.layout.MatrixLayoutRow} Reference to this
in order to allow method chaining
*/
public destroyCells(): sap.ui.commons.layout.MatrixLayoutRow;
/**
* Creates a new subclass of class sap.ui.commons.layout.MatrixLayoutRow with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getCells cells}.
*
* The matrix layout row's individual cells.
* @returns {sap.ui.commons.layout.MatrixLayoutCell[]}
*/
public getCells(): sap.ui.commons.layout.MatrixLayoutCell[];
/**
* Gets current value of property {@link #getHeight height}.
*
* Height of the row.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.commons.layout.MatrixLayoutRow.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns true if the given style class string is valid and if this Element has this style class set via a previous call to addStyleClass().
* @param {string} sStyleClass - the style to check for
* @returns {boolean}
*/
public hasStyleClass(sStyleClass: string): boolean;
/**
* Checks for the provided sap.ui.commons.layout.MatrixLayoutCell
in the aggregation {@link #getCells cells}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.layout.MatrixLayoutCell} oCell - The cell whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfCell(oCell: sap.ui.commons.layout.MatrixLayoutCell): number;
/**
* Inserts a cell into the aggregation {@link #getCells cells}.
* @param {sap.ui.commons.layout.MatrixLayoutCell} oCell - the cell to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the cell should be inserted at; for a negative value of iIndex
, the cell is inserted at position 0; for a value greater than the current size of the aggregation, the cell is inserted at the last position
* @returns {sap.ui.commons.layout.MatrixLayoutRow} Reference to this
in order to allow method chaining
*/
public insertCell(oCell: sap.ui.commons.layout.MatrixLayoutCell, iIndex: number): sap.ui.commons.layout.MatrixLayoutRow;
/**
* Removes all the controls from the aggregation {@link #getCells cells}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.layout.MatrixLayoutCell[]} An array of the removed elements (might be empty)
*/
public removeAllCells(): sap.ui.commons.layout.MatrixLayoutCell[];
/**
* Removes a cell from the aggregation {@link #getCells cells}.
* @param {number|string|sap.ui.commons.layout.MatrixLayoutCell} vCell - The cell to remove or its index or id
* @returns {sap.ui.commons.layout.MatrixLayoutCell} The removed cell or null
*/
public removeCell(vCell: number|string|sap.ui.commons.layout.MatrixLayoutCell): sap.ui.commons.layout.MatrixLayoutCell;
/**
* Removes the given string from the list of custom style classes that have been set previously.
* Regular style classes like "sapUiBtn" cannot be removed.
*
* Returns this
to allow method chaining
* @param {string} sStyleClass - the style to be removed
* @returns {sap.ui.commons.layout.MatrixLayoutRow}
*/
public removeStyleClass(sStyleClass: string): sap.ui.commons.layout.MatrixLayoutRow;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Height of the row.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.commons.layout.MatrixLayoutRow} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.layout.MatrixLayoutRow;
}
/**
* Padding, e.g. of a layout cell's content within the cell's borders.
* Note that all options except "None" include a padding of 2px at the top and
* bottom, and differ only in the presence of a 4px padding towards the beginning
* or end of a line, in the current locale's writing direction.
*/
export enum Padding {
/**
* Top and bottom padding of 2px.
* Padding of 4px towards the beginning of a line, in the current locale's
* writing direction, but none towards its end.
*/
Begin = "Begin",
/**
* Top and bottom padding of 2px.
* Padding of 4px towards both the beginning and end of a line.
*/
Both = "Both",
/**
* Top and bottom padding of 2px.
* Padding of 4px towards the end of a line, in the current locale's
* writing direction, but none towards its beginning.
*/
End = "End",
/**
* Top and bottom padding of 2px.
* No padding towards neither the beginning nor end of a line.
*/
Neither = "Neither",
/**
* No padding at all.
*/
None = "None",
}
/**
* Is used to specify the position of a control in the AbsoluteLayout
*/
export class PositionContainer extends sap.ui.core.Element {
/**
* Constructor for a new layout/PositionContainer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Destroys the control in the aggregation {@link #getControl control}.
* @returns {sap.ui.commons.layout.PositionContainer} Reference to this
in order to allow method chaining
*/
public destroyControl(): sap.ui.commons.layout.PositionContainer;
/**
* Creates a new subclass of class sap.ui.commons.layout.PositionContainer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getBottom bottom}.
*
* Defines the distance to the bottom of the layout (as specified in HTML)
* @returns {sap.ui.core.CSSSize} Value of property bottom
*/
public getBottom(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getCenterHorizontally centerHorizontally}.
*
* Indicates whether this container shall be centered horizontally within the AbsoluteLayout area.
* The values of the attributes left and right are ignored when this feature is activated.
*
* Default value is false
.
* @returns {boolean} Value of property centerHorizontally
*/
public getCenterHorizontally(): boolean;
/**
* Gets current value of property {@link #getCenterVertically centerVertically}.
*
* Indicates whether this container should be centered vertically within the AbsoluteLayout area.
* The values of the attributes top and bottom are ignored when this feature is activated.
*
* Default value is false
.
* @returns {boolean} Value of property centerVertically
*/
public getCenterVertically(): boolean;
/**
* Gets content of aggregation {@link #getControl control}.
*
* Child control of the position container
* @returns {sap.ui.core.Control}
*/
public getControl(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getLeft left}.
*
* Defines the distance to the left of the layout (as specified in HTML)
* @returns {sap.ui.core.CSSSize} Value of property left
*/
public getLeft(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.commons.layout.PositionContainer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRight right}.
*
* Defines the distance to the right of the layout (as specified in HTML)
* @returns {sap.ui.core.CSSSize} Value of property right
*/
public getRight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getTop top}.
*
* Defines the distance to the top of the layout (as specified in HTML)
* @returns {sap.ui.core.CSSSize} Value of property top
*/
public getTop(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getBottom bottom}.
*
* Defines the distance to the bottom of the layout (as specified in HTML)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sBottom - New value for property bottom
* @returns {sap.ui.commons.layout.PositionContainer} Reference to this
in order to allow method chaining
*/
public setBottom(sBottom: sap.ui.core.CSSSize): sap.ui.commons.layout.PositionContainer;
/**
* Sets a new value for property {@link #getCenterHorizontally centerHorizontally}.
*
* Indicates whether this container shall be centered horizontally within the AbsoluteLayout area.
* The values of the attributes left and right are ignored when this feature is activated.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bCenterHorizontally - New value for property centerHorizontally
* @returns {sap.ui.commons.layout.PositionContainer} Reference to this
in order to allow method chaining
*/
public setCenterHorizontally(bCenterHorizontally: boolean): sap.ui.commons.layout.PositionContainer;
/**
* Sets a new value for property {@link #getCenterVertically centerVertically}.
*
* Indicates whether this container should be centered vertically within the AbsoluteLayout area.
* The values of the attributes top and bottom are ignored when this feature is activated.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bCenterVertically - New value for property centerVertically
* @returns {sap.ui.commons.layout.PositionContainer} Reference to this
in order to allow method chaining
*/
public setCenterVertically(bCenterVertically: boolean): sap.ui.commons.layout.PositionContainer;
/**
* Sets the aggregated {@link #getControl control}.
* @param {sap.ui.core.Control} oControl - The control to set
* @returns {sap.ui.commons.layout.PositionContainer} Reference to this
in order to allow method chaining
*/
public setControl(oControl: sap.ui.core.Control): sap.ui.commons.layout.PositionContainer;
/**
* Sets a new value for property {@link #getLeft left}.
*
* Defines the distance to the left of the layout (as specified in HTML)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sLeft - New value for property left
* @returns {sap.ui.commons.layout.PositionContainer} Reference to this
in order to allow method chaining
*/
public setLeft(sLeft: sap.ui.core.CSSSize): sap.ui.commons.layout.PositionContainer;
/**
* Sets a new value for property {@link #getRight right}.
*
* Defines the distance to the right of the layout (as specified in HTML)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sRight - New value for property right
* @returns {sap.ui.commons.layout.PositionContainer} Reference to this
in order to allow method chaining
*/
public setRight(sRight: sap.ui.core.CSSSize): sap.ui.commons.layout.PositionContainer;
/**
* Sets a new value for property {@link #getTop top}.
*
* Defines the distance to the top of the layout (as specified in HTML)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sTop - New value for property top
* @returns {sap.ui.commons.layout.PositionContainer} Reference to this
in order to allow method chaining
*/
public setTop(sTop: sap.ui.core.CSSSize): sap.ui.commons.layout.PositionContainer;
/**
* Updates the position properties of the container according to the given position in JSON style.
* @param {any} oPos - JSON-like object which defines the position of the child control in the absolute layout. The object is expected to have one or more out of the attributes top, bottom, left, right (each with a value of type sap.ui.core.CSSSize). If no object is given, nothing is updated.
*/
public updatePosition(oPos: any): void;
}
/**
* This is a layout where several controls can be added. These controls are blown up to fit a whole line. If the window resizes the controls are moved between the lines and resized again.
*/
export class ResponsiveFlowLayout extends sap.ui.layout.ResponsiveFlowLayout {
/**
* Constructor for a new layout/ResponsiveFlowLayout.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.layout.ResponsiveFlowLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.ResponsiveFlowLayout.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.layout.ResponsiveFlowLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* This is a LayoutData Element that can be added to a control if this control is used within a ResponsiveFlowLayout
*/
export class ResponsiveFlowLayoutData extends sap.ui.layout.ResponsiveFlowLayoutData {
/**
* Constructor for a new layout/ResponsiveFlowLayoutData.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.layout.ResponsiveFlowLayoutData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.ResponsiveFlowLayoutData.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Getter for property margin
.
* This property prevents any margin of the element if set to false
*
* Default value is true
* @returns {boolean} the value of property margin
*/
public getMargin(): boolean;
/**
* Returns a metadata object for class sap.ui.commons.layout.ResponsiveFlowLayoutData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Setter for property margin
.
*
* Default value is true
* @param {boolean} bMargin - new value for property margin
* @returns {sap.ui.layout.ResponsiveFlowLayoutData} this
to allow method chaining
*/
public setMargin(bMargin: boolean): sap.ui.layout.ResponsiveFlowLayoutData;
}
/**
* Separation, e.g. of a layout cell from its neighbor, via a vertical gutter of
* defined width, with or without a vertical line in its middle.
*/
export enum Separation {
/**
* A large (63px) vertical gutter without a vertical line.
*/
Large = "Large",
/**
* A large (63px) vertical gutter with a vertical line in its middle.
*/
LargeWithLine = "LargeWithLine",
/**
* A medium (31px) vertical gutter without a vertical line.
*/
Medium = "Medium",
/**
* A medium (31px) vertical gutter with a vertical line in its middle.
*/
MediumWithLine = "MediumWithLine",
/**
* No gutter at all (0px), and without a vertical line, of course.
*/
None = "None",
/**
* A small (17px) vertical gutter without a vertical line.
*/
Small = "Small",
/**
* A small (17px) vertical gutter with a vertical line in its middle.
*/
SmallWithLine = "SmallWithLine",
}
/**
* Vertical alignment, e.g. of a layout cell's content within the cell's borders.
*/
export enum VAlign {
/**
* Aligned at the bottom.
*/
Bottom = "Bottom",
/**
* Vertically centered.
*/
Middle = "Middle",
/**
* Aligned at the top.
*/
Top = "Top",
}
/**
* In this layout the elemnts are orderd one below the other
*/
export class VerticalLayout extends sap.ui.layout.VerticalLayout {
/**
* Constructor for a new layout/VerticalLayout.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.layout.VerticalLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.VerticalLayout.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.layout.VerticalLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
}
/**
* Provides an absolute or relative reference to an internal or external URL. The classical target parameters are supported.
* Another usage scenario is triggering an action, for example to open a popup window. In both cases, the link is a hypertext link.
*/
export class Link extends sap.ui.core.Control {
/**
* Constructor for a new Link.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Link} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.Link;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Link} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.Link;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.commons.Link
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Link
itself.
*
* Event is fired when the user clicks the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Link
itself
* @returns {sap.ui.commons.Link} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.ui.commons.Link;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.commons.Link
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Link
itself.
*
* Event is fired when the user clicks the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Link
itself
* @returns {sap.ui.commons.Link} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.Link;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.ui.commons.Link
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.Link} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.ui.commons.Link;
/**
* Creates a new subclass of class sap.ui.commons.Link with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected firePress(mParameters?: any): boolean;
/**
* Puts the focus to the link.
*/
public focus(): void;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Whether the link can be triggered by the user.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getHelpId helpId}.
*
* Unique identifier used for help service.
*
* Default value is
.
* @returns {string} Value of property helpId
*/
public getHelpId(): string;
/**
* Gets current value of property {@link #getHref href}.
*
* The link target URI. Supports standard hyperlink behavior. If an action should be triggered, this should not be set, but instead an event handler for the "press" event should be registered.
* @returns {sap.ui.core.URI} Value of property href
*/
public getHref(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.ui.commons.Link.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTarget target}.
*
* Options are _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered.
* @returns {string} Value of property target
*/
public getTarget(): string;
/**
* Gets current value of property {@link #getText text}.
*
* Link text to be displayed.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of text link. When it is set (CSS-size such as % or px), this is the exact size. When left blank, the text defines the size.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Whether the link can be triggered by the user.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.commons.Link} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.Link;
/**
* Sets a new value for property {@link #getHelpId helpId}.
*
* Unique identifier used for help service.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sHelpId - New value for property helpId
* @returns {sap.ui.commons.Link} Reference to this
in order to allow method chaining
*/
public setHelpId(sHelpId: string): sap.ui.commons.Link;
/**
* Sets a new value for property {@link #getHref href}.
*
* The link target URI. Supports standard hyperlink behavior. If an action should be triggered, this should not be set, but instead an event handler for the "press" event should be registered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sHref - New value for property href
* @returns {sap.ui.commons.Link} Reference to this
in order to allow method chaining
*/
public setHref(sHref: sap.ui.core.URI): sap.ui.commons.Link;
/**
* Sets a new value for property {@link #getTarget target}.
*
* Options are _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTarget - New value for property target
* @returns {sap.ui.commons.Link} Reference to this
in order to allow method chaining
*/
public setTarget(sTarget: string): sap.ui.commons.Link;
/**
* Sets a new value for property {@link #getText text}.
*
* Link text to be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sText - New value for property text
* @returns {sap.ui.commons.Link} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.commons.Link;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of text link. When it is set (CSS-size such as % or px), this is the exact size. When left blank, the text defines the size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.Link} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.Link;
}
/**
* Provides a list of items from which users can choose an item.
* For the design of the list box, features such as defining the list box height, fixing the number of visible items,
* choosing one item to be the item that is marked by default when the list box is shown,
* or a scroll bar for large list boxes are available.
*/
export class ListBox extends sap.ui.core.Control {
/**
* Constructor for a new ListBox.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.ListBox;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.ListBox;
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.ui.core.Item} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.ui.core.Item): sap.ui.commons.ListBox;
/**
* Adds the given index to current selection.
* When multiple selection is disabled, this replaces the current selection.
* When the given index is invalid, the call is ignored.
* @param {number} iSelectedIndex - Index to add to selection..
* @returns {sap.ui.commons.ListBox} this
to allow method chaining.
*/
public addSelectedIndex(iSelectedIndex: number): sap.ui.commons.ListBox;
/**
* Adds the given indices to selection. Any invalid indices are ignored.
* @param {number[]} aSelectedIndices - Indices of the items that shall additionally be selected.
* @returns {sap.ui.commons.ListBox} this
to allow method chaining.
*/
public addSelectedIndices(aSelectedIndices: number[]): sap.ui.commons.ListBox;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.commons.ListBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.ListBox
itself.
*
* Event is fired when selection is changed by user interaction.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.ListBox
itself
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.commons.ListBox;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.commons.ListBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.ListBox
itself.
*
* Event is fired when selection is changed by user interaction.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.ListBox
itself
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.ListBox;
/**
* Removes complete selection.
* @returns {sap.ui.commons.ListBox} this
to allow method chaining.
*/
public clearSelection(): sap.ui.commons.ListBox;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.ui.commons.ListBox;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.commons.ListBox
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.commons.ListBox;
/**
* Creates a new subclass of class sap.ui.commons.ListBox with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.commons.ListBox;
/**
* Gets current value of property {@link #getAllowMultiSelect allowMultiSelect}.
*
* Determines whether multiple selection is allowed.
*
* Default value is false
.
* @returns {boolean} Value of property allowMultiSelect
*/
public getAllowMultiSelect(): boolean;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getDisplayIcons displayIcons}.
*
* Determines whether the icons of the list items shall also be displayed.
* Enabling icons requires some space to be reserved for them.
* Displaying icons can also influence the width and height of a single item,
* which affects the overall height of the ListBox when defined in number of items.
* Note that the number of icons that can be displayed in the ListBox depends on the
* size of the icons themselves and of the total ListBox height.
*
* Default value is false
.
* @returns {boolean} Value of property displayIcons
*/
public getDisplayIcons(): boolean;
/**
* Gets current value of property {@link #getDisplaySecondaryValues displaySecondaryValues}.
*
* Determines whether the text values from the additionalText property (see sap.ui.core.ListItems) shall be displayed.
*
* Default value is false
.
* @returns {boolean} Value of property displaySecondaryValues
*/
public getDisplaySecondaryValues(): boolean;
/**
* Gets current value of property {@link #getEditable editable}.
*
* Determines whether the ListBox is interactive or not.
* Can be used to disable interaction with mouse or keyboard.
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Determines whether the ListBox is enabled or not.
* Can be used to disable interaction with mouse or keyboard.
* Disabled controls have another color display depending on custom settings.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* Control height as common CSS-size (px or % as unit, for example).
* The setting overrides any definitions made for the setVisibleItems() method.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Aggregation of items to be displayed. Must be either of type sap.ui.core.ListItem or sap.ui.core.SeparatorItem.
* @returns {sap.ui.core.Item[]}
*/
public getItems(): sap.ui.core.Item[];
/**
* Gets current value of property {@link #getMaxWidth maxWidth}.
*
* Determines the maximum width of the ListBox. If not set, there is no maximum width.
* @returns {sap.ui.core.CSSSize} Value of property maxWidth
*/
public getMaxWidth(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.commons.ListBox.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinWidth minWidth}.
*
* Determines the minimum width of the ListBox. If not set, there is no minimum width.
* @returns {sap.ui.core.CSSSize} Value of property minWidth
*/
public getMinWidth(): sap.ui.core.CSSSize;
/**
* Returns how many pixels the ListBox contents are currently scrolled down.
* @returns {number} Vertical scroll position.
*/
public getScrollTop(): number;
/**
* Gets current value of property {@link #getSecondaryValueTextAlign secondaryValueTextAlign}.
*
* Determines the text alignment in the secondary ListBox text column (if available).
*
* Default value is Begin
.
* @returns {sap.ui.core.TextAlign} Value of property secondaryValueTextAlign
*/
public getSecondaryValueTextAlign(): sap.ui.core.TextAlign;
/**
* Zero-based index of selected item. Index value for no selection is -1.
* When multiple selection is enabled and multiple items are selected,
* the method returns the first selected item.
* @returns {number} Selected index
*/
public getSelectedIndex(): number;
/**
* Zero-based indices of selected items, wrapped in an array. An empty array means "no selection".
* @returns {number[]} Array of selected indices.
*/
public getSelectedIndices(): number[];
/**
* Returns selected item. When no item is selected, "null" is returned.
* When multi-selection is enabled and multiple items are selected, only the first selected item is returned.
* @returns {sap.ui.core.Item} Selected item
*/
public getSelectedItem(): sap.ui.core.Item;
/**
* Returns an array containing the selected items. In the case of no selection, an empty array is returned.
* @returns {sap.ui.core.Item[]} Selected items.
*/
public getSelectedItems(): sap.ui.core.Item[];
/**
* Returns the keys of the selected items in an array.
* If a selected item does not have a key, the respective array entry will be undefined.
* @returns {string[]} Array with selected keys.
*/
public getSelectedKeys(): string[];
/**
* Gets current value of property {@link #getValueTextAlign valueTextAlign}.
*
* Determines the text alignment in the primary ListBox column.
*
* Default value is Begin
.
* @returns {sap.ui.core.TextAlign} Value of property valueTextAlign
*/
public getValueTextAlign(): sap.ui.core.TextAlign;
/**
* Returns the number of visible items.
* @returns {number} Number of visible items.
*/
public getVisibleItems(): number;
/**
* Gets current value of property {@link #getWidth width}.
*
* Control width as common CSS-size (px or % as unit, for example).
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Item
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Item} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.core.Item): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.ui.core.Item} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.ui.core.Item, iIndex: number): sap.ui.commons.ListBox;
/**
* Returns whether the given index is selected.
* @param {number} iIndex - Index which is checked for selection state.
* @returns {boolean} Whether index is selected.
*/
public isIndexSelected(iIndex: number): boolean;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Item[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.ui.core.Item[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.ui.core.Item} vItem - The item to remove or its index or id
* @returns {sap.ui.core.Item} The removed item or null
*/
public removeItem(vItem: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Removes the given index from this selection. When the index is invalid or not selected, the call is ignored.
* @param {number} iIndex - Index that shall be removed from selection.
* @returns {sap.ui.commons.ListBox} this
to allow method chaining.
*/
public removeSelectedIndex(iIndex: number): sap.ui.commons.ListBox;
/**
* If the ListBox has a scroll bar because the number of items is larger than the number of visible items,
* this method scrolls to the item with the given index.
* If there are enough items, this item will then appear at the topmost visible position in the ListBox.
* If bLazy is true, it only scrolls as far as required to make the item visible.
* Setting the scrollTop property and calling scrollToIndex are two operations
* influencing the same "physical" property, so the last call "wins".
* @param {number} iIndex - The index to which the ListBox should scroll.
* @param {boolean} bLazy - If set to true, the ListBox only scrolls if the item is not completely visible, and it scrolls for exactly the space to make it fully visible. If set to false, the item is scrolled to the top position (if possible).
* @returns {sap.ui.commons.ListBox} this
to allow method chaining.
*/
public scrollToIndex(iIndex: number, bLazy: boolean): sap.ui.commons.ListBox;
/**
* Sets a new value for property {@link #getAllowMultiSelect allowMultiSelect}.
*
* Determines whether multiple selection is allowed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bAllowMultiSelect - New value for property allowMultiSelect
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public setAllowMultiSelect(bAllowMultiSelect: boolean): sap.ui.commons.ListBox;
/**
* Sets a new value for property {@link #getDisplayIcons displayIcons}.
*
* Determines whether the icons of the list items shall also be displayed.
* Enabling icons requires some space to be reserved for them.
* Displaying icons can also influence the width and height of a single item,
* which affects the overall height of the ListBox when defined in number of items.
* Note that the number of icons that can be displayed in the ListBox depends on the
* size of the icons themselves and of the total ListBox height.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bDisplayIcons - New value for property displayIcons
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public setDisplayIcons(bDisplayIcons: boolean): sap.ui.commons.ListBox;
/**
* Sets a new value for property {@link #getDisplaySecondaryValues displaySecondaryValues}.
*
* Determines whether the text values from the additionalText property (see sap.ui.core.ListItems) shall be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bDisplaySecondaryValues - New value for property displaySecondaryValues
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public setDisplaySecondaryValues(bDisplaySecondaryValues: boolean): sap.ui.commons.ListBox;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Determines whether the ListBox is interactive or not.
* Can be used to disable interaction with mouse or keyboard.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.ui.commons.ListBox;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Determines whether the ListBox is enabled or not.
* Can be used to disable interaction with mouse or keyboard.
* Disabled controls have another color display depending on custom settings.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.ListBox;
/**
* Sets the height of this ListBox in CSS units.
* @param {sap.ui.core.CSSSize} sHeight - New height for the ListBox.
* @returns {sap.ui.commons.ListBox} this
to allow method chaining.
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.ListBox;
/**
* Allows setting the list items as array for this instance of ListBox.
* @param {sap.ui.core.ListItem[]} aItems - The items to set for this ListBox.
* @param {boolean} bDestroyItems - Optional boolean parameter to indicate that the formerly set items should be destroyed, instead of just removed.
* @returns {sap.ui.commons.ListBox} this
to allow method chaining.
*/
public setItems(aItems: sap.ui.core.ListItem[], bDestroyItems: boolean): sap.ui.commons.ListBox;
/**
* Sets a new value for property {@link #getMaxWidth maxWidth}.
*
* Determines the maximum width of the ListBox. If not set, there is no maximum width.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sMaxWidth - New value for property maxWidth
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public setMaxWidth(sMaxWidth: sap.ui.core.CSSSize): sap.ui.commons.ListBox;
/**
* Sets a new value for property {@link #getMinWidth minWidth}.
*
* Determines the minimum width of the ListBox. If not set, there is no minimum width.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sMinWidth - New value for property minWidth
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public setMinWidth(sMinWidth: sap.ui.core.CSSSize): sap.ui.commons.ListBox;
/**
* Positions the ListBox contents so that they are scrolled-down by the given number of pixels.
* @param {number} iScrollTop - Vertical scroll position in pixels.
* @returns {sap.ui.commons.ListBox} this
to allow method chaining.
*/
public setScrollTop(iScrollTop: number): sap.ui.commons.ListBox;
/**
* Sets a new value for property {@link #getSecondaryValueTextAlign secondaryValueTextAlign}.
*
* Determines the text alignment in the secondary ListBox text column (if available).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Begin
.
* @param {sap.ui.core.TextAlign} sSecondaryValueTextAlign - New value for property secondaryValueTextAlign
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public setSecondaryValueTextAlign(sSecondaryValueTextAlign: sap.ui.core.TextAlign): sap.ui.commons.ListBox;
/**
* Sets the zero-based index of the currently selected item.
* This method removes any previous selections. When the given index is invalid, the call is ignored.
* @param {number} iSelectedIndex - Index to be selected.
* @returns {sap.ui.commons.ListBox} this
to allow method chaining.
*/
public setSelectedIndex(iSelectedIndex: number): sap.ui.commons.ListBox;
/**
* Zero-based indices of selected items, wrapped in an array. An empty array means "no selection".
* When multiple selection is disabled and multiple items are given,
* the selection is set to the index of the first valid index in the given array.
* Any invalid indices are ignored.
* The previous selection is in any case replaced.
* @param {number[]} aSelectedIndices - Indices of the items to be selected.
* @returns {sap.ui.commons.ListBox} this
to allow method chaining.
*/
public setSelectedIndices(aSelectedIndices: number[]): sap.ui.commons.ListBox;
/**
* Keys of the items to be selected, wrapped in an array. An empty array means no selection.
* When multiple selection is disabled, and multiple keys are given,
* the selection is set to the item with the first valid key in the given array.
* Any invalid keys are ignored.
* The previous selection is replaced in any case.
* @param {string[]} aSelectedKeys - The keys of the items to be selected.
* @returns {sap.ui.commons.ListBox} this
to allow method chaining.
*/
public setSelectedKeys(aSelectedKeys: string[]): sap.ui.commons.ListBox;
/**
* Sets a new value for property {@link #getValueTextAlign valueTextAlign}.
*
* Determines the text alignment in the primary ListBox column.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Begin
.
* @param {sap.ui.core.TextAlign} sValueTextAlign - New value for property valueTextAlign
* @returns {sap.ui.commons.ListBox} Reference to this
in order to allow method chaining
*/
public setValueTextAlign(sValueTextAlign: sap.ui.core.TextAlign): sap.ui.commons.ListBox;
/**
* Makes the ListBox render with a height that allows it to display exactly the given number of items.
* @param {number} iItemCount - The number of items that should fit into the ListBox without scrolling.
* @returns {sap.ui.commons.ListBox} this
to allow method chaining.
*/
public setVisibleItems(iItemCount: number): sap.ui.commons.ListBox;
/**
* Sets the width of this ListBox in CSS units.
* @param {sap.ui.core.CSSSize} sWidth - New width for the ListBox.
* @returns {sap.ui.commons.ListBox} this
to allow method chaining.
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.ListBox;
}
/**
* A menu is an interactive element which provides a choice of different actions to the user. These actions (items) can also be organized in submenus.
* Like other dialog-like controls, the menu is not rendered within the control hierarchy. Instead it can be opened at a specified position via a function call.
*/
export class Menu extends sap.ui.unified.Menu {
/**
* Constructor for a new Menu control.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.Menu with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.unified.Menu.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.Menu.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Represents a user interface area which is the entry point for menus with their menu items. MenuBar is useful for applications which shall offer a
* set of actions that shall be provided in a structured way. The MenuBar contains the menu titles from where users navigate to the single items. The control supports
* for example long menu item texts, automated scrolling for menu items when the browser space is not large enough to display all items, defining images for single
* or all items in a menu, automated layouting of items with or w/o image, and active/non-active items.
*/
export class MenuBar extends sap.ui.core.Control {
/**
* Constructor for a new MenuBar.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.ui.unified.MenuItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.ui.commons.MenuBar} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.ui.unified.MenuItem): sap.ui.commons.MenuBar;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.ui.commons.MenuBar} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.ui.commons.MenuBar;
/**
* Creates a new subclass of class sap.ui.commons.MenuBar with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getDesign design}.
*
* Available design options are Header and Standard. Note that design settings are theme-dependent.
*
* Default value is Standard
.
* @returns {sap.ui.commons.MenuBarDesign} Value of property design
*/
public getDesign(): sap.ui.commons.MenuBarDesign;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* When the MenuBar is not enabled, automatically all single menu items are also displayed as 'disabled'.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Aggregation of menu items.
* @returns {sap.ui.unified.MenuItem[]}
*/
public getItems(): sap.ui.unified.MenuItem[];
/**
* Returns a metadata object for class sap.ui.commons.MenuBar.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getWidth width}.
*
* Specifies the width of the MenuBar
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.unified.MenuItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.MenuItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.unified.MenuItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.ui.unified.MenuItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.ui.commons.MenuBar} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.ui.unified.MenuItem, iIndex: number): sap.ui.commons.MenuBar;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.MenuItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.ui.unified.MenuItem[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.ui.unified.MenuItem} vItem - The item to remove or its index or id
* @returns {sap.ui.unified.MenuItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.ui.unified.MenuItem): sap.ui.unified.MenuItem;
/**
* Sets a new value for property {@link #getDesign design}.
*
* Available design options are Header and Standard. Note that design settings are theme-dependent.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.ui.commons.MenuBarDesign} sDesign - New value for property design
* @returns {sap.ui.commons.MenuBar} Reference to this
in order to allow method chaining
*/
public setDesign(sDesign: sap.ui.commons.MenuBarDesign): sap.ui.commons.MenuBar;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* When the MenuBar is not enabled, automatically all single menu items are also displayed as 'disabled'.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.commons.MenuBar} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.MenuBar;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Specifies the width of the MenuBar
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.MenuBar} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.MenuBar;
}
/**
* Determines the visual design of a MenuBar. The feature might be not supported by all themes.
*/
export enum MenuBarDesign {
/**
* The MenuBar appears in header design.
*/
Header = "Header",
/**
* The MenuBar appears in standard design.
*/
Standard = "Standard",
}
/**
* Common button control that opens a menu when clicked by the user. The control provides an API for configuring the docking position
* of the menu.
*/
export class MenuButton extends sap.ui.commons.Button {
/**
* Constructor for a new MenuButton.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelected itemSelected} event of this sap.ui.commons.MenuButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.MenuButton
itself.
*
* Event that is fired when a menu item is selected by the user
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.MenuButton
itself
* @returns {sap.ui.commons.MenuButton} Reference to this
in order to allow method chaining
*/
public attachItemSelected(fnFunction: Function, oListener?: any): sap.ui.commons.MenuButton;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelected itemSelected} event of this sap.ui.commons.MenuButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.MenuButton
itself.
*
* Event that is fired when a menu item is selected by the user
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.MenuButton
itself
* @returns {sap.ui.commons.MenuButton} Reference to this
in order to allow method chaining
*/
public attachItemSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.MenuButton;
/**
* Attach event-handler fnFunction
to the 'press' event of this sap.ui.commons.MenuButton
.
*
* Event is fired when an item from the menu was selected.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.commons.MenuButton} this
to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.ui.commons.MenuButton;
/**
* Attach event-handler fnFunction
to the 'press' event of this sap.ui.commons.MenuButton
.
*
* Event is fired when an item from the menu was selected.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.commons.MenuButton} this
to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.MenuButton;
/**
* Destroys the menu in the aggregation
* named menu
.
* @returns {sap.ui.commons.MenuButton} this
to allow method chaining
*/
public destroyMenu(): sap.ui.commons.MenuButton;
/**
* Detaches event handler fnFunction
from the {@link #event:itemSelected itemSelected} event of this sap.ui.commons.MenuButton
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.MenuButton} Reference to this
in order to allow method chaining
*/
public detachItemSelected(fnFunction: Function, oListener: any): sap.ui.commons.MenuButton;
/**
* Detach event-handler fnFunction
from the 'press' event of this sap.ui.commons.MenuButton
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.commons.MenuButton} this
to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.ui.commons.MenuButton;
/**
* Creates a new subclass of class sap.ui.commons.MenuButton with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.commons.Button.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:itemSelected itemSelected} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.MenuButton} Reference to this
in order to allow method chaining
*/
protected fireItemSelected(mParameters?: any): sap.ui.commons.MenuButton;
/**
* Fire event press to attached listeners.
* @param {{ [key: string]: any }} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.commons.MenuButton} this
to allow method chaining
*/
protected firePress(mArguments?: { [key: string]: any }): sap.ui.commons.MenuButton;
/**
* Gets current value of property {@link #getDockButton dockButton}.
*
* The position / edge (see sap.ui.core.Popup.Dock) of the button where the menu is docked. Default is 'begin bottom'.
* @returns {string} Value of property dockButton
*/
public getDockButton(): string;
/**
* Gets current value of property {@link #getDockMenu dockMenu}.
*
* The position / edge (see sap.ui.core.Popup.Dock) of the menu which is docked to the button. Default is 'begin top'.
* @returns {string} Value of property dockMenu
*/
public getDockMenu(): string;
/**
* Gets content of aggregation {@link #getMenu menu}.
*
* Menu that shall be opened when the button is clicked
* @returns {sap.ui.unified.Menu}
*/
public getMenu(): sap.ui.unified.Menu;
/**
* Returns a metadata object for class sap.ui.commons.MenuButton.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets a new value for property {@link #getDockButton dockButton}.
*
* The position / edge (see sap.ui.core.Popup.Dock) of the button where the menu is docked. Default is 'begin bottom'.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sDockButton - New value for property dockButton
* @returns {sap.ui.commons.MenuButton} Reference to this
in order to allow method chaining
*/
public setDockButton(sDockButton: string): sap.ui.commons.MenuButton;
/**
* Sets a new value for property {@link #getDockMenu dockMenu}.
*
* The position / edge (see sap.ui.core.Popup.Dock) of the menu which is docked to the button. Default is 'begin top'.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sDockMenu - New value for property dockMenu
* @returns {sap.ui.commons.MenuButton} Reference to this
in order to allow method chaining
*/
public setDockMenu(sDockMenu: string): sap.ui.commons.MenuButton;
/**
* Setter for the aggregated menu
.
* @param {sap.ui.unified.Menu} oMenu
* @returns {sap.ui.commons.MenuButton} this
to allow method chaining
*/
public setMenu(oMenu: sap.ui.unified.Menu): sap.ui.commons.MenuButton;
}
/**
* Standard item to be used inside a menu. A menu item represents an action which can be selected by the user in the menu or
* it can provide a submenu to organize the actions hierarchically.
*/
export class MenuItem extends sap.ui.unified.MenuItem {
/**
* Constructor for a new MenuItem element.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.MenuItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.unified.MenuItem.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.MenuItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Abstract base class for menu item which provides common properties and events for all concrete item implementations.
*/
export class MenuItemBase extends sap.ui.unified.MenuItemBase {
/**
* Abstract base class MenuItemBase
for menu item elements. Please use concrete subclasses.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
}
/**
* Special menu item which contains a label and a text field. This menu item is e.g. helpful for filter implementations.
* The aggregation submenu
(inherited from parent class) is not supported for this type of menu item.
*/
export class MenuTextFieldItem extends sap.ui.unified.MenuTextFieldItem {
/**
* Constructor for a new MenuTextFieldItem element.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.MenuTextFieldItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.unified.MenuTextFieldItem.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.MenuTextFieldItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Creates the "Message"s to be supplied to the "MessageBar" Control.
*/
export class Message extends sap.ui.core.Control {
/**
* Constructor for a new Message.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Registers a callback function to be invoked if long text Details are to be made available.
*
* This callback function will be supplied the corresponding Message "id", and should
* return the (simple) HTML string to be displayed within the Message Details Dialog.
*
* E.g.: myMessage.bindDetails(getDetails);
* function getDetails(sId) {... return htmlString;}
* @param {Function} fnCallBack - the callback function
*/
public bindDetails(fnCallBack: Function): void;
/**
* Creates a new subclass of class sap.ui.commons.Message with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAssociatedElementId associatedElementId}.
*
* Associated UI element ID. (Optional)
* For navigation to error field.
* @returns {string} Value of property associatedElementId
*/
public getAssociatedElementId(): string;
/**
* Gets current value of property {@link #getDesign design}.
*
* Internal attribute, used to force the display of the "short" or the "long" text only.
* @returns {string} Value of property design
*/
public getDesign(): string;
/**
* Returns a metadata object for class sap.ui.commons.Message.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* Message short text. (Mandatory)
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getType type}.
*
* "Success", or "Warning", or "Error" messages. (Mandatory)
* @returns {sap.ui.commons.MessageType} Value of property type
*/
public getType(): sap.ui.commons.MessageType;
/**
* Sets a new value for property {@link #getAssociatedElementId associatedElementId}.
*
* Associated UI element ID. (Optional)
* For navigation to error field.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAssociatedElementId - New value for property associatedElementId
* @returns {sap.ui.commons.Message} Reference to this
in order to allow method chaining
*/
public setAssociatedElementId(sAssociatedElementId: string): sap.ui.commons.Message;
/**
* Sets a new value for property {@link #getDesign design}.
*
* Internal attribute, used to force the display of the "short" or the "long" text only.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sDesign - New value for property design
* @returns {sap.ui.commons.Message} Reference to this
in order to allow method chaining
*/
public setDesign(sDesign: string): sap.ui.commons.Message;
/**
* Sets a new value for property {@link #getText text}.
*
* Message short text. (Mandatory)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.commons.Message} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.commons.Message;
/**
* Sets a new value for property {@link #getType type}.
*
* "Success", or "Warning", or "Error" messages. (Mandatory)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.commons.MessageType} sType - New value for property type
* @returns {sap.ui.commons.Message} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.ui.commons.MessageType): sap.ui.commons.Message;
}
/**
* Creates an instance of a MessageBar Control, for displaying messages.
*/
export class MessageBar extends sap.ui.core.Control {
/**
* Constructor for a new MessageBar.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds/updates a supplied list of messages.
* The MessageBar will appear if at least one message exists.
* @param {sap.ui.commons.Message[]} aAMessages - Array of messages.
*/
public addMessages(aAMessages: sap.ui.commons.Message[]): void;
/**
* Deletes all messages.
* @returns {sap.ui.commons.MessageBar} this
to allow method chaining
*/
public deleteAllMessages(): sap.ui.commons.MessageBar;
/**
* Deletes a supplied list of messages.
* The MessageBar will disappear when no message remains.
* @param {string[]} aIds - Messages IDs to be deleted.
*/
public deleteMessages(aIds: string[]): void;
/**
* Creates a new subclass of class sap.ui.commons.MessageBar with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAnchorID anchorID}.
*
* Element ID upon which the MessageBar will be initially positioned.
*
* Default value is
.
* @returns {string} Value of property anchorID
*/
public getAnchorID(): string;
/**
* Gets current value of property {@link #getAnchorSnapPoint anchorSnapPoint}.
*
* Type: sap.ui.core.Popup.Dock
* SnapPoint of MessageBar over anchorId.
* Note: Use "begin" or "end" for RTL support.
* Note: "center" is not indicated, as positioning is only set once, either via the css "left" or the "right" attribute. Therefore a MessageBar will only be extended in one direction, as Messages come in.
*
* Default value is begin top
.
* @returns {string} Value of property anchorSnapPoint
*/
public getAnchorSnapPoint(): string;
/**
* Gets current value of property {@link #getMaxListed maxListed}.
*
* Maximum number of messages being displayed in the List before a scrollbar appears. Value '0' means no limit.
*
* Default value is 7
.
* @returns {number} Value of property maxListed
*/
public getMaxListed(): number;
/**
* Gets current value of property {@link #getMaxToasted maxToasted}.
*
* Maximum number of simultaneous messages being toasted in a row. Value '0' means this dynamic part is switched off.
*
* Default value is 3
.
* @returns {number} Value of property maxToasted
*/
public getMaxToasted(): number;
/**
* Returns a metadata object for class sap.ui.commons.MessageBar.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Specifies whether or not the MessageBar is visible. Invisible controls are not rendered.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Sets a new value for property {@link #getAnchorID anchorID}.
*
* Element ID upon which the MessageBar will be initially positioned.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sAnchorID - New value for property anchorID
* @returns {sap.ui.commons.MessageBar} Reference to this
in order to allow method chaining
*/
public setAnchorID(sAnchorID: string): sap.ui.commons.MessageBar;
/**
* Sets a new value for property {@link #getAnchorSnapPoint anchorSnapPoint}.
*
* Type: sap.ui.core.Popup.Dock
* SnapPoint of MessageBar over anchorId.
* Note: Use "begin" or "end" for RTL support.
* Note: "center" is not indicated, as positioning is only set once, either via the css "left" or the "right" attribute. Therefore a MessageBar will only be extended in one direction, as Messages come in.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is begin top
.
* @param {string} sAnchorSnapPoint - New value for property anchorSnapPoint
* @returns {sap.ui.commons.MessageBar} Reference to this
in order to allow method chaining
*/
public setAnchorSnapPoint(sAnchorSnapPoint: string): sap.ui.commons.MessageBar;
/**
* Sets a new value for property {@link #getMaxListed maxListed}.
*
* Maximum number of messages being displayed in the List before a scrollbar appears. Value '0' means no limit.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 7
.
* @param {number} iMaxListed - New value for property maxListed
* @returns {sap.ui.commons.MessageBar} Reference to this
in order to allow method chaining
*/
public setMaxListed(iMaxListed: number): sap.ui.commons.MessageBar;
/**
* Sets a new value for property {@link #getMaxToasted maxToasted}.
*
* Maximum number of simultaneous messages being toasted in a row. Value '0' means this dynamic part is switched off.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 3
.
* @param {number} iMaxToasted - New value for property maxToasted
* @returns {sap.ui.commons.MessageBar} Reference to this
in order to allow method chaining
*/
public setMaxToasted(iMaxToasted: number): sap.ui.commons.MessageBar;
/**
* Setter for property visible
.
*
* Default value is true
*
* The default implementation of function setVisible()
is enhanced
* in order to toggle the visibility:hidden;
attribute over the control.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.ui.commons.MessageBar} this
to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.commons.MessageBar;
}
/**
* Provides methods to create standard alerts, confirmation dialogs, or arbitrary message boxes.
*
* As MessageBox
is a static class, a jQuery.sap.require("sap.ui.commons.MessageBox");
statement
* must be explicitly executed before the class can be used. Example:
*
* jQuery.sap.require("sap.ui.commons.MessageBox");
* sap.ui.commons.MessageBox.show(
* "This message should appear in the message box.",
* sap.ui.commons.MessageBox.Icon.INFORMATION,
* "My message box title",
* [sap.ui.commons.MessageBox.Action.YES, sap.ui.commons.MessageBox.Action.NO],
* function() { / * do something * / }
* );
*
*/
namespace MessageBox {
/**
* Displays an alert box with the given message and an OK button (no icons).
* If a callback is given, it is called after the alert box has been closed
* by the user via the OK button or via the Close icon. The callback is called
* with the following signature:
*
*
* function ()
*
*
* The alert box opened by this method is modal and it is processed asynchronously.
* Applications have to use the fnCallback
to continue work after the
* user closed the alert box.
* @param {string|sap.ui.core.Control} vMessage - Message to be displayed in the alert box
* @param {Function} fnCallback - callback function to be called when the user closed the dialog
* @param {string} sTitle - Title to be displayed in the alert box
* @param {string} sDialogId - ID to be used for the alert box. Intended for test scenarios, not recommended for productive apps
*/
function alert(vMessage: string|sap.ui.core.Control, fnCallback?: Function, sTitle?: string, sDialogId?: string): void;
/**
* Displays a confirmation dialog box with the given message, a question icon,
* an OK button, and a Cancel button. If a callback is given, it is called after the
* alert box has been closed by the user via one of the buttons or via the close icon.
* The callback is called with the following signature
*
*
* function(bConfirmed)
*
*
* where bConfirmed is set to true when the user has activated the OK button.
*
* The confirmation dialog box opened by this method is modal and it is processed asynchronously.
* Applications have to use the fnCallback
to continue work after the
* user closed the alert box.
* @param {string|sap.ui.core.Control} vMessage - Message to display
* @param {Function} fnCallback - Callback to be called
* @param {string} sTitle - Title to display
* @param {string} sDialogId - ID to be used for the confirmation dialog. Intended for test scenarios, not recommended for productive apps
*/
function confirm(vMessage: string|sap.ui.core.Control, fnCallback?: Function, sTitle?: string, sDialogId?: string): void;
/**
* Creates and displays a simple message box with the given text and buttons, and optionally other parts.
* After the user has selected a button or closed the message box using the close icon, the callback
* function is invoked when given.
*
* The only mandatory parameter is vMessage
. Either a string with the corresponding text or even
* a layout control could be provided.
*
* The created dialog box is executed asynchronously. When it has been created and registered for rendering,
* this function returns without waiting for a user reaction.
*
* When applications have to react on the users choice, they have to provide a callback function and
* postpone any reaction on the user choice until that callback is triggered.
*
* The signature of the callback is
*
* function (oAction);
*
* where oAction
is the button that the user has pressed. When the user has pressed the close button,
* a MessageBox.Action.Close is returned.
* @param {string|sap.ui.core.Control} vMessage - The message to be displayed.
* @param {sap.ui.commons.MessageBox.Icon} oIcon - The icon to be displayed.
* @param {string} sTitle - The title of the message box.
* @param {sap.ui.commons.MessageBox.Action|sap.ui.commons.MessageBox.Action[]} vActions - Either a single action, or an array of actions. If no action(s) are given, the single action MessageBox.Action.OK is taken as a default for the parameter.
* @param {Function} fnCallback - Function to be called when the user has pressed a button or has closed the message box.
* @param {sap.ui.commons.MessageBox.Action} oDefaultAction - Must be one of the actions provided in vActions.
* @param {string} sDialogId - ID to be used for the dialog. Intended for test scenarios, not recommended for productive apps
*/
function show(vMessage: string|sap.ui.core.Control, oIcon?: sap.ui.commons.MessageBox.Icon, sTitle?: string, vActions?: sap.ui.commons.MessageBox.Action|sap.ui.commons.MessageBox.Action[], fnCallback?: Function, oDefaultAction?: sap.ui.commons.MessageBox.Action, sDialogId?: string): void;
/**
* Enumeration of supported actions in a MessageBox.
*
* Each action is represented as a button in the message box. The values of this enumeration are used for both,
* specifying the set of allowed actions as well as reporting back the user choice.
*/
export enum Action {
/**
* Adds an "Abort" button to the message box.
*/
ABORT = "ABORT",
/**
* Adds a "Cancel" button to the message box.
*/
CANCEL = "CANCEL",
/**
* Adds a "Close" button to the message box.
*/
CLOSE = "CLOSE",
/**
* Adds an "Ignore" button to the message box.
*/
IGNORE = "IGNORE",
/**
* Adds a "No" button to the message box.
*/
NO = "NO",
/**
* Adds an "Ok" button to the message box.
*/
OK = "OK",
/**
* Adds a "Retry" button to the message box.
*/
RETRY = "RETRY",
/**
* Adds a "Yes" button to the message box.
*/
YES = "YES",
}
/**
* Enumeration of the pre-defined icons that can be used in a MessageBox.
*/
export enum Icon {
/**
* Shows the critical error icon in the message box.
*/
CRITICAL = "CRITICAL",
/**
* Shows the error icon in the message box.
*/
ERROR = "ERROR",
/**
* Shows the information icon in the message box.
*/
INFORMATION = "INFORMATION",
/**
* Shows no icon in the message box.
*/
NONE = "NONE",
/**
* Shows the question icon in the message box.
*/
QUESTION = "QUESTION",
/**
* Shows the success icon in the message box.
*/
SUCCESS = "SUCCESS",
/**
* Shows the warning icon in the message box.
*/
WARNING = "WARNING",
}
}
/**
* Instantiated by the "MessageBar" Control if the user requests to generate the corresponding "MessageList".
*/
export class MessageList extends sap.ui.core.Control {
/**
* Constructor for a new MessageList.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.MessageList with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAnchorId anchorId}.
*
* ID of the anchor under which the MessageList will render.
* @returns {string} Value of property anchorId
*/
public getAnchorId(): string;
/**
* Gets current value of property {@link #getMaxListed maxListed}.
*
* Maximum number of messages being display in the List before a scrollbar appears. Value '0' means no limit.
*
* Default value is 7
.
* @returns {string} Value of property maxListed
*/
public getMaxListed(): string;
/**
* Returns a metadata object for class sap.ui.commons.MessageList.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Specifies whether or not the MessageList is visible. Invisible controls are not rendered.
*
* Default value is false
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Sets a new value for property {@link #getAnchorId anchorId}.
*
* ID of the anchor under which the MessageList will render.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAnchorId - New value for property anchorId
* @returns {sap.ui.commons.MessageList} Reference to this
in order to allow method chaining
*/
public setAnchorId(sAnchorId: string): sap.ui.commons.MessageList;
/**
* Sets a new value for property {@link #getMaxListed maxListed}.
*
* Maximum number of messages being display in the List before a scrollbar appears. Value '0' means no limit.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 7
.
* @param {string} sMaxListed - New value for property maxListed
* @returns {sap.ui.commons.MessageList} Reference to this
in order to allow method chaining
*/
public setMaxListed(sMaxListed: string): sap.ui.commons.MessageList;
/**
* Sets the list of Messages to be displayed and re-renders this Control if it is visible.
* @param {sap.ui.commons.Message[]} aMessages - Message list.
*/
public setMessages(aMessages: sap.ui.commons.Message[]): void;
/**
* Setter for property visible
.
*
* Default value is true
*
* The default implementation of function "setVisible()" is overwritten
* in order to invoke the open() and close() of the MessageList Popup.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.ui.commons.MessageList} this
to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.commons.MessageList;
}
/**
* Responsible for displaying the new incoming messages, one at the time, on top of the MessageBar.
*/
export class MessageToast extends sap.ui.core.Control {
/**
* Constructor for a new MessageToast.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:next next} event of this sap.ui.commons.MessageToast
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.MessageToast
itself.
*
* Fired once the toast()
method is over, so that the MessageBar can "toast" another message if needed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.MessageToast
itself
* @returns {sap.ui.commons.MessageToast} Reference to this
in order to allow method chaining
*/
public attachNext(fnFunction: Function, oListener?: any): sap.ui.commons.MessageToast;
/**
* Attaches event handler fnFunction
to the {@link #event:next next} event of this sap.ui.commons.MessageToast
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.MessageToast
itself.
*
* Fired once the toast()
method is over, so that the MessageBar can "toast" another message if needed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.MessageToast
itself
* @returns {sap.ui.commons.MessageToast} Reference to this
in order to allow method chaining
*/
public attachNext(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.MessageToast;
/**
* Detaches event handler fnFunction
from the {@link #event:next next} event of this sap.ui.commons.MessageToast
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.MessageToast} Reference to this
in order to allow method chaining
*/
public detachNext(fnFunction: Function, oListener: any): sap.ui.commons.MessageToast;
/**
* Creates a new subclass of class sap.ui.commons.MessageToast with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:next next} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.MessageToast} Reference to this
in order to allow method chaining
*/
protected fireNext(mParameters?: any): sap.ui.commons.MessageToast;
/**
* Gets current value of property {@link #getAnchorId anchorId}.
*
* ID of the anchor on top of which the MessageToast is to render.
* @returns {string} Value of property anchorId
*/
public getAnchorId(): string;
/**
* Returns a metadata object for class sap.ui.commons.MessageToast.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the idle state of the control. Returns true if no message is being toasted.
* @returns {boolean}
*/
public isIdle(): boolean;
/**
* Sets a new value for property {@link #getAnchorId anchorId}.
*
* ID of the anchor on top of which the MessageToast is to render.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAnchorId - New value for property anchorId
* @returns {sap.ui.commons.MessageToast} Reference to this
in order to allow method chaining
*/
public setAnchorId(sAnchorId: string): sap.ui.commons.MessageToast;
/**
* Triggers the toasting of a message, on top of the MessageBar.
* If no message is supplied, displays the "Multiple new messages..." message.
*
* Receives the list of Messages to be displayed,
* and re-renders this Control if it is visible.
* @param {sap.ui.commons.Message} oMessage - The Message to be toasted.
* @param {string} sAnchorId - DOM ID of the anchor against which the Toast Arrow should align for a given Toast.
*/
public toast(oMessage: sap.ui.commons.Message, sAnchorId: string): void;
}
/**
* [Enter description for MessageType]
*/
export enum MessageType {
/**
* Error message
*/
Error = "Error",
/**
* Successful message
*/
Success = "Success",
/**
* Warning message
*/
Warning = "Warning",
}
/**
* Provides navigation between pages within a list of numbered pages.
*/
export class Paginator extends sap.ui.core.Control {
/**
* Constructor for a new Paginator.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:page page} event of this sap.ui.commons.Paginator
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Paginator
itself.
*
* Event is fired when the user navigates to another page by selecting it directly, or by jumping forward/backward.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Paginator
itself
* @returns {sap.ui.commons.Paginator} Reference to this
in order to allow method chaining
*/
public attachPage(fnFunction: Function, oListener?: any): sap.ui.commons.Paginator;
/**
* Attaches event handler fnFunction
to the {@link #event:page page} event of this sap.ui.commons.Paginator
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Paginator
itself.
*
* Event is fired when the user navigates to another page by selecting it directly, or by jumping forward/backward.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Paginator
itself
* @returns {sap.ui.commons.Paginator} Reference to this
in order to allow method chaining
*/
public attachPage(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.Paginator;
/**
* Detaches event handler fnFunction
from the {@link #event:page page} event of this sap.ui.commons.Paginator
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.Paginator} Reference to this
in order to allow method chaining
*/
public detachPage(fnFunction: Function, oListener: any): sap.ui.commons.Paginator;
/**
* Creates a new subclass of class sap.ui.commons.Paginator with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:page page} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.Paginator} Reference to this
in order to allow method chaining
*/
protected firePage(mParameters?: any): sap.ui.commons.Paginator;
/**
* Gets current value of property {@link #getCurrentPage currentPage}.
*
* Represents the current page (first page has index 1, not 0, to match the visual number)
*
* Default value is 1
.
* @returns {number} Value of property currentPage
*/
public getCurrentPage(): number;
/**
* Returns a metadata object for class sap.ui.commons.Paginator.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getNumberOfPages numberOfPages}.
*
* Represents the overall number of pages that are embedded into the parent control
* @returns {number} Value of property numberOfPages
*/
public getNumberOfPages(): number;
/**
* Sets a new value for property {@link #getCurrentPage currentPage}.
*
* Represents the current page (first page has index 1, not 0, to match the visual number)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} iCurrentPage - New value for property currentPage
* @returns {sap.ui.commons.Paginator} Reference to this
in order to allow method chaining
*/
public setCurrentPage(iCurrentPage: number): sap.ui.commons.Paginator;
/**
* Sets a new value for property {@link #getNumberOfPages numberOfPages}.
*
* Represents the overall number of pages that are embedded into the parent control
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iNumberOfPages - New value for property numberOfPages
* @returns {sap.ui.commons.Paginator} Reference to this
in order to allow method chaining
*/
public setNumberOfPages(iNumberOfPages: number): sap.ui.commons.Paginator;
}
/**
* Distinct paginator event types
*/
export enum PaginatorEvent {
/**
* First page event
*/
First = "First",
/**
* Go to page event
*/
Goto = "Goto",
/**
* Last page event
*/
Last = "Last",
/**
* Next page event
*/
Next = "Next",
/**
* Previous page event
*/
Previous = "Previous",
}
/**
* Represents a container with scroll functionality, that can be used for text and controls.
* The Panel does not layout the embedded controls.
*/
export class Panel extends sap.ui.core.Control {
/**
* Constructor for a new Panel.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some button to the aggregation {@link #getButtons buttons}.
* @param {sap.ui.commons.Button} oButton - the button to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Panel} Reference to this
in order to allow method chaining
*/
public addButton(oButton: sap.ui.commons.Button): sap.ui.commons.Panel;
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Panel} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.commons.Panel;
/**
* Destroys all the buttons in the aggregation {@link #getButtons buttons}.
* @returns {sap.ui.commons.Panel} Reference to this
in order to allow method chaining
*/
public destroyButtons(): sap.ui.commons.Panel;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.commons.Panel} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.commons.Panel;
/**
* Destroys the title in the aggregation {@link #getTitle title}.
* @returns {sap.ui.commons.Panel} Reference to this
in order to allow method chaining
*/
public destroyTitle(): sap.ui.commons.Panel;
/**
* Creates a new subclass of class sap.ui.commons.Panel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getApplyContentPadding applyContentPadding}.
*
* Determines whether the Panel will have padding.
* Padding is theme-dependent.
*
* Default value is true
.
* @returns {boolean} Value of property applyContentPadding
*/
public getApplyContentPadding(): boolean;
/**
* Gets current value of property {@link #getAreaDesign areaDesign}.
*
* Determines the background color.
* Note that color settings are theme-dependent.
*
* Default value is Fill
.
* @returns {sap.ui.commons.enums.AreaDesign} Value of property areaDesign
*/
public getAreaDesign(): sap.ui.commons.enums.AreaDesign;
/**
* Gets current value of property {@link #getBorderDesign borderDesign}.
*
* Determines if the Panel can have a box as border.
* Note that displaying borders is theme-dependent.
*
* Default value is Box
.
* @returns {sap.ui.commons.enums.BorderDesign} Value of property borderDesign
*/
public getBorderDesign(): sap.ui.commons.enums.BorderDesign;
/**
* Gets content of aggregation {@link #getButtons buttons}.
*
* The buttons that shall be displayed in the Panel header
* @returns {sap.ui.commons.Button[]}
*/
public getButtons(): sap.ui.commons.Button[];
/**
* Gets current value of property {@link #getCollapsed collapsed}.
*
* Determines whether the Panel will be initially collapsed.
* When it is initially collapsed, the contents are not rendered.
* A collapsed Panel consumes less space than an expanded one.
*
* Default value is false
.
* @returns {boolean} Value of property collapsed
*/
public getCollapsed(): boolean;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Aggregates the controls that are contained in the Panel.
* It is recommended to use a layout control as single direct child.
* When the Panel dimensions are set, the child control may have width and height of 100%.
* When the dimensions are not set, the child defines the size of the Panel.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Represents the state of the of the Panel (enabled or disabled)
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* @returns {any}
*/
protected getFocusInfo(): any;
/**
* Gets current value of property {@link #getHeight height}.
*
* Determines the height of the Panel in CSS size.
* Per default, the height for the Panel is automatically adjusted to the content.
* Dimension allows to explicitly specify the height.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.commons.Panel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the scroll position of the panel in pixels from the left.
* Returns 0 if not rendered yet.
* Also internally updates the control property.
* @returns {number} The scroll position.
*/
public getScrollLeft(): number;
/**
* Returns the scroll position of the panel in pixels from the top.
* Returns 0 if not rendered yet.
* Also internally updates the control property.
* @returns {number} The scroll position.
*/
public getScrollTop(): number;
/**
* Gets current value of property {@link #getShowCollapseIcon showCollapseIcon}.
*
* Determines whether the Panel will have an icon for collapsing/expanding, or not.
*
* Default value is true
.
* @returns {boolean} Value of property showCollapseIcon
*/
public getShowCollapseIcon(): boolean;
/**
* Returns the text that is rendered in the Panel header.
* If a Title control was used it returns the text of the Title control.
* @returns {string} The text in the Panel header.
*/
public getText(): string;
/**
* Gets content of aggregation {@link #getTitle title}.
*
* Aggregates the title element of the Panel.
* For text titles only, you alternatively could use setText() which also creates a title in the background.
* @returns {sap.ui.core.Title}
*/
public getTitle(): sap.ui.core.Title;
/**
* Gets current value of property {@link #getWidth width}.
*
* Determines the width of the Panel in CSS size.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.commons.Button
in the aggregation {@link #getButtons buttons}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.Button} oButton - The button whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfButton(oButton: sap.ui.commons.Button): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a button into the aggregation {@link #getButtons buttons}.
* @param {sap.ui.commons.Button} oButton - the button to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the button should be inserted at; for a negative value of iIndex
, the button is inserted at position 0; for a value greater than the current size of the aggregation, the button is inserted at the last position
* @returns {sap.ui.commons.Panel} Reference to this
in order to allow method chaining
*/
public insertButton(oButton: sap.ui.commons.Button, iIndex: number): sap.ui.commons.Panel;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.commons.Panel} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.commons.Panel;
/**
* Removes all the controls from the aggregation {@link #getButtons buttons}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.Button[]} An array of the removed elements (might be empty)
*/
public removeAllButtons(): sap.ui.commons.Button[];
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a button from the aggregation {@link #getButtons buttons}.
* @param {number|string|sap.ui.commons.Button} vButton - The button to remove or its index or id
* @returns {sap.ui.commons.Button} The removed button or null
*/
public removeButton(vButton: number|string|sap.ui.commons.Button): sap.ui.commons.Button;
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Property setter for the padding
* @param {boolean} bPadding - Whether the Panel should have padding.
* @returns {sap.ui.commons.Panel} this
to allow method chaining.
*/
public setApplyContentPadding(bPadding: boolean): sap.ui.commons.Panel;
/**
* Sets a new value for property {@link #getAreaDesign areaDesign}.
*
* Determines the background color.
* Note that color settings are theme-dependent.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Fill
.
* @param {sap.ui.commons.enums.AreaDesign} sAreaDesign - New value for property areaDesign
* @returns {sap.ui.commons.Panel} Reference to this
in order to allow method chaining
*/
public setAreaDesign(sAreaDesign: sap.ui.commons.enums.AreaDesign): sap.ui.commons.Panel;
/**
* Sets a new value for property {@link #getBorderDesign borderDesign}.
*
* Determines if the Panel can have a box as border.
* Note that displaying borders is theme-dependent.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Box
.
* @param {sap.ui.commons.enums.BorderDesign} sBorderDesign - New value for property borderDesign
* @returns {sap.ui.commons.Panel} Reference to this
in order to allow method chaining
*/
public setBorderDesign(sBorderDesign: sap.ui.commons.enums.BorderDesign): sap.ui.commons.Panel;
/**
* Property setter for the "collapsed" state
* @param {boolean} bCollapsed - Whether the Panel should be collapsed or not.
* @returns {sap.ui.commons.Panel} this
to allow method chaining.
*/
public setCollapsed(bCollapsed: boolean): sap.ui.commons.Panel;
/**
* Sets the dimensions of the panel.
* @param {sap.ui.core.CSSSize} sWidth - The width of the panel as CSS size.
* @param {sap.ui.core.CSSSize} sHeight - The height of the panel as CSS size.
* @returns {sap.ui.commons.Panel} this
to allow method chaining.
*/
public setDimensions(sWidth: sap.ui.core.CSSSize, sHeight: sap.ui.core.CSSSize): sap.ui.commons.Panel;
/**
* Property setter for the "enabled" state
* @param {boolean} bEnabled - Whether the Panel should be enabled or not.
* @returns {sap.ui.commons.Panel} this
to allow method chaining.
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.Panel;
/**
* Sets the height of the panel.
* @param {sap.ui.core.CSSSize} sHeight - The height of the panel as CSS size.
* @returns {sap.ui.commons.Panel} this
to allow method chaining.
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.Panel;
/**
* Sets the scroll position of the panel in pixels from the left.
* @param {number} iPosition - The position to scroll to.
* @returns {sap.ui.commons.Panel} this
to allow method chaining.
*/
public setScrollLeft(iPosition: number): sap.ui.commons.Panel;
/**
* Sets the scrolls position of the panel in pixels from the top.
* @param {number} iPosition - The position to scroll to.
* @returns {sap.ui.commons.Panel} this
to allow method chaining.
*/
public setScrollTop(iPosition: number): sap.ui.commons.Panel;
/**
* Sets a new value for property {@link #getShowCollapseIcon showCollapseIcon}.
*
* Determines whether the Panel will have an icon for collapsing/expanding, or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowCollapseIcon - New value for property showCollapseIcon
* @returns {sap.ui.commons.Panel} Reference to this
in order to allow method chaining
*/
public setShowCollapseIcon(bShowCollapseIcon: boolean): sap.ui.commons.Panel;
/**
* Sets the text that will be rendered in the Panel header.
* @param {string} sText - The text to render in the header.
* @returns {sap.ui.commons.Panel} this
to allow method chaining.
*/
public setText(sText: string): sap.ui.commons.Panel;
/**
* Sets a Tille control that will be rendered in the Panel header.
* @param {sap.ui.core.Title} oTitle - The Title to render in the header.
* @returns {sap.ui.commons.Panel} this
to allow method chaining.
*/
public setTitle(oTitle: sap.ui.core.Title): sap.ui.commons.Panel;
/**
* Sets the width of the panel.
* @param {sap.ui.core.CSSSize} sWidth - The width of the panel as CSS size.
* @returns {sap.ui.commons.Panel} this
to allow method chaining.
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.Panel;
}
/**
* A text field with masked characters which borrows its properties and methods from TextField.
*/
export class PasswordField extends sap.ui.commons.TextField {
/**
* Constructor for a new PasswordField.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.PasswordField with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.commons.TextField.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.PasswordField.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Shows the progress of a process in a graphical way.
* The indicator can be displayed with or without numerical values.
* The filling can be displayed in color only, or additionally with the percentage rate.
* The indicator status can be interactive.
*/
export class ProgressIndicator extends sap.ui.core.Control {
/**
* Constructor for a new ProgressIndicator.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.ProgressIndicator with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getBarColor barColor}.
*
* Determines the color of the bar which visualizes the progress.
* Possible values defined in the sap.ui.core.BarColor enumeration are the following:
* CRITICAL (yellow), NEGATIVE (red), POSITIVE (green), NEUTRAL (blue) (default value).
*
* Default value is NEUTRAL
.
* @returns {sap.ui.core.BarColor} Value of property barColor
*/
public getBarColor(): sap.ui.core.BarColor;
/**
* Gets current value of property {@link #getDisplayValue displayValue}.
*
* Determines the text value that will be displayed in the bar.
*
* Default value is 0%
.
* @returns {string} Value of property displayValue
*/
public getDisplayValue(): string;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Determines whether the control is enabled or not.
* Disabled controls have different colors, and can not be focused.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Returns a metadata object for class sap.ui.commons.ProgressIndicator.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPercentValue percentValue}.
*
* Determines the numerical value for the displayed length of the progress bar.
*
* Default value is 0
.
* @returns {number} Value of property percentValue
*/
public getPercentValue(): number;
/**
* Gets current value of property {@link #getShowValue showValue}.
*
* Determines whether the percent value shall be rendered inside the bar.
*
* Default value is true
.
* @returns {boolean} Value of property showValue
*/
public getShowValue(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* Determines the width of the control.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getBarColor barColor}.
*
* Determines the color of the bar which visualizes the progress.
* Possible values defined in the sap.ui.core.BarColor enumeration are the following:
* CRITICAL (yellow), NEGATIVE (red), POSITIVE (green), NEUTRAL (blue) (default value).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is NEUTRAL
.
* @param {sap.ui.core.BarColor} sBarColor - New value for property barColor
* @returns {sap.ui.commons.ProgressIndicator} Reference to this
in order to allow method chaining
*/
public setBarColor(sBarColor: sap.ui.core.BarColor): sap.ui.commons.ProgressIndicator;
/**
* Sets a new value for property {@link #getDisplayValue displayValue}.
*
* Determines the text value that will be displayed in the bar.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0%
.
* @param {string} sDisplayValue - New value for property displayValue
* @returns {sap.ui.commons.ProgressIndicator} Reference to this
in order to allow method chaining
*/
public setDisplayValue(sDisplayValue: string): sap.ui.commons.ProgressIndicator;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Determines whether the control is enabled or not.
* Disabled controls have different colors, and can not be focused.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.commons.ProgressIndicator} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.ProgressIndicator;
/**
* Sets the new percent value which the ProgressIndicator should display.
* A new rendering is not necessary, only the bar has to be moved.
* @param {number} iPercentValue - The new percent value of the ProgressIndicator.
* @returns {sap.ui.commons.ProgressIndicator} this
to allow method chaining.
*/
public setPercentValue(iPercentValue: number): sap.ui.commons.ProgressIndicator;
/**
* Sets a new value for property {@link #getShowValue showValue}.
*
* Determines whether the percent value shall be rendered inside the bar.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowValue - New value for property showValue
* @returns {sap.ui.commons.ProgressIndicator} Reference to this
in order to allow method chaining
*/
public setShowValue(bShowValue: boolean): sap.ui.commons.ProgressIndicator;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Determines the width of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.ProgressIndicator} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.ProgressIndicator;
}
/**
* RadioButton is a control similar to CheckBox, but it allows the user to choose only one of the predefined set of options.
*
* Usually, RadioButton is used in a group with other RadioButtons (with the groupName property or by using
* sap.ui.commons.RadioButtonGroup), thus providing a limited choice for the user. An event is triggered when
* the user makes a change of the selection.
*/
export class RadioButton extends sap.ui.core.Control {
/**
* Constructor for a new RadioButton.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.RadioButton} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.RadioButton;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.RadioButton} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.RadioButton;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.commons.RadioButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RadioButton
itself.
*
* Triggers when the user makes a change on the RadioButton.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RadioButton
itself
* @returns {sap.ui.commons.RadioButton} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.commons.RadioButton;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.commons.RadioButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RadioButton
itself.
*
* Triggers when the user makes a change on the RadioButton.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RadioButton
itself
* @returns {sap.ui.commons.RadioButton} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.RadioButton;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.commons.RadioButton
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.RadioButton} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.commons.RadioButton;
/**
* Creates a new subclass of class sap.ui.commons.RadioButton with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.RadioButton} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.commons.RadioButton;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEditable editable}.
*
* Specifies whether the user can select the RadioButton.
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Displays the disabled controls in another color, depending on the customer settings.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getGroupName groupName}.
*
* Defines the name of the RadioButtonGroup, in which the current RadioButton belongs to. You can define a new name for
* the group. If no new name is specified, the default is sapUiRbDefaultGroup. By default, when one of the RadioButtons
* in a group is selected, all others are unselected.
*
* Default value is sapUiRbDefaultGroup
.
* @returns {string} Value of property groupName
*/
public getGroupName(): string;
/**
* Gets current value of property {@link #getKey key}.
*
* Can be used for subsequent actions.
* @returns {string} Value of property key
*/
public getKey(): string;
/**
* Returns a metadata object for class sap.ui.commons.RadioButton.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSelected selected}.
*
* Specifies the select state of the RadioButton.
*
* Default value is false
.
* @returns {boolean} Value of property selected
*/
public getSelected(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* Defines the text displayed next to the RadioButton.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Defines the text direction - options are left-to-right (LTR) and right-to-left (RTL). Alternatively, the control can
* inherit the text direction from its parent container.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Enumeration sap.ui.core.ValueState provides state values Error, Success, Warning and None.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getWidth width}.
*
* Determines the control width. By default, it depends on the text length. Alternatively, CSS sizes in % or px can be set.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Specifies whether the user can select the RadioButton.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.ui.commons.RadioButton} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.ui.commons.RadioButton;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Displays the disabled controls in another color, depending on the customer settings.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.commons.RadioButton} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.RadioButton;
/**
* Sets a new value for property {@link #getGroupName groupName}.
*
* Defines the name of the RadioButtonGroup, in which the current RadioButton belongs to. You can define a new name for
* the group. If no new name is specified, the default is sapUiRbDefaultGroup. By default, when one of the RadioButtons
* in a group is selected, all others are unselected.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is sapUiRbDefaultGroup
.
* @param {string} sGroupName - New value for property groupName
* @returns {sap.ui.commons.RadioButton} Reference to this
in order to allow method chaining
*/
public setGroupName(sGroupName: string): sap.ui.commons.RadioButton;
/**
* Sets a new value for property {@link #getKey key}.
*
* Can be used for subsequent actions.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sKey - New value for property key
* @returns {sap.ui.commons.RadioButton} Reference to this
in order to allow method chaining
*/
public setKey(sKey: string): sap.ui.commons.RadioButton;
/**
* Sets a new value for property {@link #getSelected selected}.
*
* Specifies the select state of the RadioButton.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSelected - New value for property selected
* @returns {sap.ui.commons.RadioButton} Reference to this
in order to allow method chaining
*/
public setSelected(bSelected: boolean): sap.ui.commons.RadioButton;
/**
* Sets a new value for property {@link #getText text}.
*
* Defines the text displayed next to the RadioButton.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.commons.RadioButton} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.commons.RadioButton;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Defines the text direction - options are left-to-right (LTR) and right-to-left (RTL). Alternatively, the control can
* inherit the text direction from its parent container.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.ui.commons.RadioButton} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.ui.commons.RadioButton;
/**
* Sets a new value for property {@link #getValueState valueState}.
*
* Enumeration sap.ui.core.ValueState provides state values Error, Success, Warning and None.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sValueState - New value for property valueState
* @returns {sap.ui.commons.RadioButton} Reference to this
in order to allow method chaining
*/
public setValueState(sValueState: sap.ui.core.ValueState): sap.ui.commons.RadioButton;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Determines the control width. By default, it depends on the text length. Alternatively, CSS sizes in % or px can be set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.RadioButton} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.RadioButton;
}
/**
* The RadioButtonGroup is a basic control that is used to provide area for making interactive
* choice out of a set of options. It represents a list with items where exactly one item can
* be selected in a session. For the representation of the single group entries, the RadioButton
* items are created automatically. For the RadioButton choice, mouse and keyboard navigation
* usage is supported.
*/
export class RadioButtonGroup extends sap.ui.core.Control {
/**
* Constructor for a new RadioButtonGroup.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.RadioButtonGroup;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.RadioButtonGroup;
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.ui.core.Item} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.ui.core.Item): sap.ui.commons.RadioButtonGroup;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.commons.RadioButtonGroup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RadioButtonGroup
itself.
*
* Fires when selection is changed by user interaction.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RadioButtonGroup
itself
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.commons.RadioButtonGroup;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.commons.RadioButtonGroup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RadioButtonGroup
itself.
*
* Fires when selection is changed by user interaction.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RadioButtonGroup
itself
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.RadioButtonGroup;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.ui.commons.RadioButtonGroup;
/**
* Creates a new instance of RadioButtonGroup, with the same settings as the RadioButtonGroup
* on which the method is called.
* Event handlers are not cloned.
* @returns {sap.ui.commons.RadioButtonGroup} New instance of RadioButtonGroup
*/
public clone(): sap.ui.commons.RadioButtonGroup;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.ui.commons.RadioButtonGroup;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.commons.RadioButtonGroup
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.commons.RadioButtonGroup;
/**
* Creates a new subclass of class sap.ui.commons.RadioButtonGroup with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.commons.RadioButtonGroup;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getColumns columns}.
*
* Determines the maximum number of RadioButtons displayed in one line.
*
* Default value is 1
.
* @returns {number} Value of property columns
*/
public getColumns(): number;
/**
* Gets current value of property {@link #getEditable editable}.
*
* Specifies whether the user can change the selected value of the RadioButtonGroup.
* When the property is set to false, the control obtains visual styles
* different from its visual styles for the normal and the disabled state.
* Additionally the control is no longer interactive, but can receive focus.
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Enables/disables the RadioButtonGroup. If it is disabled all RadioButtons will be displayed as disabled.
* The enabled property of the Item will not be used in this case. If the RadioButtonGroup is enabled, the
* enabled property of the Item will define if a RadioButton is enabled or not.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets content of aggregation {@link #getItems items}.
*
* The RadioButtons of this RadioButtonGroup.
* @returns {sap.ui.core.Item[]}
*/
public getItems(): sap.ui.core.Item[];
/**
* Returns a metadata object for class sap.ui.commons.RadioButtonGroup.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSelectedIndex selectedIndex}.
*
* The index of the selected/checked RadioButton.
*
* Default value is 0
.
* @returns {number} Value of property selectedIndex
*/
public getSelectedIndex(): number;
/**
* When no item is selected, "null" is returned.
* @returns {sap.ui.core.Item} Selected Item
*/
public getSelectedItem(): sap.ui.core.Item;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Тhe value state to be displayed for the RadioButton. Possible values are: sap.ui.core.ValueState.Error,
* sap.ui.core.ValueState.Warning, sap.ui.core.ValueState.Success and sap.ui.core.ValueState.None.
* Note: Setting this attribute to sap.ui.core.ValueState.Error when the accessibility feature is enabled,
* sets the value of the invalid property for the whole RadioButtonGroup to true.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the RadioButtonGroup.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Item
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Item} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.core.Item): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.ui.core.Item} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.ui.core.Item, iIndex: number): sap.ui.commons.RadioButtonGroup;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Item[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.ui.core.Item[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.ui.core.Item} vItem - The item to remove or its index or id
* @returns {sap.ui.core.Item} The removed item or null
*/
public removeItem(vItem: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Sets a new value for property {@link #getColumns columns}.
*
* Determines the maximum number of RadioButtons displayed in one line.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} iColumns - New value for property columns
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public setColumns(iColumns: number): sap.ui.commons.RadioButtonGroup;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Specifies whether the user can change the selected value of the RadioButtonGroup.
* When the property is set to false, the control obtains visual styles
* different from its visual styles for the normal and the disabled state.
* Additionally the control is no longer interactive, but can receive focus.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.ui.commons.RadioButtonGroup;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Enables/disables the RadioButtonGroup. If it is disabled all RadioButtons will be displayed as disabled.
* The enabled property of the Item will not be used in this case. If the RadioButtonGroup is enabled, the
* enabled property of the Item will define if a RadioButton is enabled or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.RadioButtonGroup;
/**
* Sets a new value for property {@link #getSelectedIndex selectedIndex}.
*
* The index of the selected/checked RadioButton.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iSelectedIndex - New value for property selectedIndex
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public setSelectedIndex(iSelectedIndex: number): sap.ui.commons.RadioButtonGroup;
/**
* Sets the Item as selected and removes the selection from the previous one.
* @param {sap.ui.core.Item} oSelectedItem - Selected item
*/
public setSelectedItem(oSelectedItem: sap.ui.core.Item): void;
/**
* Sets a new value for property {@link #getValueState valueState}.
*
* Тhe value state to be displayed for the RadioButton. Possible values are: sap.ui.core.ValueState.Error,
* sap.ui.core.ValueState.Warning, sap.ui.core.ValueState.Success and sap.ui.core.ValueState.None.
* Note: Setting this attribute to sap.ui.core.ValueState.Error when the accessibility feature is enabled,
* sets the value of the invalid property for the whole RadioButtonGroup to true.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sValueState - New value for property valueState
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public setValueState(sValueState: sap.ui.core.ValueState): sap.ui.commons.RadioButtonGroup;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Defines the width of the RadioButtonGroup.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.RadioButtonGroup;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.ui.commons.RadioButtonGroup} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.ui.commons.RadioButtonGroup;
}
/**
* The interactive control is displayed either as a horizontal or a vertical line with two pointers and units of measurement.
* Users can move the pointers along the line to change a range with graphical support.
*/
export class RangeSlider extends sap.ui.commons.Slider {
/**
* Constructor for a new RangeSlider
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.RangeSlider with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.commons.Slider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.RangeSlider.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getValue2 value2}.
*
* Current second value of the slider. (Position of the second grip.)
*
* Note: If the value is not in the valid range (between min
and max
) it will be changed to be in the valid range.
* If it is smaller than value
it will be set to the same value.
*
* Default value is 80
.
* @returns {number} Value of property value2
*/
public getValue2(): number;
/**
* Sets a new value for property {@link #getValue2 value2}.
*
* Current second value of the slider. (Position of the second grip.)
*
* Note: If the value is not in the valid range (between min
and max
) it will be changed to be in the valid range.
* If it is smaller than value
it will be set to the same value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 80
.
* @param {number} fValue2 - New value for property value2
* @returns {sap.ui.commons.RangeSlider} Reference to this
in order to allow method chaining
*/
public setValue2(fValue2: number): sap.ui.commons.RangeSlider;
}
/**
* RatingIndicator is used to let the user do some rating on a given topic. The amount of
* rating symbols can be specified, as well as the URIs to the image icons which shall be
* used as rating symbols. When the user performs a rating, an event is fired.
*/
export class RatingIndicator extends sap.ui.core.Control {
/**
* Constructor for a new RatingIndicator.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.RatingIndicator} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.RatingIndicator;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.RatingIndicator} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.RatingIndicator;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.commons.RatingIndicator
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RatingIndicator
itself.
*
* The event is fired when the user has done a rating.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RatingIndicator
itself
* @returns {sap.ui.commons.RatingIndicator} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.ui.commons.RatingIndicator;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.commons.RatingIndicator
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RatingIndicator
itself.
*
* The event is fired when the user has done a rating.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RatingIndicator
itself
* @returns {sap.ui.commons.RatingIndicator} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.RatingIndicator;
/**
* Binds property {@link #getValue value} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a
* detailed description of the possible properties of oBindingInfo
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.commons.RatingIndicator} Reference to this
in order to allow method chaining
*/
public bindValue(oBindingInfo: any): sap.ui.commons.RatingIndicator;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.ui.commons.RatingIndicator
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.RatingIndicator} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.ui.commons.RatingIndicator;
/**
* Creates a new subclass of class sap.ui.commons.RatingIndicator with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.RatingIndicator} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.ui.commons.RatingIndicator;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getAverageValue averageValue}.
*
* Determines the average value. This value is shown if no value is set.
* This can be used to display an average Value before the user votes.
*
* Default value is 0
.
* @returns {number} Value of property averageValue
*/
public getAverageValue(): number;
/**
* Gets current value of property {@link #getEditable editable}.
*
* Determines if the rating symbols can be edited.
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getIconHovered iconHovered}.
*
* The URI to the image which is displayed when the mouse hovers onto a rating symbol.
* If used, a requirement is that all custom icons need to have the same size.
* Note that when this attribute is used also the other icon attributes need to be set.
* @returns {sap.ui.core.URI} Value of property iconHovered
*/
public getIconHovered(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconSelected iconSelected}.
*
* The URI to the image which shall be displayed for all selected rating symbols.
* Note that when this attribute is used, also the other icon attributes need to be set.
* @returns {sap.ui.core.URI} Value of property iconSelected
*/
public getIconSelected(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconUnselected iconUnselected}.
*
* The URI to the image which shall be displayed for all unselected rating symbols.
* If this attribute is used, a requirement is that all custom icons need to have the same size.
* Note that when this attribute is used also the other icon attributes need to be set.
* @returns {sap.ui.core.URI} Value of property iconUnselected
*/
public getIconUnselected(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getMaxValue maxValue}.
*
* Determines the number of displayed rating symbols
*
* Default value is 5
.
* @returns {number} Value of property maxValue
*/
public getMaxValue(): number;
/**
* Returns a metadata object for class sap.ui.commons.RatingIndicator.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getValue value}.
*
* Determines the currently selected value. If value is set to sap.ui.commons.RatingIndicator.NoValue,
* the averageValue is shown.
*
* Default value is 0
.
* @returns {number} Value of property value
*/
public getValue(): number;
/**
* Gets current value of property {@link #getVisualMode visualMode}.
*
* Defines how float values are visualized: Full, Half, Continuous
* (see enumeration RatingIndicatorVisualMode)
*
* Default value is Half
.
* @returns {sap.ui.commons.RatingIndicatorVisualMode} Value of property visualMode
*/
public getVisualMode(): sap.ui.commons.RatingIndicatorVisualMode;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getAverageValue averageValue}.
*
* Determines the average value. This value is shown if no value is set.
* This can be used to display an average Value before the user votes.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} fAverageValue - New value for property averageValue
* @returns {sap.ui.commons.RatingIndicator} Reference to this
in order to allow method chaining
*/
public setAverageValue(fAverageValue: number): sap.ui.commons.RatingIndicator;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Determines if the rating symbols can be edited.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.ui.commons.RatingIndicator} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.ui.commons.RatingIndicator;
/**
* Sets a new value for property {@link #getIconHovered iconHovered}.
*
* The URI to the image which is displayed when the mouse hovers onto a rating symbol.
* If used, a requirement is that all custom icons need to have the same size.
* Note that when this attribute is used also the other icon attributes need to be set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIconHovered - New value for property iconHovered
* @returns {sap.ui.commons.RatingIndicator} Reference to this
in order to allow method chaining
*/
public setIconHovered(sIconHovered: sap.ui.core.URI): sap.ui.commons.RatingIndicator;
/**
* Sets a new value for property {@link #getIconSelected iconSelected}.
*
* The URI to the image which shall be displayed for all selected rating symbols.
* Note that when this attribute is used, also the other icon attributes need to be set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIconSelected - New value for property iconSelected
* @returns {sap.ui.commons.RatingIndicator} Reference to this
in order to allow method chaining
*/
public setIconSelected(sIconSelected: sap.ui.core.URI): sap.ui.commons.RatingIndicator;
/**
* Sets a new value for property {@link #getIconUnselected iconUnselected}.
*
* The URI to the image which shall be displayed for all unselected rating symbols.
* If this attribute is used, a requirement is that all custom icons need to have the same size.
* Note that when this attribute is used also the other icon attributes need to be set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIconUnselected - New value for property iconUnselected
* @returns {sap.ui.commons.RatingIndicator} Reference to this
in order to allow method chaining
*/
public setIconUnselected(sIconUnselected: sap.ui.core.URI): sap.ui.commons.RatingIndicator;
/**
* Setter for property maxValue
.
*
* Default value is 5
* Minimum value is 1
* @param {number} iMaxValue - new value for property maxValue
* @returns {sap.ui.commons.RatingIndicator} this
to allow method chaining
*/
public setMaxValue(iMaxValue: number): sap.ui.commons.RatingIndicator;
/**
* Sets a new value for property {@link #getValue value}.
*
* Determines the currently selected value. If value is set to sap.ui.commons.RatingIndicator.NoValue,
* the averageValue is shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} fValue - New value for property value
* @returns {sap.ui.commons.RatingIndicator} Reference to this
in order to allow method chaining
*/
public setValue(fValue: number): sap.ui.commons.RatingIndicator;
/**
* Sets a new value for property {@link #getVisualMode visualMode}.
*
* Defines how float values are visualized: Full, Half, Continuous
* (see enumeration RatingIndicatorVisualMode)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Half
.
* @param {sap.ui.commons.RatingIndicatorVisualMode} sVisualMode - New value for property visualMode
* @returns {sap.ui.commons.RatingIndicator} Reference to this
in order to allow method chaining
*/
public setVisualMode(sVisualMode: sap.ui.commons.RatingIndicatorVisualMode): sap.ui.commons.RatingIndicator;
/**
* Unbinds property {@link #getValue value} from model data.
* @returns {sap.ui.commons.RatingIndicator} Reference to this
in order to allow method chaining
*/
public unbindValue(): sap.ui.commons.RatingIndicator;
}
/**
* Possible values for the visualization of float values in the RatingIndicator Control.
*/
export enum RatingIndicatorVisualMode {
/**
* Values are not rounded.
*/
Continuous = "Continuous",
/**
* Values are rounded to the nearest integer value (e.g. 1.7 -> 2).
*/
Full = "Full",
/**
* Values are rounded to the nearest half value (e.g. 1.7 -> 1.5).
*/
Half = "Half",
}
/**
* Is used to provide a container, which can show different content depending on its current width. It fires an event, whenever a new range is reached. In addition the content of the new range is automatically shown, if it is set.
*/
export class ResponsiveContainer extends sap.ui.core.Control {
/**
* Constructor for a new ResponsiveContainer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some range to the aggregation {@link #getRanges ranges}.
* @param {sap.ui.commons.ResponsiveContainerRange} oRange - the range to add; if empty, nothing is inserted
* @returns {sap.ui.commons.ResponsiveContainer} Reference to this
in order to allow method chaining
*/
public addRange(oRange: sap.ui.commons.ResponsiveContainerRange): sap.ui.commons.ResponsiveContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:rangeSwitch rangeSwitch} event of this sap.ui.commons.ResponsiveContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.ResponsiveContainer
itself.
*
* The event is fired the width of the container reaches a new range.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.ResponsiveContainer
itself
* @returns {sap.ui.commons.ResponsiveContainer} Reference to this
in order to allow method chaining
*/
public attachRangeSwitch(fnFunction: Function, oListener?: any): sap.ui.commons.ResponsiveContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:rangeSwitch rangeSwitch} event of this sap.ui.commons.ResponsiveContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.ResponsiveContainer
itself.
*
* The event is fired the width of the container reaches a new range.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.ResponsiveContainer
itself
* @returns {sap.ui.commons.ResponsiveContainer} Reference to this
in order to allow method chaining
*/
public attachRangeSwitch(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.ResponsiveContainer;
/**
* Destroys all the ranges in the aggregation {@link #getRanges ranges}.
* @returns {sap.ui.commons.ResponsiveContainer} Reference to this
in order to allow method chaining
*/
public destroyRanges(): sap.ui.commons.ResponsiveContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:rangeSwitch rangeSwitch} event of this sap.ui.commons.ResponsiveContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.ResponsiveContainer} Reference to this
in order to allow method chaining
*/
public detachRangeSwitch(fnFunction: Function, oListener: any): sap.ui.commons.ResponsiveContainer;
/**
* Creates a new subclass of class sap.ui.commons.ResponsiveContainer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:rangeSwitch rangeSwitch} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.ResponsiveContainer} Reference to this
in order to allow method chaining
*/
protected fireRangeSwitch(mParameters?: any): sap.ui.commons.ResponsiveContainer;
/**
* ID of the element which is the current target of the association {@link #getDefaultContent defaultContent}, or null
.
* @returns {sap.ui.core.ID}
*/
public getDefaultContent(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getHeight height}.
*
* The width of the responsive container.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.commons.ResponsiveContainer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getRanges ranges}.
*
* The ranges defined for this container
* @returns {sap.ui.commons.ResponsiveContainerRange[]}
*/
public getRanges(): sap.ui.commons.ResponsiveContainerRange[];
/**
* Gets current value of property {@link #getWidth width}.
*
* The width of the responsive container.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.commons.ResponsiveContainerRange
in the aggregation {@link #getRanges ranges}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.ResponsiveContainerRange} oRange - The range whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfRange(oRange: sap.ui.commons.ResponsiveContainerRange): number;
/**
* Inserts a range into the aggregation {@link #getRanges ranges}.
* @param {sap.ui.commons.ResponsiveContainerRange} oRange - the range to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the range should be inserted at; for a negative value of iIndex
, the range is inserted at position 0; for a value greater than the current size of the aggregation, the range is inserted at the last position
* @returns {sap.ui.commons.ResponsiveContainer} Reference to this
in order to allow method chaining
*/
public insertRange(oRange: sap.ui.commons.ResponsiveContainerRange, iIndex: number): sap.ui.commons.ResponsiveContainer;
/**
* Removes all the controls from the aggregation {@link #getRanges ranges}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.ResponsiveContainerRange[]} An array of the removed elements (might be empty)
*/
public removeAllRanges(): sap.ui.commons.ResponsiveContainerRange[];
/**
* Removes a range from the aggregation {@link #getRanges ranges}.
* @param {number|string|sap.ui.commons.ResponsiveContainerRange} vRange - The range to remove or its index or id
* @returns {sap.ui.commons.ResponsiveContainerRange} The removed range or null
*/
public removeRange(vRange: number|string|sap.ui.commons.ResponsiveContainerRange): sap.ui.commons.ResponsiveContainerRange;
/**
* Sets the associated {@link #getDefaultContent defaultContent}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oDefaultContent - ID of an element which becomes the new target of this defaultContent association; alternatively, an element instance may be given
* @returns {sap.ui.commons.ResponsiveContainer} Reference to this
in order to allow method chaining
*/
public setDefaultContent(oDefaultContent: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.ResponsiveContainer;
/**
* Sets a new value for property {@link #getHeight height}.
*
* The width of the responsive container.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.commons.ResponsiveContainer} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.ResponsiveContainer;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The width of the responsive container.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.ResponsiveContainer} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.ResponsiveContainer;
}
/**
* Defines a range for the ResponsiveContainer
*/
export class ResponsiveContainerRange extends sap.ui.core.Element {
/**
* Constructor for a new ResponsiveContainerRange.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.ResponsiveContainerRange with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* ID of the element which is the current target of the association {@link #getContent content}, or null
.
* @returns {sap.ui.core.ID}
*/
public getContent(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getHeight height}.
*
* The minimal height for this range to be displayed.
*
* Default value is
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getKey key}.
*
* A key which can be used to identify the range (optional).
*
* Default value is
.
* @returns {string} Value of property key
*/
public getKey(): string;
/**
* Returns a metadata object for class sap.ui.commons.ResponsiveContainerRange.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getWidth width}.
*
* The minimal width for this range to be displayed.
*
* Default value is
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets the associated {@link #getContent content}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oContent - ID of an element which becomes the new target of this content association; alternatively, an element instance may be given
* @returns {sap.ui.commons.ResponsiveContainerRange} Reference to this
in order to allow method chaining
*/
public setContent(oContent: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.ResponsiveContainerRange;
/**
* Sets a new value for property {@link #getHeight height}.
*
* The minimal height for this range to be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.commons.ResponsiveContainerRange} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.ResponsiveContainerRange;
/**
* Sets a new value for property {@link #getKey key}.
*
* A key which can be used to identify the range (optional).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sKey - New value for property key
* @returns {sap.ui.commons.ResponsiveContainerRange} Reference to this
in order to allow method chaining
*/
public setKey(sKey: string): sap.ui.commons.ResponsiveContainerRange;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The minimal width for this range to be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.ResponsiveContainerRange} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.ResponsiveContainerRange;
}
/**
* Is used to provide tool tips that can have long text, image and title. This tool tip extends the TooltipBase.
*/
export class RichTooltip extends sap.ui.core.TooltipBase {
/**
* Constructor for a new RichTooltip.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.RichTooltip with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.TooltipBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getImageAltText imageAltText}.
*
* This is the alt text for the image
* @returns {string} Value of property imageAltText
*/
public getImageAltText(): string;
/**
* Gets current value of property {@link #getImageSrc imageSrc}.
*
* If RichTooltip contains an image, this property is used to define the source path.
* @returns {sap.ui.core.URI} Value of property imageSrc
*/
public getImageSrc(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.ui.commons.RichTooltip.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTitle title}.
*
* Tool tip title to be displayed in the header.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* This returns the previously set text. Since a FormattedTextView is used for
* rendering and stuff the corresponding property of the FormattedTextView is
* being read and returned. If no text was set an empty string is being
* returned.
* @returns {string} the ValueState text that was previously set.
*/
public getValueStateText(): string;
/**
* Calculates the height of the RichTooltip to set a proper min-height.
* Additionally the ARIA attributes are set to the corresponding elements.
*/
protected onAfterRendering(): void;
/**
* Sets a new value for property {@link #getImageAltText imageAltText}.
*
* This is the alt text for the image
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sImageAltText - New value for property imageAltText
* @returns {sap.ui.commons.RichTooltip} Reference to this
in order to allow method chaining
*/
public setImageAltText(sImageAltText: string): sap.ui.commons.RichTooltip;
/**
* Sets a new value for property {@link #getImageSrc imageSrc}.
*
* If RichTooltip contains an image, this property is used to define the source path.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sImageSrc - New value for property imageSrc
* @returns {sap.ui.commons.RichTooltip} Reference to this
in order to allow method chaining
*/
public setImageSrc(sImageSrc: sap.ui.core.URI): sap.ui.commons.RichTooltip;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Tool tip title to be displayed in the header.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.commons.RichTooltip} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.commons.RichTooltip;
/**
* This sets an individual text for the ValueState of the parent element of the RichTooltip.
* @param {string} sText - the text that should be shown as individual ValueState text
* @returns {sap.ui.commons.RichTooltip} Returns this
to facilitate method chaining.
*/
public setValueStateText(sText: string): sap.ui.commons.RichTooltip;
}
/**
* RoadMap is used to display step-by-step work flows of a clearly defined work process.
*/
export class RoadMap extends sap.ui.core.Control {
/**
* Constructor for a new RoadMap.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some step to the aggregation {@link #getSteps steps}.
* @param {sap.ui.commons.RoadMapStep} oStep - the step to add; if empty, nothing is inserted
* @returns {sap.ui.commons.RoadMap} Reference to this
in order to allow method chaining
*/
public addStep(oStep: sap.ui.commons.RoadMapStep): sap.ui.commons.RoadMap;
/**
* Attaches event handler fnFunction
to the {@link #event:stepExpanded stepExpanded} event of this sap.ui.commons.RoadMap
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RoadMap
itself.
*
* Event is fired when a given step is expanded or collapsed by user.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RoadMap
itself
* @returns {sap.ui.commons.RoadMap} Reference to this
in order to allow method chaining
*/
public attachStepExpanded(fnFunction: Function, oListener?: any): sap.ui.commons.RoadMap;
/**
* Attaches event handler fnFunction
to the {@link #event:stepExpanded stepExpanded} event of this sap.ui.commons.RoadMap
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RoadMap
itself.
*
* Event is fired when a given step is expanded or collapsed by user.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RoadMap
itself
* @returns {sap.ui.commons.RoadMap} Reference to this
in order to allow method chaining
*/
public attachStepExpanded(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.RoadMap;
/**
* Attaches event handler fnFunction
to the {@link #event:stepSelected stepSelected} event of this sap.ui.commons.RoadMap
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RoadMap
itself.
*
* Event is fired when the user selects a step.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RoadMap
itself
* @returns {sap.ui.commons.RoadMap} Reference to this
in order to allow method chaining
*/
public attachStepSelected(fnFunction: Function, oListener?: any): sap.ui.commons.RoadMap;
/**
* Attaches event handler fnFunction
to the {@link #event:stepSelected stepSelected} event of this sap.ui.commons.RoadMap
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RoadMap
itself.
*
* Event is fired when the user selects a step.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RoadMap
itself
* @returns {sap.ui.commons.RoadMap} Reference to this
in order to allow method chaining
*/
public attachStepSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.RoadMap;
/**
* Destroys all the steps in the aggregation {@link #getSteps steps}.
* @returns {sap.ui.commons.RoadMap} Reference to this
in order to allow method chaining
*/
public destroySteps(): sap.ui.commons.RoadMap;
/**
* Detaches event handler fnFunction
from the {@link #event:stepExpanded stepExpanded} event of this sap.ui.commons.RoadMap
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.RoadMap} Reference to this
in order to allow method chaining
*/
public detachStepExpanded(fnFunction: Function, oListener: any): sap.ui.commons.RoadMap;
/**
* Detaches event handler fnFunction
from the {@link #event:stepSelected stepSelected} event of this sap.ui.commons.RoadMap
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.RoadMap} Reference to this
in order to allow method chaining
*/
public detachStepSelected(fnFunction: Function, oListener: any): sap.ui.commons.RoadMap;
/**
* Creates a new subclass of class sap.ui.commons.RoadMap with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:stepExpanded stepExpanded} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.RoadMap} Reference to this
in order to allow method chaining
*/
protected fireStepExpanded(mParameters?: any): sap.ui.commons.RoadMap;
/**
* Fires event {@link #event:stepSelected stepSelected} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.RoadMap} Reference to this
in order to allow method chaining
*/
protected fireStepSelected(mParameters?: any): sap.ui.commons.RoadMap;
/**
* Gets current value of property {@link #getFirstVisibleStep firstVisibleStep}.
*
* ID of the first step to be displayed
* @returns {string} Value of property firstVisibleStep
*/
public getFirstVisibleStep(): string;
/**
* Returns a metadata object for class sap.ui.commons.RoadMap.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getNumberOfVisibleSteps numberOfVisibleSteps}.
*
* Total number of steps to be displayed at once
* @returns {number} Value of property numberOfVisibleSteps
*/
public getNumberOfVisibleSteps(): number;
/**
* Gets current value of property {@link #getSelectedStep selectedStep}.
*
* ID of the step which is currently selected
* @returns {string} Value of property selectedStep
*/
public getSelectedStep(): string;
/**
* Gets content of aggregation {@link #getSteps steps}.
*
* Steps that are composing the RoadMap
* @returns {sap.ui.commons.RoadMapStep[]}
*/
public getSteps(): sap.ui.commons.RoadMapStep[];
/**
* Gets current value of property {@link #getWidth width}.
*
* Determines the control width in CSS size
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.commons.RoadMapStep
in the aggregation {@link #getSteps steps}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.RoadMapStep} oStep - The step whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfStep(oStep: sap.ui.commons.RoadMapStep): number;
/**
* Inserts a step into the aggregation {@link #getSteps steps}.
* @param {sap.ui.commons.RoadMapStep} oStep - the step to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the step should be inserted at; for a negative value of iIndex
, the step is inserted at position 0; for a value greater than the current size of the aggregation, the step is inserted at the last position
* @returns {sap.ui.commons.RoadMap} Reference to this
in order to allow method chaining
*/
public insertStep(oStep: sap.ui.commons.RoadMapStep, iIndex: number): sap.ui.commons.RoadMap;
/**
* Removes all the controls from the aggregation {@link #getSteps steps}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.RoadMapStep[]} An array of the removed elements (might be empty)
*/
public removeAllSteps(): sap.ui.commons.RoadMapStep[];
/**
* Removes a step from the aggregation {@link #getSteps steps}.
* @param {number|string|sap.ui.commons.RoadMapStep} vStep - The step to remove or its index or id
* @returns {sap.ui.commons.RoadMapStep} The removed step or null
*/
public removeStep(vStep: number|string|sap.ui.commons.RoadMapStep): sap.ui.commons.RoadMapStep;
/**
* Sets a new value for property {@link #getFirstVisibleStep firstVisibleStep}.
*
* ID of the first step to be displayed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sFirstVisibleStep - New value for property firstVisibleStep
* @returns {sap.ui.commons.RoadMap} Reference to this
in order to allow method chaining
*/
public setFirstVisibleStep(sFirstVisibleStep: string): sap.ui.commons.RoadMap;
/**
* Sets a new value for property {@link #getNumberOfVisibleSteps numberOfVisibleSteps}.
*
* Total number of steps to be displayed at once
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iNumberOfVisibleSteps - New value for property numberOfVisibleSteps
* @returns {sap.ui.commons.RoadMap} Reference to this
in order to allow method chaining
*/
public setNumberOfVisibleSteps(iNumberOfVisibleSteps: number): sap.ui.commons.RoadMap;
/**
* Sets a new value for property {@link #getSelectedStep selectedStep}.
*
* ID of the step which is currently selected
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sSelectedStep - New value for property selectedStep
* @returns {sap.ui.commons.RoadMap} Reference to this
in order to allow method chaining
*/
public setSelectedStep(sSelectedStep: string): sap.ui.commons.RoadMap;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Determines the control width in CSS size
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.RoadMap} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.RoadMap;
}
/**
* Step used within a RoadMap Control.
*/
export class RoadMapStep extends sap.ui.core.Element {
/**
* Constructor for a new RoadMapStep.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some subStep to the aggregation {@link #getSubSteps subSteps}.
* @param {sap.ui.commons.RoadMapStep} oSubStep - the subStep to add; if empty, nothing is inserted
* @returns {sap.ui.commons.RoadMapStep} Reference to this
in order to allow method chaining
*/
public addSubStep(oSubStep: sap.ui.commons.RoadMapStep): sap.ui.commons.RoadMapStep;
/**
* Destroys all the subSteps in the aggregation {@link #getSubSteps subSteps}.
* @returns {sap.ui.commons.RoadMapStep} Reference to this
in order to allow method chaining
*/
public destroySubSteps(): sap.ui.commons.RoadMapStep;
/**
* Creates a new subclass of class sap.ui.commons.RoadMapStep with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Specifies whether the user shall be allowed to click a step, or not
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getExpanded expanded}.
*
* This property is only relevant when using sub steps.
*
* Default value is false
.
* @returns {boolean} Value of property expanded
*/
public getExpanded(): boolean;
/**
* Gets current value of property {@link #getLabel label}.
*
* Label of the step
* @returns {string} Value of property label
*/
public getLabel(): string;
/**
* Returns a metadata object for class sap.ui.commons.RoadMapStep.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getSubSteps subSteps}.
*
* Sub steps for the current step. Will be displayed only in the case that the step is expanded. Otherwise, special arrows show the availability
* of sub steps. One level of sub steps supported.
* @returns {sap.ui.commons.RoadMapStep[]}
*/
public getSubSteps(): sap.ui.commons.RoadMapStep[];
/**
* Gets current value of property {@link #getVisible visible}.
*
* Step is visible
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Checks for the provided sap.ui.commons.RoadMapStep
in the aggregation {@link #getSubSteps subSteps}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.RoadMapStep} oSubStep - The subStep whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSubStep(oSubStep: sap.ui.commons.RoadMapStep): number;
/**
* Inserts a subStep into the aggregation {@link #getSubSteps subSteps}.
* @param {sap.ui.commons.RoadMapStep} oSubStep - the subStep to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the subStep should be inserted at; for a negative value of iIndex
, the subStep is inserted at position 0; for a value greater than the current size of the aggregation, the subStep is inserted at the last position
* @returns {sap.ui.commons.RoadMapStep} Reference to this
in order to allow method chaining
*/
public insertSubStep(oSubStep: sap.ui.commons.RoadMapStep, iIndex: number): sap.ui.commons.RoadMapStep;
/**
* Removes all the controls from the aggregation {@link #getSubSteps subSteps}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.RoadMapStep[]} An array of the removed elements (might be empty)
*/
public removeAllSubSteps(): sap.ui.commons.RoadMapStep[];
/**
* Removes a subStep from the aggregation {@link #getSubSteps subSteps}.
* @param {number|string|sap.ui.commons.RoadMapStep} vSubStep - The subStep to remove or its index or id
* @returns {sap.ui.commons.RoadMapStep} The removed subStep or null
*/
public removeSubStep(vSubStep: number|string|sap.ui.commons.RoadMapStep): sap.ui.commons.RoadMapStep;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Specifies whether the user shall be allowed to click a step, or not
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.commons.RoadMapStep} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.RoadMapStep;
/**
* Sets a new value for property {@link #getExpanded expanded}.
*
* This property is only relevant when using sub steps.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bExpanded - New value for property expanded
* @returns {sap.ui.commons.RoadMapStep} Reference to this
in order to allow method chaining
*/
public setExpanded(bExpanded: boolean): sap.ui.commons.RoadMapStep;
/**
* Sets a new value for property {@link #getLabel label}.
*
* Label of the step
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sLabel - New value for property label
* @returns {sap.ui.commons.RoadMapStep} Reference to this
in order to allow method chaining
*/
public setLabel(sLabel: string): sap.ui.commons.RoadMapStep;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Step is visible
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.ui.commons.RoadMapStep} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.commons.RoadMapStep;
}
/**
* This control displays items in a stacked list format, allowing the user to page in order to see more items or to use the offered filtering and sorting capabilities in order to manipulate the displayed data.
*/
export class RowRepeater extends sap.ui.core.Control {
/**
* Constructor for a new RowRepeater.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some filter to the aggregation {@link #getFilters filters}.
* @param {sap.ui.commons.RowRepeaterFilter} oFilter - the filter to add; if empty, nothing is inserted
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public addFilter(oFilter: sap.ui.commons.RowRepeaterFilter): sap.ui.commons.RowRepeater;
/**
* Adds some row to the aggregation {@link #getRows rows}.
* @param {sap.ui.core.Control} oRow - the row to add; if empty, nothing is inserted
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public addRow(oRow: sap.ui.core.Control): sap.ui.commons.RowRepeater;
/**
* Adds some sorter to the aggregation {@link #getSorters sorters}.
* @param {sap.ui.commons.RowRepeaterSorter} oSorter - the sorter to add; if empty, nothing is inserted
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public addSorter(oSorter: sap.ui.commons.RowRepeaterSorter): sap.ui.commons.RowRepeater;
/**
* Applies a filter.
* @param {string} sId - The ID if the filter.
*/
public applyFilter(sId: string): void;
/**
* Attaches event handler fnFunction
to the {@link #event:filter filter} event of this sap.ui.commons.RowRepeater
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RowRepeater
itself.
*
* This event is triggered when a filter is set.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RowRepeater
itself
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public attachFilter(fnFunction: Function, oListener?: any): sap.ui.commons.RowRepeater;
/**
* Attaches event handler fnFunction
to the {@link #event:filter filter} event of this sap.ui.commons.RowRepeater
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RowRepeater
itself.
*
* This event is triggered when a filter is set.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RowRepeater
itself
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public attachFilter(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.RowRepeater;
/**
* Attaches event handler fnFunction
to the {@link #event:page page} event of this sap.ui.commons.RowRepeater
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RowRepeater
itself.
*
* This event is triggered when paging was executed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RowRepeater
itself
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public attachPage(fnFunction: Function, oListener?: any): sap.ui.commons.RowRepeater;
/**
* Attaches event handler fnFunction
to the {@link #event:page page} event of this sap.ui.commons.RowRepeater
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RowRepeater
itself.
*
* This event is triggered when paging was executed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RowRepeater
itself
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public attachPage(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.RowRepeater;
/**
* Attaches event handler fnFunction
to the {@link #event:resize resize} event of this sap.ui.commons.RowRepeater
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RowRepeater
itself.
*
* This event is triggered when the number of rows was changed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RowRepeater
itself
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public attachResize(fnFunction: Function, oListener?: any): sap.ui.commons.RowRepeater;
/**
* Attaches event handler fnFunction
to the {@link #event:resize resize} event of this sap.ui.commons.RowRepeater
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RowRepeater
itself.
*
* This event is triggered when the number of rows was changed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RowRepeater
itself
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public attachResize(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.RowRepeater;
/**
* Attaches event handler fnFunction
to the {@link #event:sort sort} event of this sap.ui.commons.RowRepeater
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RowRepeater
itself.
*
* This event is triggered when a sorting is applied.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RowRepeater
itself
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public attachSort(fnFunction: Function, oListener?: any): sap.ui.commons.RowRepeater;
/**
* Attaches event handler fnFunction
to the {@link #event:sort sort} event of this sap.ui.commons.RowRepeater
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.RowRepeater
itself.
*
* This event is triggered when a sorting is applied.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.RowRepeater
itself
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public attachSort(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.RowRepeater;
/**
* Binds aggregation {@link #getRows rows} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public bindRows(oBindingInfo: any): sap.ui.commons.RowRepeater;
/**
* Destroys all the filters in the aggregation {@link #getFilters filters}.
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public destroyFilters(): sap.ui.commons.RowRepeater;
/**
* Destroys the noData in the aggregation {@link #getNoData noData}.
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public destroyNoData(): sap.ui.commons.RowRepeater;
/**
* Destroys all the rows in the aggregation {@link #getRows rows}.
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public destroyRows(): sap.ui.commons.RowRepeater;
/**
* Destroys all the sorters in the aggregation {@link #getSorters sorters}.
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public destroySorters(): sap.ui.commons.RowRepeater;
/**
* Destroys the title in the aggregation {@link #getTitle title}.
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public destroyTitle(): sap.ui.commons.RowRepeater;
/**
* Detaches event handler fnFunction
from the {@link #event:filter filter} event of this sap.ui.commons.RowRepeater
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public detachFilter(fnFunction: Function, oListener: any): sap.ui.commons.RowRepeater;
/**
* Detaches event handler fnFunction
from the {@link #event:page page} event of this sap.ui.commons.RowRepeater
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public detachPage(fnFunction: Function, oListener: any): sap.ui.commons.RowRepeater;
/**
* Detaches event handler fnFunction
from the {@link #event:resize resize} event of this sap.ui.commons.RowRepeater
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public detachResize(fnFunction: Function, oListener: any): sap.ui.commons.RowRepeater;
/**
* Detaches event handler fnFunction
from the {@link #event:sort sort} event of this sap.ui.commons.RowRepeater
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public detachSort(fnFunction: Function, oListener: any): sap.ui.commons.RowRepeater;
/**
* Creates a new subclass of class sap.ui.commons.RowRepeater with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:filter filter} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
protected fireFilter(mParameters?: any): sap.ui.commons.RowRepeater;
/**
* Fires event {@link #event:page page} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
protected firePage(mParameters?: any): sap.ui.commons.RowRepeater;
/**
* Fires event {@link #event:resize resize} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
protected fireResize(mParameters?: any): sap.ui.commons.RowRepeater;
/**
* Fires event {@link #event:sort sort} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
protected fireSort(mParameters?: any): sap.ui.commons.RowRepeater;
/**
* Switch to first page.
*/
public firstPage(): void;
/**
* Gets current value of property {@link #getCurrentPage currentPage}.
*
* The index of the page currently displayed. The index starts at 1.
*
* Default value is 1
.
* @returns {number} Value of property currentPage
*/
public getCurrentPage(): number;
/**
* Gets current value of property {@link #getDesign design}.
*
* The visual design of the control.
*
* Default value is Standard
.
* @returns {sap.ui.commons.RowRepeaterDesign} Value of property design
*/
public getDesign(): sap.ui.commons.RowRepeaterDesign;
/**
* Gets content of aggregation {@link #getFilters filters}.
*
* Filters to be provided in toolbar.
* @returns {sap.ui.commons.RowRepeaterFilter[]}
*/
public getFilters(): sap.ui.commons.RowRepeaterFilter[];
/**
* Gets current value of property {@link #getFixedRowHeight fixedRowHeight}.
*
* Row height adapts to rendered content. If a fixed height is specified the cells have a maximum height and the overflow will be hidden.
*
* Default value is
.
* @returns {sap.ui.core.CSSSize} Value of property fixedRowHeight
*/
public getFixedRowHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.commons.RowRepeater.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getNoData noData}.
*
* This control is shown, in case there is no data available to be displayed in the RowRepeater.
* @returns {sap.ui.core.Control}
*/
public getNoData(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getNumberOfRows numberOfRows}.
*
* Number of rows displayed.
*
* Default value is 5
.
* @returns {number} Value of property numberOfRows
*/
public getNumberOfRows(): number;
/**
* Gets content of aggregation {@link #getRows rows}.
*
* Rows to be repeated.
* @returns {sap.ui.core.Control[]}
*/
public getRows(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getShowMoreSteps showMoreSteps}.
*
* Step size used to increase the numberOfRows value. This feature is only active if value is greater than 0. This will deactivate the paging feature.
*
* Default value is 0
.
* @returns {number} Value of property showMoreSteps
*/
public getShowMoreSteps(): number;
/**
* Gets content of aggregation {@link #getSorters sorters}.
*
* Sorters to be provided in secondary toolbar.
* @returns {sap.ui.commons.RowRepeaterSorter[]}
*/
public getSorters(): sap.ui.commons.RowRepeaterSorter[];
/**
* Gets current value of property {@link #getThreshold threshold}.
*
* Threshold to fetch the next chunk of data. The minimal threshold can be the numberOfRows of the RR.
* @returns {number} Value of property threshold
*/
public getThreshold(): number;
/**
* Gets content of aggregation {@link #getTitle title}.
*
* Title to be displayed in top left corner. Either text or icon.
* @returns {sap.ui.core.Title}
*/
public getTitle(): sap.ui.core.Title;
/**
* Switch to specified page.
* @param {number} iPageNumber - The index of the page to go to.
*/
public gotoPage(iPageNumber: number): void;
/**
* Checks for the provided sap.ui.commons.RowRepeaterFilter
in the aggregation {@link #getFilters filters}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.RowRepeaterFilter} oFilter - The filter whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfFilter(oFilter: sap.ui.commons.RowRepeaterFilter): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getRows rows}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oRow - The row whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfRow(oRow: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.commons.RowRepeaterSorter
in the aggregation {@link #getSorters sorters}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.RowRepeaterSorter} oSorter - The sorter whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSorter(oSorter: sap.ui.commons.RowRepeaterSorter): number;
/**
* Inserts a filter into the aggregation {@link #getFilters filters}.
* @param {sap.ui.commons.RowRepeaterFilter} oFilter - the filter to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the filter should be inserted at; for a negative value of iIndex
, the filter is inserted at position 0; for a value greater than the current size of the aggregation, the filter is inserted at the last position
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public insertFilter(oFilter: sap.ui.commons.RowRepeaterFilter, iIndex: number): sap.ui.commons.RowRepeater;
/**
* Inserts a row into the aggregation {@link #getRows rows}.
* @param {sap.ui.core.Control} oRow - the row to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the row should be inserted at; for a negative value of iIndex
, the row is inserted at position 0; for a value greater than the current size of the aggregation, the row is inserted at the last position
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public insertRow(oRow: sap.ui.core.Control, iIndex: number): sap.ui.commons.RowRepeater;
/**
* Inserts a sorter into the aggregation {@link #getSorters sorters}.
* @param {sap.ui.commons.RowRepeaterSorter} oSorter - the sorter to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the sorter should be inserted at; for a negative value of iIndex
, the sorter is inserted at position 0; for a value greater than the current size of the aggregation, the sorter is inserted at the last position
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public insertSorter(oSorter: sap.ui.commons.RowRepeaterSorter, iIndex: number): sap.ui.commons.RowRepeater;
/**
* Switch to last page.
*/
public lastPage(): void;
/**
* Switch to next page.
*/
public nextPage(): void;
/**
* Switch to previous page.
*/
public previousPage(): void;
/**
* Removes all the controls from the aggregation {@link #getFilters filters}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.RowRepeaterFilter[]} An array of the removed elements (might be empty)
*/
public removeAllFilters(): sap.ui.commons.RowRepeaterFilter[];
/**
* Removes all the controls from the aggregation {@link #getRows rows}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllRows(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getSorters sorters}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.RowRepeaterSorter[]} An array of the removed elements (might be empty)
*/
public removeAllSorters(): sap.ui.commons.RowRepeaterSorter[];
/**
* Removes a filter from the aggregation {@link #getFilters filters}.
* @param {number|string|sap.ui.commons.RowRepeaterFilter} vFilter - The filter to remove or its index or id
* @returns {sap.ui.commons.RowRepeaterFilter} The removed filter or null
*/
public removeFilter(vFilter: number|string|sap.ui.commons.RowRepeaterFilter): sap.ui.commons.RowRepeaterFilter;
/**
* Removes a row from the aggregation {@link #getRows rows}.
* @param {number|string|sap.ui.core.Control} vRow - The row to remove or its index or id
* @returns {sap.ui.core.Control} The removed row or null
*/
public removeRow(vRow: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a sorter from the aggregation {@link #getSorters sorters}.
* @param {number|string|sap.ui.commons.RowRepeaterSorter} vSorter - The sorter to remove or its index or id
* @returns {sap.ui.commons.RowRepeaterSorter} The removed sorter or null
*/
public removeSorter(vSorter: number|string|sap.ui.commons.RowRepeaterSorter): sap.ui.commons.RowRepeaterSorter;
/**
* Resizes the row repeater by changing the number of displayed rows. This method will only resize the RowRepeater if the property showMoreSteps is set.
* @param {number} iNumberOfRows - The new value of number of rows displayed.
*/
public resize(iNumberOfRows: number): void;
/**
* Setter for property currentPage
.
* @param {number} iCurrentPage - new value for property currentPage
* @returns {sap.ui.commons.RowRepeater} this
to allow method chaining
*/
public setCurrentPage(iCurrentPage: number): sap.ui.commons.RowRepeater;
/**
* Sets a new value for property {@link #getDesign design}.
*
* The visual design of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.ui.commons.RowRepeaterDesign} sDesign - New value for property design
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public setDesign(sDesign: sap.ui.commons.RowRepeaterDesign): sap.ui.commons.RowRepeater;
/**
* Sets a new value for property {@link #getFixedRowHeight fixedRowHeight}.
*
* Row height adapts to rendered content. If a fixed height is specified the cells have a maximum height and the overflow will be hidden.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.CSSSize} sFixedRowHeight - New value for property fixedRowHeight
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public setFixedRowHeight(sFixedRowHeight: sap.ui.core.CSSSize): sap.ui.commons.RowRepeater;
/**
* Sets the aggregated {@link #getNoData noData}.
* @param {sap.ui.core.Control} oNoData - The noData to set
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public setNoData(oNoData: sap.ui.core.Control): sap.ui.commons.RowRepeater;
/**
* Setter for property numberOfRows
.
*
* Default value is 5
* @param {number} iNumberOfRows - new value for property numberOfRows
* @returns {sap.ui.commons.RowRepeater} this
to allow method chaining
*/
public setNumberOfRows(iNumberOfRows: number): sap.ui.commons.RowRepeater;
/**
* Override the default behavior of setShowMoreSteps
to update the
* paging mode flag. Any change to the paging mode flag will result in the current
* page being set to the first page.
* @param {number} iShowMoreSteps - new value for property showMoreSteps
* @returns {sap.ui.commons.RowRepeater} this
to allow method chaining
*/
public setShowMoreSteps(iShowMoreSteps: number): sap.ui.commons.RowRepeater;
/**
* Sets a new value for property {@link #getThreshold threshold}.
*
* Threshold to fetch the next chunk of data. The minimal threshold can be the numberOfRows of the RR.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iThreshold - New value for property threshold
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public setThreshold(iThreshold: number): sap.ui.commons.RowRepeater;
/**
* Sets the aggregated {@link #getTitle title}.
* @param {sap.ui.core.Title} oTitle - The title to set
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public setTitle(oTitle: sap.ui.core.Title): sap.ui.commons.RowRepeater;
/**
* The triggerShowMore
function increments the number of rows by the
* value of showMoreSteps
.
*
* This method will only trigger a showMore if the property showMoreSteps is set.
* @returns {sap.ui.commons.RowRepeater} this
to allow method chaining
*/
public triggerShowMore(): sap.ui.commons.RowRepeater;
/**
* Sort the data.
* @param {string} sId - The ID of the sorter.
*/
public triggerSort(sId: string): void;
/**
* Unbinds aggregation {@link #getRows rows} from model data.
* @returns {sap.ui.commons.RowRepeater} Reference to this
in order to allow method chaining
*/
public unbindRows(): sap.ui.commons.RowRepeater;
}
/**
* Determines the visual design of a RowRepeater.
*/
export enum RowRepeaterDesign {
/**
* The RowRepeater will be displayed without header, toolbar or footer. Background will be transparent.
*/
BareShell = "BareShell",
/**
* The RowRepeater header and footer elements, as well as the row container background, appear solid.
*/
Standard = "Standard",
/**
* The RowRepeater header and footer elements, as well as the row container background, appear transparent.
*/
Transparent = "Transparent",
}
/**
* This element is used by the RowRepeater and allows to define a filter in this context along with the related data such as a text and an icon.
*/
export class RowRepeaterFilter extends sap.ui.core.Element {
/**
* Constructor for a new RowRepeaterFilter.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.RowRepeaterFilter with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getFilters filters}.
*
* The set of filter objects.
* @returns {any} Value of property filters
*/
public getFilters(): any;
/**
* Gets current value of property {@link #getIcon icon}.
*
* The filter icon if needed for display.
* @returns {string} Value of property icon
*/
public getIcon(): string;
/**
* Returns a metadata object for class sap.ui.commons.RowRepeaterFilter.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* The filter title if needed for display.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Sets a new value for property {@link #getFilters filters}.
*
* The set of filter objects.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oFilters - New value for property filters
* @returns {sap.ui.commons.RowRepeaterFilter} Reference to this
in order to allow method chaining
*/
public setFilters(oFilters: any): sap.ui.commons.RowRepeaterFilter;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* The filter icon if needed for display.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sIcon - New value for property icon
* @returns {sap.ui.commons.RowRepeaterFilter} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: string): sap.ui.commons.RowRepeaterFilter;
/**
* Sets a new value for property {@link #getText text}.
*
* The filter title if needed for display.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.commons.RowRepeaterFilter} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.commons.RowRepeaterFilter;
}
/**
* This element is used by the RowRepeater and allows to define a sorter in this context along with the related data such as a text and an icon.
*/
export class RowRepeaterSorter extends sap.ui.core.Element {
/**
* Constructor for a new RowRepeaterSorter.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.RowRepeaterSorter with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getIcon icon}.
*
* The sorter icon if needed for display.
* @returns {string} Value of property icon
*/
public getIcon(): string;
/**
* Returns a metadata object for class sap.ui.commons.RowRepeaterSorter.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSorter sorter}.
*
* The sorter object.
* @returns {any} Value of property sorter
*/
public getSorter(): any;
/**
* Gets current value of property {@link #getText text}.
*
* The sorter title if needed for display.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* The sorter icon if needed for display.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sIcon - New value for property icon
* @returns {sap.ui.commons.RowRepeaterSorter} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: string): sap.ui.commons.RowRepeaterSorter;
/**
* Sets a new value for property {@link #getSorter sorter}.
*
* The sorter object.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oSorter - New value for property sorter
* @returns {sap.ui.commons.RowRepeaterSorter} Reference to this
in order to allow method chaining
*/
public setSorter(oSorter: any): sap.ui.commons.RowRepeaterSorter;
/**
* Sets a new value for property {@link #getText text}.
*
* The sorter title if needed for display.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.commons.RowRepeaterSorter} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.commons.RowRepeaterSorter;
}
/**
* Allows the user to type search queries and to trigger the search. Optionally, suggestions can be added.
*/
export class SearchField extends sap.ui.core.Control {
/**
* Constructor for a new SearchField.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.SearchField;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.SearchField;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.ui.commons.SearchField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.SearchField
itself.
*
* Event which is fired when the user triggers a search
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.SearchField
itself
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public attachSearch(fnFunction: Function, oListener?: any): sap.ui.commons.SearchField;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.ui.commons.SearchField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.SearchField
itself.
*
* Event which is fired when the user triggers a search
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.SearchField
itself
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public attachSearch(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.SearchField;
/**
* Attaches event handler fnFunction
to the {@link #event:suggest suggest} event of this sap.ui.commons.SearchField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.SearchField
itself.
*
* Event which is fired when new suggest values are required.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.SearchField
itself
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public attachSuggest(fnFunction: Function, oListener?: any): sap.ui.commons.SearchField;
/**
* Attaches event handler fnFunction
to the {@link #event:suggest suggest} event of this sap.ui.commons.SearchField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.SearchField
itself.
*
* Event which is fired when new suggest values are required.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.SearchField
itself
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public attachSuggest(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.SearchField;
/**
* Clears the history of the control
*/
public clearHistory(): void;
/**
* Destroys the searchProvider in the aggregation {@link #getSearchProvider searchProvider}.
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public destroySearchProvider(): sap.ui.commons.SearchField;
/**
* Detaches event handler fnFunction
from the {@link #event:search search} event of this sap.ui.commons.SearchField
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public detachSearch(fnFunction: Function, oListener: any): sap.ui.commons.SearchField;
/**
* Detaches event handler fnFunction
from the {@link #event:suggest suggest} event of this sap.ui.commons.SearchField
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public detachSuggest(fnFunction: Function, oListener: any): sap.ui.commons.SearchField;
/**
* Creates a new subclass of class sap.ui.commons.SearchField with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:search search} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
protected fireSearch(mParameters?: any): sap.ui.commons.SearchField;
/**
* Fires event {@link #event:suggest suggest} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
protected fireSuggest(mParameters?: any): sap.ui.commons.SearchField;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEditable editable}.
*
* Non-editable controls have different colors, depending on custom settings
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEnableCache enableCache}.
*
* When list suggestion is enabled all suggestions are cached and no suggest event is fired.
*
* Default value is true
.
* @returns {boolean} Value of property enableCache
*/
public getEnableCache(): boolean;
/**
* Gets current value of property {@link #getEnableClear enableClear}.
*
* Defines whether the clear functionality shall be active
*
* Default value is false
.
* @returns {boolean} Value of property enableClear
*/
public getEnableClear(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Disabled fields have different colors, and they can not be focused.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getEnableFilterMode enableFilterMode}.
*
* Defines whether the search event should also be fired when the SearchField is empty (like a Filter field) and when the clear button (if activated) is pressed.
*
* Default value is false
.
* @returns {boolean} Value of property enableFilterMode
*/
public getEnableFilterMode(): boolean;
/**
* Gets current value of property {@link #getEnableListSuggest enableListSuggest}.
*
* Defines whether a pop up list shall be provided for suggestions
*
* Default value is true
.
* @returns {boolean} Value of property enableListSuggest
*/
public getEnableListSuggest(): boolean;
/**
* Gets current value of property {@link #getMaxHistoryItems maxHistoryItems}.
*
* Maximum number of history items in the suggestion list.
* 0 displays and stores no history. The history is locally stored on the client. Therefore do not activate this feature when this control handles confidential data.
*
* Default value is 0
.
* @returns {number} Value of property maxHistoryItems
*/
public getMaxHistoryItems(): number;
/**
* Gets current value of property {@link #getMaxLength maxLength}.
*
* Maximum number of characters. Value '0' means the feature is switched off.
*
* Default value is 0
.
* @returns {number} Value of property maxLength
*/
public getMaxLength(): number;
/**
* Gets current value of property {@link #getMaxSuggestionItems maxSuggestionItems}.
*
* Maximum number of suggestion items in the suggestion list.
*
* Default value is 10
.
* @returns {number} Value of property maxSuggestionItems
*/
public getMaxSuggestionItems(): number;
/**
* Returns a metadata object for class sap.ui.commons.SearchField.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPlaceholder placeholder}.
*
* Placeholder for the input field.
*
* Default value is
.
* @returns {string} Value of property placeholder
*/
public getPlaceholder(): string;
/**
* Gets content of aggregation {@link #getSearchProvider searchProvider}.
*
* Search provider instance which handles the suggestions for this SearchField (e.g. Open Search Protocol).
* @returns {sap.ui.core.search.SearchProvider}
*/
public getSearchProvider(): sap.ui.core.search.SearchProvider;
/**
* Gets current value of property {@link #getShowExternalButton showExternalButton}.
*
* Defines whether an additional search button shall be displayed
*
* Default value is false
.
* @returns {boolean} Value of property showExternalButton
*/
public getShowExternalButton(): boolean;
/**
* Gets current value of property {@link #getShowListExpander showListExpander}.
*
* Defines whether the list expander shall be displayed in the case of an enabled list for suggestions. This feature is deactivated on mobile devices.
*
* Default value is true
.
* @returns {boolean} Value of property showListExpander
*/
public getShowListExpander(): boolean;
/**
* Gets current value of property {@link #getStartSuggestion startSuggestion}.
*
* Minimum length of the entered string triggering the suggestion list.
*
* Default value is 3
.
* @returns {number} Value of property startSuggestion
*/
public getStartSuggestion(): number;
/**
* Gets current value of property {@link #getTextAlign textAlign}.
*
* Sets the horizontal alignment of the text
*
* Default value is Begin
.
* @returns {sap.ui.core.TextAlign} Value of property textAlign
*/
public getTextAlign(): sap.ui.core.TextAlign;
/**
* Gets current value of property {@link #getValue value}.
*
* Text that shall be displayed within the search field
*
* Default value is
.
* @returns {string} Value of property value
*/
public getValue(): string;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Visualizes warnings or errors related to the input field. Possible values: Warning, Error, Success, None.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getVisibleItemCount visibleItemCount}.
*
* Defines the number of items in the suggestion list that shall be displayed at once. If the overall number of list items is higher than the setting,
* a scroll bar is provided.
*
* Default value is 20
.
* @returns {number} Value of property visibleItemCount
*/
public getVisibleItemCount(): number;
/**
* Gets current value of property {@link #getWidth width}.
*
* Control width in CSS-size
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Non-editable controls have different colors, depending on custom settings
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getEnableCache enableCache}.
*
* When list suggestion is enabled all suggestions are cached and no suggest event is fired.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableCache - New value for property enableCache
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setEnableCache(bEnableCache: boolean): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getEnableClear enableClear}.
*
* Defines whether the clear functionality shall be active
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableClear - New value for property enableClear
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setEnableClear(bEnableClear: boolean): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Disabled fields have different colors, and they can not be focused.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getEnableFilterMode enableFilterMode}.
*
* Defines whether the search event should also be fired when the SearchField is empty (like a Filter field) and when the clear button (if activated) is pressed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableFilterMode - New value for property enableFilterMode
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setEnableFilterMode(bEnableFilterMode: boolean): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getEnableListSuggest enableListSuggest}.
*
* Defines whether a pop up list shall be provided for suggestions
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableListSuggest - New value for property enableListSuggest
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setEnableListSuggest(bEnableListSuggest: boolean): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getMaxHistoryItems maxHistoryItems}.
*
* Maximum number of history items in the suggestion list.
* 0 displays and stores no history. The history is locally stored on the client. Therefore do not activate this feature when this control handles confidential data.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iMaxHistoryItems - New value for property maxHistoryItems
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setMaxHistoryItems(iMaxHistoryItems: number): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getMaxLength maxLength}.
*
* Maximum number of characters. Value '0' means the feature is switched off.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iMaxLength - New value for property maxLength
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setMaxLength(iMaxLength: number): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getMaxSuggestionItems maxSuggestionItems}.
*
* Maximum number of suggestion items in the suggestion list.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 10
.
* @param {number} iMaxSuggestionItems - New value for property maxSuggestionItems
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setMaxSuggestionItems(iMaxSuggestionItems: number): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getPlaceholder placeholder}.
*
* Placeholder for the input field.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sPlaceholder - New value for property placeholder
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setPlaceholder(sPlaceholder: string): sap.ui.commons.SearchField;
/**
* Sets the aggregated {@link #getSearchProvider searchProvider}.
* @param {sap.ui.core.search.SearchProvider} oSearchProvider - The searchProvider to set
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setSearchProvider(oSearchProvider: sap.ui.core.search.SearchProvider): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getShowExternalButton showExternalButton}.
*
* Defines whether an additional search button shall be displayed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowExternalButton - New value for property showExternalButton
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setShowExternalButton(bShowExternalButton: boolean): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getShowListExpander showListExpander}.
*
* Defines whether the list expander shall be displayed in the case of an enabled list for suggestions. This feature is deactivated on mobile devices.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowListExpander - New value for property showListExpander
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setShowListExpander(bShowListExpander: boolean): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getStartSuggestion startSuggestion}.
*
* Minimum length of the entered string triggering the suggestion list.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 3
.
* @param {number} iStartSuggestion - New value for property startSuggestion
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setStartSuggestion(iStartSuggestion: number): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getTextAlign textAlign}.
*
* Sets the horizontal alignment of the text
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Begin
.
* @param {sap.ui.core.TextAlign} sTextAlign - New value for property textAlign
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setTextAlign(sTextAlign: sap.ui.core.TextAlign): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getValue value}.
*
* Text that shall be displayed within the search field
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sValue - New value for property value
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setValue(sValue: string): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getValueState valueState}.
*
* Visualizes warnings or errors related to the input field. Possible values: Warning, Error, Success, None.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sValueState - New value for property valueState
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setValueState(sValueState: sap.ui.core.ValueState): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getVisibleItemCount visibleItemCount}.
*
* Defines the number of items in the suggestion list that shall be displayed at once. If the overall number of list items is higher than the setting,
* a scroll bar is provided.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 20
.
* @param {number} iVisibleItemCount - New value for property visibleItemCount
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setVisibleItemCount(iVisibleItemCount: number): sap.ui.commons.SearchField;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Control width in CSS-size
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.SearchField} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.SearchField;
/**
* Callback function used to provide the suggest values in the handler of the suggest event (only in list suggestion mode)
* @param {string} sSSuggestValue - The value which was provided in the corresponding suggest event (parameter 'value')
* @param {string[]} aASuggestions - The list of suggestions belonging to the suggest value
*/
public suggest(sSSuggestValue: string, aASuggestions: string[]): void;
}
/**
* A SearchProvider which can be attached to a Search Field.
*/
export class SearchProvider extends sap.ui.core.search.OpenSearchProvider {
/**
* Constructor for a new SearchProvider.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.SearchProvider with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.search.OpenSearchProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.commons.SearchProvider.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* The SegmentedButton provides a group of multiple buttons. Only one button can be active. The behaviour is more ore less like a radio button group.
*/
export class SegmentedButton extends sap.ui.core.Control {
/**
* Constructor for a new SegmentedButton.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Rerendering of the Buttons
*/
protected _rerenderButtons(): void;
/**
* Adds some button to the aggregation {@link #getButtons buttons}.
* @param {sap.ui.commons.Button} oButton - the button to add; if empty, nothing is inserted
* @returns {sap.ui.commons.SegmentedButton} Reference to this
in order to allow method chaining
*/
public addButton(oButton: sap.ui.commons.Button): sap.ui.commons.SegmentedButton;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.commons.SegmentedButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.SegmentedButton
itself.
*
* Event fired when button selected
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.SegmentedButton
itself
* @returns {sap.ui.commons.SegmentedButton} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.commons.SegmentedButton;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.commons.SegmentedButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.SegmentedButton
itself.
*
* Event fired when button selected
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.SegmentedButton
itself
* @returns {sap.ui.commons.SegmentedButton} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.SegmentedButton;
/**
* Destroys all the buttons in the aggregation {@link #getButtons buttons}.
* @returns {sap.ui.commons.SegmentedButton} Reference to this
in order to allow method chaining
*/
public destroyButtons(): sap.ui.commons.SegmentedButton;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.commons.SegmentedButton
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.SegmentedButton} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.commons.SegmentedButton;
/**
* Creates a new subclass of class sap.ui.commons.SegmentedButton with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.SegmentedButton} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.commons.SegmentedButton;
/**
* Gets content of aggregation {@link #getButtons buttons}.
*
* Buttons
* @returns {sap.ui.commons.Button[]}
*/
public getButtons(): sap.ui.commons.Button[];
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* enabled
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Returns a metadata object for class sap.ui.commons.SegmentedButton.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* ID of the element which is the current target of the association {@link #getSelectedButton selectedButton}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedButton(): sap.ui.core.ID;
/**
* Checks for the provided sap.ui.commons.Button
in the aggregation {@link #getButtons buttons}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.Button} oButton - The button whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfButton(oButton: sap.ui.commons.Button): number;
/**
* Inserts a button into the aggregation {@link #getButtons buttons}.
* @param {sap.ui.commons.Button} oButton - the button to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the button should be inserted at; for a negative value of iIndex
, the button is inserted at position 0; for a value greater than the current size of the aggregation, the button is inserted at the last position
* @returns {sap.ui.commons.SegmentedButton} Reference to this
in order to allow method chaining
*/
public insertButton(oButton: sap.ui.commons.Button, iIndex: number): sap.ui.commons.SegmentedButton;
/**
* Removes all the controls from the aggregation {@link #getButtons buttons}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.Button[]} An array of the removed elements (might be empty)
*/
public removeAllButtons(): sap.ui.commons.Button[];
/**
* Removes a button from the aggregation {@link #getButtons buttons}.
* @param {number|string|sap.ui.commons.Button} vButton - The button to remove or its index or id
* @returns {sap.ui.commons.Button} The removed button or null
*/
public removeButton(vButton: number|string|sap.ui.commons.Button): sap.ui.commons.Button;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* enabled
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.commons.SegmentedButton} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.SegmentedButton;
/**
* Sets the associated {@link #getSelectedButton selectedButton}.
* @param {sap.ui.core.ID|sap.ui.commons.Button} oSelectedButton - ID of an element which becomes the new target of this selectedButton association; alternatively, an element instance may be given
* @returns {sap.ui.commons.SegmentedButton} Reference to this
in order to allow method chaining
*/
public setSelectedButton(oSelectedButton: sap.ui.core.ID|sap.ui.commons.Button): sap.ui.commons.SegmentedButton;
}
/**
* The interactive control is displayed either as a horizontal or a vertical line with a pointer and units of measurement.
* Users can move the pointer along the line to change values with graphical support.
*/
export class Slider extends sap.ui.core.Control {
/**
* Constructor for a new Slider
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.Slider;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.Slider;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.commons.Slider
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Slider
itself.
*
* Value was changed. This event is fired if the value has changed by a user action.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Slider
itself
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.ui.commons.Slider;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.commons.Slider
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Slider
itself.
*
* Value was changed. This event is fired if the value has changed by a user action.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Slider
itself
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.Slider;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.ui.commons.Slider
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Slider
itself.
*
* Value was changed. This event is fired during the mouse move. The normal change event is only fired by mouseup.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Slider
itself
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public attachLiveChange(fnFunction: Function, oListener?: any): sap.ui.commons.Slider;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.ui.commons.Slider
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Slider
itself.
*
* Value was changed. This event is fired during the mouse move. The normal change event is only fired by mouseup.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Slider
itself
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public attachLiveChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.Slider;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.ui.commons.Slider
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.ui.commons.Slider;
/**
* Detaches event handler fnFunction
from the {@link #event:liveChange liveChange} event of this sap.ui.commons.Slider
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public detachLiveChange(fnFunction: Function, oListener: any): sap.ui.commons.Slider;
/**
* Creates a new subclass of class sap.ui.commons.Slider with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.ui.commons.Slider;
/**
* Fires event {@link #event:liveChange liveChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
protected fireLiveChange(mParameters?: any): sap.ui.commons.Slider;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEditable editable}.
*
* Using the slider interactively requires value "true".
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Switches enabled state of the control. Disabled fields have different colors, and can not be focused.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* Height of the vertical slider.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getLabels labels}.
*
* Labels to be displayed instead of numbers. Attribute totalUnits and label count should be the same
*
* Note: To show the labels stepLabels
must be activated.
* @returns {string[]} Value of property labels
*/
public getLabels(): string[];
/**
* Gets current value of property {@link #getMax max}.
*
* Maximal value of the slider
*
* Note: If min
is larger than max
both values will be switched
*
* Default value is 100
.
* @returns {number} Value of property max
*/
public getMax(): number;
/**
* Returns a metadata object for class sap.ui.commons.Slider.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMin min}.
*
* Minimal value of the slider.
*
* Note: If min
is larger than max
both values will be switched
*
* Default value is 0
.
* @returns {number} Value of property min
*/
public getMin(): number;
/**
* Gets current value of property {@link #getSmallStepWidth smallStepWidth}.
*
* The grip can only be moved in steps of this width.
* @returns {number} Value of property smallStepWidth
*/
public getSmallStepWidth(): number;
/**
* Gets current value of property {@link #getStepLabels stepLabels}.
*
* Display step numbers for the ticks on the slider.
*
* Default value is false
.
* @returns {boolean} Value of property stepLabels
*/
public getStepLabels(): boolean;
/**
* Gets current value of property {@link #getTotalUnits totalUnits}.
*
* Number of units that are displayed by ticks. The PageUp and PageDown keys navigate according to these units.
* @returns {number} Value of property totalUnits
*/
public getTotalUnits(): number;
/**
* Gets current value of property {@link #getValue value}.
*
* Current value of the slider. (Position of the grip.)
*
* Note: If the value is not in the valid range (between min
and max
) it will be changed to be in the valid range.
*
* Default value is 50
.
* @returns {number} Value of property value
*/
public getValue(): number;
/**
* Gets current value of property {@link #getVertical vertical}.
*
* Orientation of slider
*
* Default value is false
.
* @returns {boolean} Value of property vertical
*/
public getVertical(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the horizontal slider.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Using the slider interactively requires value "true".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.ui.commons.Slider;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Switches enabled state of the control. Disabled fields have different colors, and can not be focused.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.Slider;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Height of the vertical slider.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.Slider;
/**
* Sets a new value for property {@link #getLabels labels}.
*
* Labels to be displayed instead of numbers. Attribute totalUnits and label count should be the same
*
* Note: To show the labels stepLabels
must be activated.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string[]} sLabels - New value for property labels
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public setLabels(sLabels: string[]): sap.ui.commons.Slider;
/**
* Sets a new value for property {@link #getMax max}.
*
* Maximal value of the slider
*
* Note: If min
is larger than max
both values will be switched
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100
.
* @param {number} fMax - New value for property max
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public setMax(fMax: number): sap.ui.commons.Slider;
/**
* Sets a new value for property {@link #getMin min}.
*
* Minimal value of the slider.
*
* Note: If min
is larger than max
both values will be switched
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} fMin - New value for property min
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public setMin(fMin: number): sap.ui.commons.Slider;
/**
* Sets a new value for property {@link #getSmallStepWidth smallStepWidth}.
*
* The grip can only be moved in steps of this width.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} fSmallStepWidth - New value for property smallStepWidth
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public setSmallStepWidth(fSmallStepWidth: number): sap.ui.commons.Slider;
/**
* Sets a new value for property {@link #getStepLabels stepLabels}.
*
* Display step numbers for the ticks on the slider.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bStepLabels - New value for property stepLabels
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public setStepLabels(bStepLabels: boolean): sap.ui.commons.Slider;
/**
* Sets a new value for property {@link #getTotalUnits totalUnits}.
*
* Number of units that are displayed by ticks. The PageUp and PageDown keys navigate according to these units.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iTotalUnits - New value for property totalUnits
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public setTotalUnits(iTotalUnits: number): sap.ui.commons.Slider;
/**
* Sets a new value for property {@link #getValue value}.
*
* Current value of the slider. (Position of the grip.)
*
* Note: If the value is not in the valid range (between min
and max
) it will be changed to be in the valid range.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 50
.
* @param {number} fValue - New value for property value
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public setValue(fValue: number): sap.ui.commons.Slider;
/**
* Sets a new value for property {@link #getVertical vertical}.
*
* Orientation of slider
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bVertical - New value for property vertical
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public setVertical(bVertical: boolean): sap.ui.commons.Slider;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of the horizontal slider.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.Slider} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.Slider;
}
/**
* Allows to split the screen into two areas. Make sure that the container for the splitter has an absolute height or set an absolute height for the splitter using the height property. Otherwise the height of the splitter is calculated by the height of its contents.
*/
export class Splitter extends sap.ui.core.Control {
/**
* Constructor for a new Splitter.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some firstPaneContent to the aggregation {@link #getFirstPaneContent firstPaneContent}.
* @param {sap.ui.core.Control} oFirstPaneContent - the firstPaneContent to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Splitter} Reference to this
in order to allow method chaining
*/
public addFirstPaneContent(oFirstPaneContent: sap.ui.core.Control): sap.ui.commons.Splitter;
/**
* Adds some secondPaneContent to the aggregation {@link #getSecondPaneContent secondPaneContent}.
* @param {sap.ui.core.Control} oSecondPaneContent - the secondPaneContent to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Splitter} Reference to this
in order to allow method chaining
*/
public addSecondPaneContent(oSecondPaneContent: sap.ui.core.Control): sap.ui.commons.Splitter;
/**
* Destroys all the firstPaneContent in the aggregation {@link #getFirstPaneContent firstPaneContent}.
* @returns {sap.ui.commons.Splitter} Reference to this
in order to allow method chaining
*/
public destroyFirstPaneContent(): sap.ui.commons.Splitter;
/**
* Destroys all the secondPaneContent in the aggregation {@link #getSecondPaneContent secondPaneContent}.
* @returns {sap.ui.commons.Splitter} Reference to this
in order to allow method chaining
*/
public destroySecondPaneContent(): sap.ui.commons.Splitter;
/**
* Creates a new subclass of class sap.ui.commons.Splitter with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getFirstPaneContent firstPaneContent}.
*
* Controls inside the first pane. These are the left ones in case of defining a vertical splitter, and the top ones in case of using the horizontal splitter.
* @returns {sap.ui.core.Control[]}
*/
public getFirstPaneContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getHeight height}.
*
* The height of the split area in px or in %
*
* Default value is 100%
.
* @returns {sap.ui.commons.SplitterSize} Value of property height
*/
public getHeight(): sap.ui.commons.SplitterSize;
/**
* Returns a metadata object for class sap.ui.commons.Splitter.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinSizeFirstPane minSizeFirstPane}.
*
* The minimum size (width for vertical splitter or height for horizontal splitter) of the first Pane
*
* Default value is 0%
.
* @returns {sap.ui.core.Percentage} Value of property minSizeFirstPane
*/
public getMinSizeFirstPane(): sap.ui.core.Percentage;
/**
* Gets current value of property {@link #getMinSizeSecondPane minSizeSecondPane}.
*
* The minimum size (width for vertical splitter or height for horizontal splitter) of the second Pane
*
* Default value is 0%
.
* @returns {sap.ui.core.Percentage} Value of property minSizeSecondPane
*/
public getMinSizeSecondPane(): sap.ui.core.Percentage;
/**
* Gets content of aggregation {@link #getSecondPaneContent secondPaneContent}.
*
* Controls inside the second pane. These are the right ones in case of defining a vertical splitter, and the bottom ones in case of using the horizontal splitter.
* @returns {sap.ui.core.Control[]}
*/
public getSecondPaneContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getShowScrollBars showScrollBars}.
*
* Specifies if the browser should display scroll bars or simply cut the content of a splitter pane when the content does not fit into its pane.
*
* Default value is true
.
* @returns {boolean} Value of property showScrollBars
*/
public getShowScrollBars(): boolean;
/**
* Gets current value of property {@link #getSplitterBarVisible splitterBarVisible}.
*
* set the splitter bar to be visible or not.
*
* Default value is true
.
* @returns {boolean} Value of property splitterBarVisible
*/
public getSplitterBarVisible(): boolean;
/**
* Gets current value of property {@link #getSplitterOrientation splitterOrientation}.
*
* The splitter can have horizontal or vertical orientation.
*
* Default value is Vertical
.
* @returns {sap.ui.core.Orientation} Value of property splitterOrientation
*/
public getSplitterOrientation(): sap.ui.core.Orientation;
/**
* Gets current value of property {@link #getSplitterPosition splitterPosition}.
*
* Position of splitter bar in percentage.
* The default value means that the splitter is positioned in the middle of the area that is available for the splitter.
*
* Default value is 50%
.
* @returns {sap.ui.core.Percentage} Value of property splitterPosition
*/
public getSplitterPosition(): sap.ui.core.Percentage;
/**
* Gets current value of property {@link #getWidth width}.
*
* The width of the split area in px or in %
*
* Default value is 100%
.
* @returns {sap.ui.commons.SplitterSize} Value of property width
*/
public getWidth(): sap.ui.commons.SplitterSize;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getFirstPaneContent firstPaneContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oFirstPaneContent - The firstPaneContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfFirstPaneContent(oFirstPaneContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getSecondPaneContent secondPaneContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oSecondPaneContent - The secondPaneContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSecondPaneContent(oSecondPaneContent: sap.ui.core.Control): number;
/**
* Inserts a firstPaneContent into the aggregation {@link #getFirstPaneContent firstPaneContent}.
* @param {sap.ui.core.Control} oFirstPaneContent - the firstPaneContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the firstPaneContent should be inserted at; for a negative value of iIndex
, the firstPaneContent is inserted at position 0; for a value greater than the current size of the aggregation, the firstPaneContent is inserted at the last position
* @returns {sap.ui.commons.Splitter} Reference to this
in order to allow method chaining
*/
public insertFirstPaneContent(oFirstPaneContent: sap.ui.core.Control, iIndex: number): sap.ui.commons.Splitter;
/**
* Inserts a secondPaneContent into the aggregation {@link #getSecondPaneContent secondPaneContent}.
* @param {sap.ui.core.Control} oSecondPaneContent - the secondPaneContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the secondPaneContent should be inserted at; for a negative value of iIndex
, the secondPaneContent is inserted at position 0; for a value greater than the current size of the aggregation, the secondPaneContent is inserted at the last position
* @returns {sap.ui.commons.Splitter} Reference to this
in order to allow method chaining
*/
public insertSecondPaneContent(oSecondPaneContent: sap.ui.core.Control, iIndex: number): sap.ui.commons.Splitter;
/**
* Removes all the controls from the aggregation {@link #getFirstPaneContent firstPaneContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllFirstPaneContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getSecondPaneContent secondPaneContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllSecondPaneContent(): sap.ui.core.Control[];
/**
* Removes a firstPaneContent from the aggregation {@link #getFirstPaneContent firstPaneContent}.
* @param {number|string|sap.ui.core.Control} vFirstPaneContent - The firstPaneContent to remove or its index or id
* @returns {sap.ui.core.Control} The removed firstPaneContent or null
*/
public removeFirstPaneContent(vFirstPaneContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a secondPaneContent from the aggregation {@link #getSecondPaneContent secondPaneContent}.
* @param {number|string|sap.ui.core.Control} vSecondPaneContent - The secondPaneContent to remove or its index or id
* @returns {sap.ui.core.Control} The removed secondPaneContent or null
*/
public removeSecondPaneContent(vSecondPaneContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getHeight height}.
*
* The height of the split area in px or in %
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.commons.SplitterSize} sHeight - New value for property height
* @returns {sap.ui.commons.Splitter} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.commons.SplitterSize): sap.ui.commons.Splitter;
/**
* Sets a new value for property {@link #getMinSizeFirstPane minSizeFirstPane}.
*
* The minimum size (width for vertical splitter or height for horizontal splitter) of the first Pane
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0%
.
* @param {sap.ui.core.Percentage} sMinSizeFirstPane - New value for property minSizeFirstPane
* @returns {sap.ui.commons.Splitter} Reference to this
in order to allow method chaining
*/
public setMinSizeFirstPane(sMinSizeFirstPane: sap.ui.core.Percentage): sap.ui.commons.Splitter;
/**
* Sets a new value for property {@link #getMinSizeSecondPane minSizeSecondPane}.
*
* The minimum size (width for vertical splitter or height for horizontal splitter) of the second Pane
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0%
.
* @param {sap.ui.core.Percentage} sMinSizeSecondPane - New value for property minSizeSecondPane
* @returns {sap.ui.commons.Splitter} Reference to this
in order to allow method chaining
*/
public setMinSizeSecondPane(sMinSizeSecondPane: sap.ui.core.Percentage): sap.ui.commons.Splitter;
/**
* Sets a new value for property {@link #getShowScrollBars showScrollBars}.
*
* Specifies if the browser should display scroll bars or simply cut the content of a splitter pane when the content does not fit into its pane.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowScrollBars - New value for property showScrollBars
* @returns {sap.ui.commons.Splitter} Reference to this
in order to allow method chaining
*/
public setShowScrollBars(bShowScrollBars: boolean): sap.ui.commons.Splitter;
/**
* Sets a new value for property {@link #getSplitterBarVisible splitterBarVisible}.
*
* set the splitter bar to be visible or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bSplitterBarVisible - New value for property splitterBarVisible
* @returns {sap.ui.commons.Splitter} Reference to this
in order to allow method chaining
*/
public setSplitterBarVisible(bSplitterBarVisible: boolean): sap.ui.commons.Splitter;
/**
* Sets a new value for property {@link #getSplitterOrientation splitterOrientation}.
*
* The splitter can have horizontal or vertical orientation.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Vertical
.
* @param {sap.ui.core.Orientation} sSplitterOrientation - New value for property splitterOrientation
* @returns {sap.ui.commons.Splitter} Reference to this
in order to allow method chaining
*/
public setSplitterOrientation(sSplitterOrientation: sap.ui.core.Orientation): sap.ui.commons.Splitter;
/**
* Sets a new value for property {@link #getSplitterPosition splitterPosition}.
*
* Position of splitter bar in percentage.
* The default value means that the splitter is positioned in the middle of the area that is available for the splitter.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 50%
.
* @param {sap.ui.core.Percentage} sSplitterPosition - New value for property splitterPosition
* @returns {sap.ui.commons.Splitter} Reference to this
in order to allow method chaining
*/
public setSplitterPosition(sSplitterPosition: sap.ui.core.Percentage): sap.ui.commons.Splitter;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The width of the split area in px or in %
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.commons.SplitterSize} sWidth - New value for property width
* @returns {sap.ui.commons.Splitter} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.commons.SplitterSize): sap.ui.commons.Splitter;
}
/**
* A string type that represents subset of CSS size values. For the Splitter only px and % are allowed.
*/
export type SplitterSize = string;
/**
* Represents a single tab in a TabStrip control.
*/
export class Tab extends sap.ui.commons.Panel {
/**
* Constructor for a new Tab.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.Tab with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.commons.Panel.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getClosable closable}.
*
* Specifies whether the tab contains a close button.
*
* Default value is false
.
* @returns {boolean} Value of property closable
*/
public getClosable(): boolean;
/**
* Gets current value of property {@link #getHorizontalScrolling horizontalScrolling}.
*
* Specifies the horizontal scrolling.
*
* Default value is None
.
* @returns {sap.ui.core.Scrolling} Value of property horizontalScrolling
*/
public getHorizontalScrolling(): sap.ui.core.Scrolling;
/**
* Returns a metadata object for class sap.ui.commons.Tab.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSelected selected}.
*
* Defines whether the tab is the active one.
*
* Default value is false
.
* @returns {boolean} Value of property selected
*/
public getSelected(): boolean;
/**
* Gets current value of property {@link #getVerticalScrolling verticalScrolling}.
*
* Specifies the vertical scrolling.
*
* Default value is None
.
* @returns {sap.ui.core.Scrolling} Value of property verticalScrolling
*/
public getVerticalScrolling(): sap.ui.core.Scrolling;
/**
* Sets a new value for property {@link #getClosable closable}.
*
* Specifies whether the tab contains a close button.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bClosable - New value for property closable
* @returns {sap.ui.commons.Tab} Reference to this
in order to allow method chaining
*/
public setClosable(bClosable: boolean): sap.ui.commons.Tab;
/**
* Sets a new value for property {@link #getHorizontalScrolling horizontalScrolling}.
*
* Specifies the horizontal scrolling.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.Scrolling} sHorizontalScrolling - New value for property horizontalScrolling
* @returns {sap.ui.commons.Tab} Reference to this
in order to allow method chaining
*/
public setHorizontalScrolling(sHorizontalScrolling: sap.ui.core.Scrolling): sap.ui.commons.Tab;
/**
* Sets a new value for property {@link #getSelected selected}.
*
* Defines whether the tab is the active one.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSelected - New value for property selected
* @returns {sap.ui.commons.Tab} Reference to this
in order to allow method chaining
*/
public setSelected(bSelected: boolean): sap.ui.commons.Tab;
/**
* Sets a new value for property {@link #getVerticalScrolling verticalScrolling}.
*
* Specifies the vertical scrolling.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.Scrolling} sVerticalScrolling - New value for property verticalScrolling
* @returns {sap.ui.commons.Tab} Reference to this
in order to allow method chaining
*/
public setVerticalScrolling(sVerticalScrolling: sap.ui.core.Scrolling): sap.ui.commons.Tab;
}
/**
* TabStrip represents a container for tab controls, which contain the content and generally other controls.
* The user switches between the tabs to display the content.
*/
export class TabStrip extends sap.ui.core.Control {
/**
* Constructor for a new TabStrip.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some tab to the aggregation {@link #getTabs tabs}.
* @param {sap.ui.commons.Tab} oTab - the tab to add; if empty, nothing is inserted
* @returns {sap.ui.commons.TabStrip} Reference to this
in order to allow method chaining
*/
public addTab(oTab: sap.ui.commons.Tab): sap.ui.commons.TabStrip;
/**
* Attaches event handler fnFunction
to the {@link #event:close close} event of this sap.ui.commons.TabStrip
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.TabStrip
itself.
*
* Fires when the user closes a tab.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.TabStrip
itself
* @returns {sap.ui.commons.TabStrip} Reference to this
in order to allow method chaining
*/
public attachClose(fnFunction: Function, oListener?: any): sap.ui.commons.TabStrip;
/**
* Attaches event handler fnFunction
to the {@link #event:close close} event of this sap.ui.commons.TabStrip
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.TabStrip
itself.
*
* Fires when the user closes a tab.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.TabStrip
itself
* @returns {sap.ui.commons.TabStrip} Reference to this
in order to allow method chaining
*/
public attachClose(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.TabStrip;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.commons.TabStrip
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.TabStrip
itself.
*
* Fires when the user selects a tab.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.TabStrip
itself
* @returns {sap.ui.commons.TabStrip} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.commons.TabStrip;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.commons.TabStrip
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.TabStrip
itself.
*
* Fires when the user selects a tab.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.TabStrip
itself
* @returns {sap.ui.commons.TabStrip} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.TabStrip;
/**
* Closes a tab (if the tab is selected, the next one will be selected;
* if it's the last tab, the previous one will be selected).
*
* This method should be called if the close event is fired.
* It can not be called automatically because the consumer might need to run some logic before the tab is closed.
* @param {number} iIndex - The index of the tab that should be closed
*/
public closeTab(iIndex: number): void;
/**
* Creates a Tab and adds it to the TabStrip.
* @param {string} sText - Defines the title text of the newly created tab
* @param {sap.ui.core.Control} oContent - Defines the root control of the content area
* @returns {sap.ui.commons.Tab} oTab The created tab control
*/
public createTab(sText: string, oContent: sap.ui.core.Control): sap.ui.commons.Tab;
/**
* Destroys all the tabs in the aggregation {@link #getTabs tabs}.
* @returns {sap.ui.commons.TabStrip} Reference to this
in order to allow method chaining
*/
public destroyTabs(): sap.ui.commons.TabStrip;
/**
* Detaches event handler fnFunction
from the {@link #event:close close} event of this sap.ui.commons.TabStrip
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.TabStrip} Reference to this
in order to allow method chaining
*/
public detachClose(fnFunction: Function, oListener: any): sap.ui.commons.TabStrip;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.commons.TabStrip
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.TabStrip} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.commons.TabStrip;
/**
* Creates a new subclass of class sap.ui.commons.TabStrip with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:close close} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.TabStrip} Reference to this
in order to allow method chaining
*/
protected fireClose(mParameters?: any): sap.ui.commons.TabStrip;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.TabStrip} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.commons.TabStrip;
/**
* Gets current value of property {@link #getEnableTabReordering enableTabReordering}.
*
* Specifies whether tab reordering is enabled.
*
* Default value is false
.
* @returns {boolean} Value of property enableTabReordering
*/
public getEnableTabReordering(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* Specifies the height of the tab bar and content area.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.commons.TabStrip.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSelectedIndex selectedIndex}.
*
* Specifies the index of the currently selected tab.
*
* Default value is 0
.
* @returns {number} Value of property selectedIndex
*/
public getSelectedIndex(): number;
/**
* Gets content of aggregation {@link #getTabs tabs}.
*
* The tabs contained in the TabStrip.
* @returns {sap.ui.commons.Tab[]}
*/
public getTabs(): sap.ui.commons.Tab[];
/**
* Gets current value of property {@link #getWidth width}.
*
* Specifies the width of the bar and content area.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.commons.Tab
in the aggregation {@link #getTabs tabs}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.Tab} oTab - The tab whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfTab(oTab: sap.ui.commons.Tab): number;
/**
* Inserts a tab into the aggregation {@link #getTabs tabs}.
* @param {sap.ui.commons.Tab} oTab - the tab to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the tab should be inserted at; for a negative value of iIndex
, the tab is inserted at position 0; for a value greater than the current size of the aggregation, the tab is inserted at the last position
* @returns {sap.ui.commons.TabStrip} Reference to this
in order to allow method chaining
*/
public insertTab(oTab: sap.ui.commons.Tab, iIndex: number): sap.ui.commons.TabStrip;
/**
* Called before the rendering of the control is started.
*/
public onBeforeRendering(): void;
/**
* Removes all the controls from the aggregation {@link #getTabs tabs}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.Tab[]} An array of the removed elements (might be empty)
*/
public removeAllTabs(): sap.ui.commons.Tab[];
/**
* Removes a tab from the aggregation {@link #getTabs tabs}.
* @param {number|string|sap.ui.commons.Tab} vTab - The tab to remove or its index or id
* @returns {sap.ui.commons.Tab} The removed tab or null
*/
public removeTab(vTab: number|string|sap.ui.commons.Tab): sap.ui.commons.Tab;
/**
* Sets whether tab reordering is enabled.
* @param {boolean} bValue - The value.
* @returns {sap.ui.commons.TabStrip} Pointer to the control instance for chaining.
*/
public setEnableTabReordering(bValue: boolean): sap.ui.commons.TabStrip;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Specifies the height of the tab bar and content area.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.commons.TabStrip} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.TabStrip;
/**
* Sets a new value for property {@link #getSelectedIndex selectedIndex}.
*
* Specifies the index of the currently selected tab.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iSelectedIndex - New value for property selectedIndex
* @returns {sap.ui.commons.TabStrip} Reference to this
in order to allow method chaining
*/
public setSelectedIndex(iSelectedIndex: number): sap.ui.commons.TabStrip;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Specifies the width of the bar and content area.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.TabStrip} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.TabStrip;
}
/**
* Control to enter or display multible row text.
*/
export class TextArea extends sap.ui.commons.TextField {
/**
* Constructor for a new TextArea.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.TextArea with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.commons.TextField.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getCols cols}.
*
* Number of Columns. Cols means number of characters per row. This proprty is only used if Width is not used.
* @returns {number} Value of property cols
*/
public getCols(): number;
/**
* Gets current value of property {@link #getCursorPos cursorPos}.
*
* Position of cursor, e.g., to let the user re-start typing at the same position as before the server roundtrip
* @returns {number} Value of property cursorPos
*/
public getCursorPos(): number;
/**
* Gets current value of property {@link #getExplanation explanation}.
*
* text which appears, in case quick-help is switched on
* @returns {string} Value of property explanation
*/
public getExplanation(): string;
/**
* Gets current value of property {@link #getHeight height}.
*
* Height of text field. When it is set (CSS-size such as % or px), this is the exact size.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getLabeledBy labeledBy}.
*
* ID of label control
* @returns {string} Value of property labeledBy
*/
public getLabeledBy(): string;
/**
* Returns a metadata object for class sap.ui.commons.TextArea.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRows rows}.
*
* Number of Rows. This proprty is only used if Height is not used.
* @returns {number} Value of property rows
*/
public getRows(): number;
/**
* Gets current value of property {@link #getWrapping wrapping}.
*
* Text wrapping. Possible values are: Soft, Hard, Off.
* @returns {sap.ui.core.Wrapping} Value of property wrapping
*/
public getWrapping(): sap.ui.core.Wrapping;
/**
* Sets a new value for property {@link #getCols cols}.
*
* Number of Columns. Cols means number of characters per row. This proprty is only used if Width is not used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iCols - New value for property cols
* @returns {sap.ui.commons.TextArea} Reference to this
in order to allow method chaining
*/
public setCols(iCols: number): sap.ui.commons.TextArea;
/**
* Property setter for the cursor position
* @param {number} iCursorPos - cursor position
* @returns {sap.ui.commons.TextArea} this
to allow method chaining
*/
public setCursorPos(iCursorPos: number): sap.ui.commons.TextArea;
/**
* Sets a new value for property {@link #getExplanation explanation}.
*
* text which appears, in case quick-help is switched on
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sExplanation - New value for property explanation
* @returns {sap.ui.commons.TextArea} Reference to this
in order to allow method chaining
*/
public setExplanation(sExplanation: string): sap.ui.commons.TextArea;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Height of text field. When it is set (CSS-size such as % or px), this is the exact size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.commons.TextArea} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.TextArea;
/**
* Sets a new value for property {@link #getLabeledBy labeledBy}.
*
* ID of label control
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sLabeledBy - New value for property labeledBy
* @returns {sap.ui.commons.TextArea} Reference to this
in order to allow method chaining
*/
public setLabeledBy(sLabeledBy: string): sap.ui.commons.TextArea;
/**
* Property setter for MaxLength
* @param {number} iMaxLength - maximal length of text
* @returns {sap.ui.commons.TextArea} this
to allow method chaining
*/
public setMaxLength(iMaxLength: number): sap.ui.commons.TextArea;
/**
* Sets a new value for property {@link #getRows rows}.
*
* Number of Rows. This proprty is only used if Height is not used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iRows - New value for property rows
* @returns {sap.ui.commons.TextArea} Reference to this
in order to allow method chaining
*/
public setRows(iRows: number): sap.ui.commons.TextArea;
/**
* Sets a new value for property {@link #getWrapping wrapping}.
*
* Text wrapping. Possible values are: Soft, Hard, Off.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.Wrapping} sWrapping - New value for property wrapping
* @returns {sap.ui.commons.TextArea} Reference to this
in order to allow method chaining
*/
public setWrapping(sWrapping: sap.ui.core.Wrapping): sap.ui.commons.TextArea;
}
/**
* Renders an input field for text input.
*/
export class TextField extends sap.ui.core.Control {
/**
* Constructor for a new TextField.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sID - id for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sID?: string, mSettings?: any);
/**
* Compares the previous value with the current value and fires the change event
* if the TextField is editable and the value has changed.
* @param {JQueryEventObject} oEvent - The event object.
*/
protected _checkChange(oEvent: JQueryEventObject): void;
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.TextField;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.TextField;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.commons.TextField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.TextField
itself.
*
* Event is fired when the text in the field has changed AND the focus leaves the TextField or the Enter key is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.TextField
itself
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.ui.commons.TextField;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.commons.TextField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.TextField
itself.
*
* Event is fired when the text in the field has changed AND the focus leaves the TextField or the Enter key is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.TextField
itself
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.TextField;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.ui.commons.TextField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.TextField
itself.
*
* This event if fired during typing into the TextField
and returns the currently entered value.
* Note: This is not the content of the value property.
* The value property is only updated by ENTER and by leaving the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.TextField
itself
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public attachLiveChange(fnFunction: Function, oListener?: any): sap.ui.commons.TextField;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.ui.commons.TextField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.TextField
itself.
*
* This event if fired during typing into the TextField
and returns the currently entered value.
* Note: This is not the content of the value property.
* The value property is only updated by ENTER and by leaving the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.TextField
itself
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public attachLiveChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.TextField;
/**
* Binds property {@link #getValue value} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a
* detailed description of the possible properties of oBindingInfo
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public bindValue(oBindingInfo: any): sap.ui.commons.TextField;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.ui.commons.TextField
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.ui.commons.TextField;
/**
* Detaches event handler fnFunction
from the {@link #event:liveChange liveChange} event of this sap.ui.commons.TextField
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public detachLiveChange(fnFunction: Function, oListener: any): sap.ui.commons.TextField;
/**
* Creates a new subclass of class sap.ui.commons.TextField with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.ui.commons.TextField;
/**
* Fires event {@link #event:liveChange liveChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
protected fireLiveChange(mParameters?: any): sap.ui.commons.TextField;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getAccessibleRole accessibleRole}.
*
* Accessibility role for the text field.
*
* Default value is Textbox
.
* @returns {sap.ui.core.AccessibleRole} Value of property accessibleRole
*/
public getAccessibleRole(): sap.ui.core.AccessibleRole;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getDesign design}.
*
* Font type. valid values are Standard and Monospace.
*
* Default value is Standard
.
* @returns {sap.ui.core.Design} Value of property design
*/
public getDesign(): sap.ui.core.Design;
/**
* Gets current value of property {@link #getEditable editable}.
*
* Switches edit state of the control. Read-only fields have different colors, depending on theme setting.
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Switches enabled state of the control. Disabled fields have different colors, and can not be focused.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Returns an object representing the serialized focus information
* @returns {any} an object representing the serialized focus information
*/
protected getFocusInfo(): any;
/**
* Gets current value of property {@link #getHelpId helpId}.
*
* Unique identifier used for help service.
*
* Default value is
.
* @returns {string} Value of property helpId
*/
public getHelpId(): string;
/**
* Gets current value of property {@link #getImeMode imeMode}.
*
* State of the Input Method Editor (IME).
*
* Default value is Auto
.
* @returns {sap.ui.core.ImeMode} Value of property imeMode
*/
public getImeMode(): sap.ui.core.ImeMode;
/**
* Method for accessing the DOM Ref of the input element.
* @returns {any} DOM reference or null
*/
protected getInputDomRef(): any;
/**
* Returns the current value of the TextField
.
* In case of editing the TextField
you can access the current value via this method.
* The validated value is accessible via the property value.
* @returns {string} live value
*/
public getLiveValue(): string;
/**
* Gets current value of property {@link #getMaxLength maxLength}.
*
* Maximum number of characters. Value '0' means the feature is switched off.
*
* Default value is 0
.
* @returns {number} Value of property maxLength
*/
public getMaxLength(): number;
/**
* Returns a metadata object for class sap.ui.commons.TextField.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* The name
property to be used in the HTML code (e.g. for HTML forms that send data to the server via 'submit').
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets current value of property {@link #getPlaceholder placeholder}.
*
* Placeholder for the text field.
* @returns {string} Value of property placeholder
*/
public getPlaceholder(): string;
/**
* Gets current value of property {@link #getRequired required}.
*
* Depending on theme the TextField
is shown as required.
* If a Label
is assigned to the TextField
it will visualize the requires state too.
*
* Default value is false
.
* @returns {boolean} Value of property required
*/
public getRequired(): boolean;
/**
* Gets current value of property {@link #getTextAlign textAlign}.
*
* Sets the horizontal alignment of the text.
*
* Default value is Begin
.
* @returns {sap.ui.core.TextAlign} Value of property textAlign
*/
public getTextAlign(): sap.ui.core.TextAlign;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Direction of the text. Possible values: "rtl", "ltr".
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getValue value}.
*
* Text inside the TextField
*
* Default value is
.
* @returns {string} Value of property value
*/
public getValue(): string;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Visualizes warnings or errors related to the text field. Possible values: Warning, Error, Success.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of text field. When it is set (CSS-size such as % or px), this is the exact size. When left blank, the text field length defines the width.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Event handler called when control is receiving the focus
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onfocusin(oEvent: JQueryEventObject): void;
/**
* Event handler for keyup.
* fire the liveChange event
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onkeyup(oEvent: JQueryEventObject): void;
/**
* Event handler called when enter key is pressed.
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onsapenter(oEvent: JQueryEventObject): void;
/**
* Event handler called when control is losing the focus
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onsapfocusleave(oEvent: JQueryEventObject): void;
/**
* Event handler called when text selection starts.
* When the text field is disabled, the text should not be selectable, so cancel the event.
* @param {JQueryEventObject} oEvent - The event object.
*/
protected onselectstart(oEvent: JQueryEventObject): void;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getAccessibleRole accessibleRole}.
*
* Accessibility role for the text field.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Textbox
.
* @param {sap.ui.core.AccessibleRole} sAccessibleRole - New value for property accessibleRole
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public setAccessibleRole(sAccessibleRole: sap.ui.core.AccessibleRole): sap.ui.commons.TextField;
/**
* Sets a new value for property {@link #getDesign design}.
*
* Font type. valid values are Standard and Monospace.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.ui.core.Design} sDesign - New value for property design
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public setDesign(sDesign: sap.ui.core.Design): sap.ui.commons.TextField;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Switches edit state of the control. Read-only fields have different colors, depending on theme setting.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.ui.commons.TextField;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Switches enabled state of the control. Disabled fields have different colors, and can not be focused.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.TextField;
/**
* Sets a new value for property {@link #getHelpId helpId}.
*
* Unique identifier used for help service.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sHelpId - New value for property helpId
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public setHelpId(sHelpId: string): sap.ui.commons.TextField;
/**
* Sets a new value for property {@link #getImeMode imeMode}.
*
* State of the Input Method Editor (IME).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.ui.core.ImeMode} sImeMode - New value for property imeMode
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public setImeMode(sImeMode: sap.ui.core.ImeMode): sap.ui.commons.TextField;
/**
* Sets a new value for property {@link #getMaxLength maxLength}.
*
* Maximum number of characters. Value '0' means the feature is switched off.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iMaxLength - New value for property maxLength
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public setMaxLength(iMaxLength: number): sap.ui.commons.TextField;
/**
* Sets a new value for property {@link #getName name}.
*
* The name
property to be used in the HTML code (e.g. for HTML forms that send data to the server via 'submit').
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.ui.commons.TextField;
/**
* Sets a new value for property {@link #getPlaceholder placeholder}.
*
* Placeholder for the text field.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sPlaceholder - New value for property placeholder
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public setPlaceholder(sPlaceholder: string): sap.ui.commons.TextField;
/**
* Sets a new value for property {@link #getRequired required}.
*
* Depending on theme the TextField
is shown as required.
* If a Label
is assigned to the TextField
it will visualize the requires state too.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bRequired - New value for property required
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public setRequired(bRequired: boolean): sap.ui.commons.TextField;
/**
* Sets a new value for property {@link #getTextAlign textAlign}.
*
* Sets the horizontal alignment of the text.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Begin
.
* @param {sap.ui.core.TextAlign} sTextAlign - New value for property textAlign
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public setTextAlign(sTextAlign: sap.ui.core.TextAlign): sap.ui.commons.TextField;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Direction of the text. Possible values: "rtl", "ltr".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.ui.commons.TextField;
/**
* Sets a new value for property {@link #getValue value}.
*
* Text inside the TextField
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sValue - New value for property value
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public setValue(sValue: string): sap.ui.commons.TextField;
/**
* Sets a new value for property {@link #getValueState valueState}.
*
* Visualizes warnings or errors related to the text field. Possible values: Warning, Error, Success.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sValueState - New value for property valueState
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public setValueState(sValueState: sap.ui.core.ValueState): sap.ui.commons.TextField;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of text field. When it is set (CSS-size such as % or px), this is the exact size. When left blank, the text field length defines the width.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.TextField;
/**
* Unbinds property {@link #getValue value} from model data.
* @returns {sap.ui.commons.TextField} Reference to this
in order to allow method chaining
*/
public unbindValue(): sap.ui.commons.TextField;
}
/**
* Is used to display some continous text. The control can inherit the text direction from its parent control.
*/
export class TextView extends sap.ui.core.Control {
/**
* Constructor for a new TextView.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.TextView} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.TextView;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.TextView} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.TextView;
/**
* Binds property {@link #getText text} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a
* detailed description of the possible properties of oBindingInfo
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.commons.TextView} Reference to this
in order to allow method chaining
*/
public bindText(oBindingInfo: any): sap.ui.commons.TextView;
/**
* Creates a new subclass of class sap.ui.commons.TextView with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getAccessibleRole accessibleRole}.
*
* The ARIA role for the control.
* @returns {sap.ui.core.AccessibleRole} Value of property accessibleRole
*/
public getAccessibleRole(): sap.ui.core.AccessibleRole;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getDesign design}.
*
* Defines the visual appearance of the control.
*
* Default value is Standard
.
* @returns {sap.ui.commons.TextViewDesign} Value of property design
*/
public getDesign(): sap.ui.commons.TextViewDesign;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Switches the enabled state of the control. When the control is disabled, it is greyed out and no longer focusable.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getHelpId helpId}.
*
* Unique identifier used for help services.
*
* Default value is
.
* @returns {string} Value of property helpId
*/
public getHelpId(): string;
/**
* Returns a metadata object for class sap.ui.commons.TextView.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSemanticColor semanticColor}.
*
* Semantic color of the text View
*
* Default value is Default
.
* @returns {sap.ui.commons.TextViewColor} Value of property semanticColor
*/
public getSemanticColor(): sap.ui.commons.TextViewColor;
/**
* Gets current value of property {@link #getText text}.
*
* Text to be displayed.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextAlign textAlign}.
*
* Sets the horizontal alignment of the text.
*
* Default value is Begin
.
* @returns {sap.ui.core.TextAlign} Value of property textAlign
*/
public getTextAlign(): sap.ui.core.TextAlign;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Determines the text directionality. Available options are LTR and RTL. Alternatively, the control can inherit the text direction from its parent control.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the TextView
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getWrapping wrapping}.
*
* Disabled automatic wrapping of the text.
*
* Default value is true
.
* @returns {boolean} Value of property wrapping
*/
public getWrapping(): boolean;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getAccessibleRole accessibleRole}.
*
* The ARIA role for the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.AccessibleRole} sAccessibleRole - New value for property accessibleRole
* @returns {sap.ui.commons.TextView} Reference to this
in order to allow method chaining
*/
public setAccessibleRole(sAccessibleRole: sap.ui.core.AccessibleRole): sap.ui.commons.TextView;
/**
* Sets a new value for property {@link #getDesign design}.
*
* Defines the visual appearance of the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.ui.commons.TextViewDesign} sDesign - New value for property design
* @returns {sap.ui.commons.TextView} Reference to this
in order to allow method chaining
*/
public setDesign(sDesign: sap.ui.commons.TextViewDesign): sap.ui.commons.TextView;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Switches the enabled state of the control. When the control is disabled, it is greyed out and no longer focusable.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.commons.TextView} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.TextView;
/**
* Sets a new value for property {@link #getHelpId helpId}.
*
* Unique identifier used for help services.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sHelpId - New value for property helpId
* @returns {sap.ui.commons.TextView} Reference to this
in order to allow method chaining
*/
public setHelpId(sHelpId: string): sap.ui.commons.TextView;
/**
* Sets a new value for property {@link #getSemanticColor semanticColor}.
*
* Semantic color of the text View
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Default
.
* @param {sap.ui.commons.TextViewColor} sSemanticColor - New value for property semanticColor
* @returns {sap.ui.commons.TextView} Reference to this
in order to allow method chaining
*/
public setSemanticColor(sSemanticColor: sap.ui.commons.TextViewColor): sap.ui.commons.TextView;
/**
* Sets a new value for property {@link #getText text}.
*
* Text to be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sText - New value for property text
* @returns {sap.ui.commons.TextView} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.commons.TextView;
/**
* Sets a new value for property {@link #getTextAlign textAlign}.
*
* Sets the horizontal alignment of the text.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Begin
.
* @param {sap.ui.core.TextAlign} sTextAlign - New value for property textAlign
* @returns {sap.ui.commons.TextView} Reference to this
in order to allow method chaining
*/
public setTextAlign(sTextAlign: sap.ui.core.TextAlign): sap.ui.commons.TextView;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Determines the text directionality. Available options are LTR and RTL. Alternatively, the control can inherit the text direction from its parent control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.ui.commons.TextView} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.ui.commons.TextView;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of the TextView
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.TextView} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.TextView;
/**
* Sets a new value for property {@link #getWrapping wrapping}.
*
* Disabled automatic wrapping of the text.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bWrapping - New value for property wrapping
* @returns {sap.ui.commons.TextView} Reference to this
in order to allow method chaining
*/
public setWrapping(bWrapping: boolean): sap.ui.commons.TextView;
/**
* Unbinds property {@link #getText text} from model data.
* @returns {sap.ui.commons.TextView} Reference to this
in order to allow method chaining
*/
public unbindText(): sap.ui.commons.TextView;
}
/**
* Semantic Colors of a text.
*/
export enum TextViewColor {
/**
* Critical color
*/
Critical = "Critical",
/**
* Default color
*/
Default = "Default",
/**
* Negative color
*/
Negative = "Negative",
/**
* Positive color
*/
Positive = "Positive",
}
/**
* Designs for TextView.
*/
export enum TextViewDesign {
/**
* Displays the text in bold letters
*/
Bold = "Bold",
/**
* Displays the text in header 1 letters.
*/
H1 = "H1",
/**
* Displays the text in header 2 letters.
*/
H2 = "H2",
/**
* Displays the text in header 3 letters.
*/
H3 = "H3",
/**
* Displays the text in header 4 letters.
*/
H4 = "H4",
/**
* Displays the text in header 5 letters.
*/
H5 = "H5",
/**
* Displays the text in header 6 letters.
*/
H6 = "H6",
/**
* Displays the text in italic letters
*/
Italic = "Italic",
/**
* Displays the text in monospace letters.
*/
Monospace = "Monospace",
/**
* Displays the text in smaller letters.
*/
Small = "Small",
/**
* Displays the text in standard letters.
*/
Standard = "Standard",
/**
* underlined Text
*/
Underline = "Underline",
}
/**
* Represents a title element that can be used for aggregation with other controls
*/
export class Title extends sap.ui.core.Title {
/**
* Constructor for a new Title.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.Title with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Title.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Getter for property level
.
* Defines the level of the title. If set to auto the level of the title is chosen by the control rendering the title.
*
* Currently not all controls using the Title.control supporting this property.
*
* Default value is Auto
* @returns {sap.ui.core.TitleLevel} the value of property level
*/
public getLevel(): sap.ui.core.TitleLevel;
/**
* Returns a metadata object for class sap.ui.commons.Title.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Setter for property level
.
*
* Default value is Auto
* @param {sap.ui.core.TitleLevel} oLevel - new value for property level
* @returns {sap.ui.commons.Title} this
to allow method chaining
*/
public setLevel(oLevel: sap.ui.core.TitleLevel): sap.ui.commons.Title;
}
/**
* The ToggleButton Control is a Button that can be toggled between pressed and normal state
*/
export class ToggleButton extends sap.ui.commons.Button {
/**
* Constructor for a new ToggleButton.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.ToggleButton with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.commons.Button.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Returns a metadata object for class sap.ui.commons.ToggleButton.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPressed pressed}.
*
* The property is “true” when the control is toggled. The default state of this property is "false".
*
* Default value is false
.
* @returns {boolean} Value of property pressed
*/
public getPressed(): boolean;
/**
* Sets a new value for property {@link #getPressed pressed}.
*
* The property is “true” when the control is toggled. The default state of this property is "false".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bPressed - New value for property pressed
* @returns {sap.ui.commons.ToggleButton} Reference to this
in order to allow method chaining
*/
public setPressed(bPressed: boolean): sap.ui.commons.ToggleButton;
}
/**
* A horizontal row of items where in many cases the single toolbar items are buttons containing icons. Note that all controls with the
* sap.ui.commons.ToolbarItem interface can be used as item: Button, ComboBox, TextField.
*/
export class Toolbar extends sap.ui.core.Control {
/**
* Constructor for a new Toolbar.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.ui.commons.ToolbarItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Toolbar} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.ui.commons.ToolbarItem): sap.ui.commons.Toolbar;
/**
* Adds some rightItem to the aggregation {@link #getRightItems rightItems}.
* @param {sap.ui.commons.ToolbarItem} oRightItem - the rightItem to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Toolbar} Reference to this
in order to allow method chaining
*/
public addRightItem(oRightItem: sap.ui.commons.ToolbarItem): sap.ui.commons.Toolbar;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.ui.commons.Toolbar} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.ui.commons.Toolbar;
/**
* Destroys all the rightItems in the aggregation {@link #getRightItems rightItems}.
* @returns {sap.ui.commons.Toolbar} Reference to this
in order to allow method chaining
*/
public destroyRightItems(): sap.ui.commons.Toolbar;
/**
* Creates a new subclass of class sap.ui.commons.Toolbar with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getDesign design}.
*
* Design settings are theme-dependent.
*
* Default value is Flat
.
* @returns {sap.ui.commons.ToolbarDesign} Value of property design
*/
public getDesign(): sap.ui.commons.ToolbarDesign;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Aggregating the tool bar items.
* @returns {sap.ui.commons.ToolbarItem[]}
*/
public getItems(): sap.ui.commons.ToolbarItem[];
/**
* Returns a metadata object for class sap.ui.commons.Toolbar.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getRightItems rightItems}.
*
* Aggregating the right side tool bar items.
* @returns {sap.ui.commons.ToolbarItem[]}
*/
public getRightItems(): sap.ui.commons.ToolbarItem[];
/**
* Gets current value of property {@link #getStandalone standalone}.
*
* Per default, tool bars have the stand alone status.
* Alternatively, they can be nested in other controls and then inherit the design from their parent control.
*
* Default value is true
.
* @returns {boolean} Value of property standalone
*/
public getStandalone(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* When there is not enough space for the toolbar to display all items, the rightmost items are overflowing into a drop-down menu.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.commons.ToolbarItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.ToolbarItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.commons.ToolbarItem): number;
/**
* Checks for the provided sap.ui.commons.ToolbarItem
in the aggregation {@link #getRightItems rightItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.ToolbarItem} oRightItem - The rightItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfRightItem(oRightItem: sap.ui.commons.ToolbarItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.ui.commons.ToolbarItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.ui.commons.Toolbar} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.ui.commons.ToolbarItem, iIndex: number): sap.ui.commons.Toolbar;
/**
* Inserts a rightItem into the aggregation {@link #getRightItems rightItems}.
* @param {sap.ui.commons.ToolbarItem} oRightItem - the rightItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the rightItem should be inserted at; for a negative value of iIndex
, the rightItem is inserted at position 0; for a value greater than the current size of the aggregation, the rightItem is inserted at the last position
* @returns {sap.ui.commons.Toolbar} Reference to this
in order to allow method chaining
*/
public insertRightItem(oRightItem: sap.ui.commons.ToolbarItem, iIndex: number): sap.ui.commons.Toolbar;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.ToolbarItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.ui.commons.ToolbarItem[];
/**
* Removes all the controls from the aggregation {@link #getRightItems rightItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.ToolbarItem[]} An array of the removed elements (might be empty)
*/
public removeAllRightItems(): sap.ui.commons.ToolbarItem[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.ui.commons.ToolbarItem} vItem - The item to remove or its index or id
* @returns {sap.ui.commons.ToolbarItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.ui.commons.ToolbarItem): sap.ui.commons.ToolbarItem;
/**
* Removes a rightItem from the aggregation {@link #getRightItems rightItems}.
* @param {number|string|sap.ui.commons.ToolbarItem} vRightItem - The rightItem to remove or its index or id
* @returns {sap.ui.commons.ToolbarItem} The removed rightItem or null
*/
public removeRightItem(vRightItem: number|string|sap.ui.commons.ToolbarItem): sap.ui.commons.ToolbarItem;
/**
* Sets a new value for property {@link #getDesign design}.
*
* Design settings are theme-dependent.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Flat
.
* @param {sap.ui.commons.ToolbarDesign} sDesign - New value for property design
* @returns {sap.ui.commons.Toolbar} Reference to this
in order to allow method chaining
*/
public setDesign(sDesign: sap.ui.commons.ToolbarDesign): sap.ui.commons.Toolbar;
/**
* Sets a new value for property {@link #getStandalone standalone}.
*
* Per default, tool bars have the stand alone status.
* Alternatively, they can be nested in other controls and then inherit the design from their parent control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bStandalone - New value for property standalone
* @returns {sap.ui.commons.Toolbar} Reference to this
in order to allow method chaining
*/
public setStandalone(bStandalone: boolean): sap.ui.commons.Toolbar;
/**
* Sets a new value for property {@link #getWidth width}.
*
* When there is not enough space for the toolbar to display all items, the rightmost items are overflowing into a drop-down menu.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.Toolbar} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.Toolbar;
}
/**
* Determines the visual design of a Toolbar.
*/
export enum ToolbarDesign {
/**
* The included controls have a very light appearance. The feature might be not supported by all themes.
*/
Flat = "Flat",
/**
* The toolbar elements such as buttons for example have their normal visual design, and the toolbar appears solid.
* The feature might be not supported by all themes.
*/
Standard = "Standard",
/**
* The controls included in the toolbar have a normal visual design where the toolbar appears transparent.
* The feature might be not supported by all themes.
*/
Transparent = "Transparent",
}
/**
* Marker interface for common controls which are suitable for use within a toolbar.
* The most prominent example of a toolbar item is a button which is mostly used with
* an icon instead of a text caption.
*
* Toolbar items must have a fixed height compatible with the toolbar being
* a single horizontal row. They can refer to the toolbar's marker class
* "sapUiTb" to adjust their own theming when used inside a toolbar.
*/
export interface ToolbarItem {
}
/**
* A small vertical line that is generally added to the tool bar between the items to visually separate them.
*/
export class ToolbarSeparator extends sap.ui.core.Element {
/**
* Constructor for a new ToolbarSeparator.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.commons.ToolbarSeparator with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getDesign design}.
*
* Design of the Separator.
* @returns {sap.ui.commons.ToolbarSeparatorDesign} Value of property design
*/
public getDesign(): sap.ui.commons.ToolbarSeparatorDesign;
/**
* Gets current value of property {@link #getDisplayVisualSeparator displayVisualSeparator}.
*
* When set to false, there is no visual indication of separation by a vertical line but by a wider space.
*
* Default value is true
.
* @returns {boolean} Value of property displayVisualSeparator
*/
public getDisplayVisualSeparator(): boolean;
/**
* Returns a metadata object for class sap.ui.commons.ToolbarSeparator.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets a new value for property {@link #getDesign design}.
*
* Design of the Separator.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.commons.ToolbarSeparatorDesign} sDesign - New value for property design
* @returns {sap.ui.commons.ToolbarSeparator} Reference to this
in order to allow method chaining
*/
public setDesign(sDesign: sap.ui.commons.ToolbarSeparatorDesign): sap.ui.commons.ToolbarSeparator;
/**
* Sets a new value for property {@link #getDisplayVisualSeparator displayVisualSeparator}.
*
* When set to false, there is no visual indication of separation by a vertical line but by a wider space.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bDisplayVisualSeparator - New value for property displayVisualSeparator
* @returns {sap.ui.commons.ToolbarSeparator} Reference to this
in order to allow method chaining
*/
public setDisplayVisualSeparator(bDisplayVisualSeparator: boolean): sap.ui.commons.ToolbarSeparator;
}
/**
* Design of the Toolbar Separator.
*/
export enum ToolbarSeparatorDesign {
/**
* 100% height Separator before and after specific controls
*/
FullHeight = "FullHeight",
/**
* Standard Separator between controls
*/
Standard = "Standard",
}
/**
* Simple tree to display item in a hierarchical way
*/
export class Tree extends sap.ui.core.Control {
/**
* Constructor for a new Tree.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some node to the aggregation {@link #getNodes nodes}.
* @param {sap.ui.commons.TreeNode} oNode - the node to add; if empty, nothing is inserted
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public addNode(oNode: sap.ui.commons.TreeNode): sap.ui.commons.Tree;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.commons.Tree
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Tree
itself.
*
* Event is fired when a tree node is selected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Tree
itself
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.commons.Tree;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.commons.Tree
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Tree
itself.
*
* Event is fired when a tree node is selected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Tree
itself
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.Tree;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChange selectionChange} event of this sap.ui.commons.Tree
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Tree
itself.
*
* fired when the selection of the tree has been changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Tree
itself
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public attachSelectionChange(fnFunction: Function, oListener?: any): sap.ui.commons.Tree;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChange selectionChange} event of this sap.ui.commons.Tree
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.Tree
itself.
*
* fired when the selection of the tree has been changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.Tree
itself
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public attachSelectionChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.Tree;
/**
* Binds aggregation {@link #getNodes nodes} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public bindNodes(oBindingInfo: any): sap.ui.commons.Tree;
/**
* Collapses all nodes in the tree
*/
public collapseAll(): void;
/**
* Destroys all the nodes in the aggregation {@link #getNodes nodes}.
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public destroyNodes(): sap.ui.commons.Tree;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.commons.Tree
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.commons.Tree;
/**
* Detaches event handler fnFunction
from the {@link #event:selectionChange selectionChange} event of this sap.ui.commons.Tree
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public detachSelectionChange(fnFunction: Function, oListener: any): sap.ui.commons.Tree;
/**
* Expands all nodes in the tree
*/
public expandAll(): void;
/**
* Creates a new subclass of class sap.ui.commons.Tree with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:select select} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireSelect(mParameters?: any): boolean;
/**
* Fires event {@link #event:selectionChange selectionChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
protected fireSelectionChange(mParameters?: any): sap.ui.commons.Tree;
/**
* Gets current value of property {@link #getHeight height}.
*
* Tree height
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.commons.Tree.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinWidth minWidth}.
*
* Minimal width for the Tree. Can be useful when, for example, the width is specified in percentage, to avoid the tree to become too narrow when container is resize
* @returns {sap.ui.core.CSSSize} Value of property minWidth
*/
public getMinWidth(): sap.ui.core.CSSSize;
/**
* Returns the node with the given context, or null if no such node currently exists
* @param {sap.ui.model.Context} oContext - the context of the node to be retrieved
* @returns {any}
*/
public getNodeByContext(oContext: sap.ui.model.Context): any;
/**
* Gets content of aggregation {@link #getNodes nodes}.
*
* First level nodes
* @returns {sap.ui.commons.TreeNode[]}
*/
public getNodes(): sap.ui.commons.TreeNode[];
/**
* Gets current value of property {@link #getSelectionMode selectionMode}.
*
* Selection mode of the Tree.
*
* Default value is Legacy
.
* @returns {sap.ui.commons.TreeSelectionMode} Value of property selectionMode
*/
public getSelectionMode(): sap.ui.commons.TreeSelectionMode;
/**
* Gets current value of property {@link #getShowHeader showHeader}.
*
* Tree Header is display. If false, the tree will be in a transparent mode
*
* Default value is true
.
* @returns {boolean} Value of property showHeader
*/
public getShowHeader(): boolean;
/**
* Gets current value of property {@link #getShowHeaderIcons showHeaderIcons}.
*
* Show Header icons (e.g. Expand/Collapse all). Only consider if showHeader is true
*
* Default value is true
.
* @returns {boolean} Value of property showHeaderIcons
*/
public getShowHeaderIcons(): boolean;
/**
* Gets current value of property {@link #getShowHorizontalScrollbar showHorizontalScrollbar}.
*
* Display horizontal scrollbar. If false, the overflow content will be hidden
*
* Default value is false
.
* @returns {boolean} Value of property showHorizontalScrollbar
*/
public getShowHorizontalScrollbar(): boolean;
/**
* Gets current value of property {@link #getTitle title}.
*
* Tree title
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Tree width
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.commons.TreeNode
in the aggregation {@link #getNodes nodes}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.TreeNode} oNode - The node whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfNode(oNode: sap.ui.commons.TreeNode): number;
/**
* Inserts a node into the aggregation {@link #getNodes nodes}.
* @param {sap.ui.commons.TreeNode} oNode - the node to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the node should be inserted at; for a negative value of iIndex
, the node is inserted at position 0; for a value greater than the current size of the aggregation, the node is inserted at the last position
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public insertNode(oNode: sap.ui.commons.TreeNode, iIndex: number): sap.ui.commons.Tree;
/**
* Removes all the controls from the aggregation {@link #getNodes nodes}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.TreeNode[]} An array of the removed elements (might be empty)
*/
public removeAllNodes(): sap.ui.commons.TreeNode[];
/**
* Removes a node from the aggregation {@link #getNodes nodes}.
* @param {number|string|sap.ui.commons.TreeNode} vNode - The node to remove or its index or id
* @returns {sap.ui.commons.TreeNode} The removed node or null
*/
public removeNode(vNode: number|string|sap.ui.commons.TreeNode): sap.ui.commons.TreeNode;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Tree height
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.commons.Tree;
/**
* Sets a new value for property {@link #getMinWidth minWidth}.
*
* Minimal width for the Tree. Can be useful when, for example, the width is specified in percentage, to avoid the tree to become too narrow when container is resize
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sMinWidth - New value for property minWidth
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public setMinWidth(sMinWidth: sap.ui.core.CSSSize): sap.ui.commons.Tree;
/**
* Sets a new value for property {@link #getSelectionMode selectionMode}.
*
* Selection mode of the Tree.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Legacy
.
* @param {sap.ui.commons.TreeSelectionMode} sSelectionMode - New value for property selectionMode
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public setSelectionMode(sSelectionMode: sap.ui.commons.TreeSelectionMode): sap.ui.commons.Tree;
/**
* Sets a new value for property {@link #getShowHeader showHeader}.
*
* Tree Header is display. If false, the tree will be in a transparent mode
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowHeader - New value for property showHeader
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public setShowHeader(bShowHeader: boolean): sap.ui.commons.Tree;
/**
* Sets a new value for property {@link #getShowHeaderIcons showHeaderIcons}.
*
* Show Header icons (e.g. Expand/Collapse all). Only consider if showHeader is true
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowHeaderIcons - New value for property showHeaderIcons
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public setShowHeaderIcons(bShowHeaderIcons: boolean): sap.ui.commons.Tree;
/**
* Sets a new value for property {@link #getShowHorizontalScrollbar showHorizontalScrollbar}.
*
* Display horizontal scrollbar. If false, the overflow content will be hidden
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowHorizontalScrollbar - New value for property showHorizontalScrollbar
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public setShowHorizontalScrollbar(bShowHorizontalScrollbar: boolean): sap.ui.commons.Tree;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Tree title
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.commons.Tree;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Tree width
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.Tree;
/**
* Unbinds aggregation {@link #getNodes nodes} from model data.
* @returns {sap.ui.commons.Tree} Reference to this
in order to allow method chaining
*/
public unbindNodes(): sap.ui.commons.Tree;
}
/**
* Tree node element
*/
export class TreeNode extends sap.ui.core.Element {
/**
* Constructor for a new TreeNode.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.TreeNode;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.commons.TreeNode;
/**
* Adds some node to the aggregation {@link #getNodes nodes}.
* @param {sap.ui.commons.TreeNode} oNode - the node to add; if empty, nothing is inserted
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
public addNode(oNode: sap.ui.commons.TreeNode): sap.ui.commons.TreeNode;
/**
* Attaches event handler fnFunction
to the {@link #event:selected selected} event of this sap.ui.commons.TreeNode
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.TreeNode
itself.
*
* Node is selected
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.TreeNode
itself
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
public attachSelected(fnFunction: Function, oListener?: any): sap.ui.commons.TreeNode;
/**
* Attaches event handler fnFunction
to the {@link #event:selected selected} event of this sap.ui.commons.TreeNode
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.TreeNode
itself.
*
* Node is selected
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.TreeNode
itself
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
public attachSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.TreeNode;
/**
* Attaches event handler fnFunction
to the {@link #event:toggleOpenState toggleOpenState} event of this sap.ui.commons.TreeNode
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.TreeNode
itself.
*
* Node state has changed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.TreeNode
itself
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
public attachToggleOpenState(fnFunction: Function, oListener?: any): sap.ui.commons.TreeNode;
/**
* Attaches event handler fnFunction
to the {@link #event:toggleOpenState toggleOpenState} event of this sap.ui.commons.TreeNode
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.TreeNode
itself.
*
* Node state has changed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.TreeNode
itself
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
public attachToggleOpenState(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.TreeNode;
/**
* Collapses the node.
* @param {boolean} bCollapseChildren - Propagates collapse to node's children
* @param {boolean} bDisableCollapseFinishedHandler - Disables the collapse finished handler
*/
public collapse(bCollapseChildren: boolean, bDisableCollapseFinishedHandler: boolean): void;
/**
* Destroys all the nodes in the aggregation {@link #getNodes nodes}.
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
public destroyNodes(): sap.ui.commons.TreeNode;
/**
* Detaches event handler fnFunction
from the {@link #event:selected selected} event of this sap.ui.commons.TreeNode
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
public detachSelected(fnFunction: Function, oListener: any): sap.ui.commons.TreeNode;
/**
* Detaches event handler fnFunction
from the {@link #event:toggleOpenState toggleOpenState} event of this sap.ui.commons.TreeNode
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
public detachToggleOpenState(fnFunction: Function, oListener: any): sap.ui.commons.TreeNode;
/**
* Expands the node.
* @param {boolean} bExpandChildren - Propagates expand to node's children
* @param {boolean} bDisableExpandFinishedHandler - Disables the expand finished handler
*/
public expand(bExpandChildren: boolean, bDisableExpandFinishedHandler: boolean): void;
/**
* Creates a new subclass of class sap.ui.commons.TreeNode with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:selected selected} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
protected fireSelected(mParameters?: any): sap.ui.commons.TreeNode;
/**
* Fires event {@link #event:toggleOpenState toggleOpenState} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
protected fireToggleOpenState(mParameters?: any): sap.ui.commons.TreeNode;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getExpanded expanded}.
*
* Node is expanded
*
* Default value is true
.
* @returns {boolean} Value of property expanded
*/
public getExpanded(): boolean;
/**
* Gets current value of property {@link #getHasExpander hasExpander}.
*
* Should the node has an expander.
*
* Default value is false
.
* @returns {boolean} Value of property hasExpander
*/
public getHasExpander(): boolean;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Icon to display in front of the node
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIsSelected isSelected}.
*
* Node is selected
*
* Default value is false
.
* @returns {boolean} Value of property isSelected
*/
public getIsSelected(): boolean;
/**
* Returns a metadata object for class sap.ui.commons.TreeNode.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getNodes nodes}.
*
* Subnodes for the current node
* @returns {sap.ui.commons.TreeNode[]}
*/
public getNodes(): sap.ui.commons.TreeNode[];
/**
* Gets current value of property {@link #getSelectable selectable}.
*
* The node is selectable. If true, clicking on the node text triggers "selected" event
*
* Default value is true
.
* @returns {boolean} Value of property selectable
*/
public getSelectable(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* Node text
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Checks for the provided sap.ui.commons.TreeNode
in the aggregation {@link #getNodes nodes}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.TreeNode} oNode - The node whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfNode(oNode: sap.ui.commons.TreeNode): number;
/**
* Inserts a node into the aggregation {@link #getNodes nodes}.
* @param {sap.ui.commons.TreeNode} oNode - the node to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the node should be inserted at; for a negative value of iIndex
, the node is inserted at position 0; for a value greater than the current size of the aggregation, the node is inserted at the last position
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
public insertNode(oNode: sap.ui.commons.TreeNode, iIndex: number): sap.ui.commons.TreeNode;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getNodes nodes}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.TreeNode[]} An array of the removed elements (might be empty)
*/
public removeAllNodes(): sap.ui.commons.TreeNode[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a node from the aggregation {@link #getNodes nodes}.
* @param {number|string|sap.ui.commons.TreeNode} vNode - The node to remove or its index or id
* @returns {sap.ui.commons.TreeNode} The removed node or null
*/
public removeNode(vNode: number|string|sap.ui.commons.TreeNode): sap.ui.commons.TreeNode;
/**
* Select the node, and if any, deselects the previously selected node
* @param {boolean} bSuppressEvent
* @param {boolean} bDeselectOtherNodes
*/
public select(bSuppressEvent: boolean, bDeselectOtherNodes: boolean): void;
/**
* Sets a new value for property {@link #getExpanded expanded}.
*
* Node is expanded
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bExpanded - New value for property expanded
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
public setExpanded(bExpanded: boolean): sap.ui.commons.TreeNode;
/**
* Sets a new value for property {@link #getHasExpander hasExpander}.
*
* Should the node has an expander.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bHasExpander - New value for property hasExpander
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
public setHasExpander(bHasExpander: boolean): sap.ui.commons.TreeNode;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Icon to display in front of the node
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.commons.TreeNode;
/**
* Redefinition of Setter for property isSelected
for validation purpose
*
* Default value is empty/undefined
* @param {boolean} bIsSelected - new value for property isSelected
* @returns {sap.ui.commons.TreeNode} this
to allow method chaining
*/
public setIsSelected(bIsSelected: boolean): sap.ui.commons.TreeNode;
/**
* Redefinition of Setter for property selectable
for validation purpose.
*
* Default value is true
* @param {boolean} bSelectable - new value for property selectable
* @returns {sap.ui.commons.TreeNode} this
to allow method chaining
*/
public setSelectable(bSelectable: boolean): sap.ui.commons.TreeNode;
/**
* Sets a new value for property {@link #getText text}.
*
* Node text
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.commons.TreeNode} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.commons.TreeNode;
}
/**
* Selection mode of the tree
*/
export enum TreeSelectionMode {
/**
* Behavior of the former Tree. It is possible to select a plurality of nodes via the API.
*/
Legacy = "Legacy",
/**
* Select multiple rows at a time.
*/
Multi = "Multi",
/**
* No rows can be selected.
*/
None = "None",
/**
* Select one row at a time.
*/
Single = "Single",
}
/**
* TriStateCheckBox to reflect mixed state for checkboxes. The control can display three states, namely checked, unchecked and mixed. However, mixed state cannot be directly reached by user interaction on the particular control.
* It can be only set by the control's public toggle function, to make a behaviour possible which is e.g. required in checkbox trees.
*/
export class TriStateCheckBox extends sap.ui.core.Control {
/**
* Constructor for a new TriStateCheckBox.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.commons.TriStateCheckBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.TriStateCheckBox
itself.
*
* Event is triggered when the control status is changed by the user by flagging or unflagging the checkbox.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.TriStateCheckBox
itself
* @returns {sap.ui.commons.TriStateCheckBox} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.ui.commons.TriStateCheckBox;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.commons.TriStateCheckBox
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.TriStateCheckBox
itself.
*
* Event is triggered when the control status is changed by the user by flagging or unflagging the checkbox.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.TriStateCheckBox
itself
* @returns {sap.ui.commons.TriStateCheckBox} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.TriStateCheckBox;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.ui.commons.TriStateCheckBox
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.TriStateCheckBox} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.ui.commons.TriStateCheckBox;
/**
* Creates a new subclass of class sap.ui.commons.TriStateCheckBox with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.TriStateCheckBox} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.ui.commons.TriStateCheckBox;
/**
* Gets current value of property {@link #getEditable editable}.
*
* Specifies whether the user shall be allowed to flag the check box
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Using this property, the control could be disabled, if required.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Returns a metadata object for class sap.ui.commons.TriStateCheckBox.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSelectionState selectionState}.
*
* Defines the states of the checkbox
*
* Default value is Unchecked
.
* @returns {sap.ui.commons.TriStateCheckBoxState} Value of property selectionState
*/
public getSelectionState(): sap.ui.commons.TriStateCheckBoxState;
/**
* Gets current value of property {@link #getText text}.
*
* Defines the text displayed next to the check box
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* The value can be set to LTR or RTL. Otherwise, the control inherits the text direction from its parent control.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Accepts the core enumeration ValueState.type that supports 'None', 'Error', 'Warning' and 'Success'.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getWidth width}.
*
* The width can be set to an absolute value. If no value is set, the control width results from the text length.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Specifies whether the user shall be allowed to flag the check box
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.ui.commons.TriStateCheckBox} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.ui.commons.TriStateCheckBox;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Using this property, the control could be disabled, if required.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.commons.TriStateCheckBox} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.commons.TriStateCheckBox;
/**
* Sets a new value for property {@link #getSelectionState selectionState}.
*
* Defines the states of the checkbox
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Unchecked
.
* @param {sap.ui.commons.TriStateCheckBoxState} sSelectionState - New value for property selectionState
* @returns {sap.ui.commons.TriStateCheckBox} Reference to this
in order to allow method chaining
*/
public setSelectionState(sSelectionState: sap.ui.commons.TriStateCheckBoxState): sap.ui.commons.TriStateCheckBox;
/**
* Sets a new value for property {@link #getText text}.
*
* Defines the text displayed next to the check box
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.commons.TriStateCheckBox} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.commons.TriStateCheckBox;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* The value can be set to LTR or RTL. Otherwise, the control inherits the text direction from its parent control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.ui.commons.TriStateCheckBox} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.ui.commons.TriStateCheckBox;
/**
* Sets a new value for property {@link #getValueState valueState}.
*
* Accepts the core enumeration ValueState.type that supports 'None', 'Error', 'Warning' and 'Success'.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sValueState - New value for property valueState
* @returns {sap.ui.commons.TriStateCheckBox} Reference to this
in order to allow method chaining
*/
public setValueState(sValueState: sap.ui.core.ValueState): sap.ui.commons.TriStateCheckBox;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The width can be set to an absolute value. If no value is set, the control width results from the text length.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.commons.TriStateCheckBox} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.commons.TriStateCheckBox;
/**
* Method called whenever a user clicks on a tri-state checkbox
* @param {sap.ui.commons.TriStateCheckBoxState} destState - destined selection state of checkbox
*/
public toggle(destState: sap.ui.commons.TriStateCheckBoxState): void;
}
/**
* States for TriStateCheckBox
*/
export enum TriStateCheckBoxState {
/**
* checked value for tri-state checkbox
*/
Checked = "Checked",
/**
* mixed state for tri-state checkbox
*/
Mixed = "Mixed",
/**
* unchecked, default value for tri-state checkbox
*/
Unchecked = "Unchecked",
}
/**
* A TextField with an attached icon which triggeres an event.
*/
export class ValueHelpField extends sap.ui.commons.TextField {
/**
* Constructor for a new ValueHelpField.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:valueHelpRequest valueHelpRequest} event of this sap.ui.commons.ValueHelpField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.ValueHelpField
itself.
*
* Event which is fired when the ValueHelp is requested.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.ValueHelpField
itself
* @returns {sap.ui.commons.ValueHelpField} Reference to this
in order to allow method chaining
*/
public attachValueHelpRequest(fnFunction: Function, oListener?: any): sap.ui.commons.ValueHelpField;
/**
* Attaches event handler fnFunction
to the {@link #event:valueHelpRequest valueHelpRequest} event of this sap.ui.commons.ValueHelpField
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.commons.ValueHelpField
itself.
*
* Event which is fired when the ValueHelp is requested.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.commons.ValueHelpField
itself
* @returns {sap.ui.commons.ValueHelpField} Reference to this
in order to allow method chaining
*/
public attachValueHelpRequest(oData: any, fnFunction: Function, oListener?: any): sap.ui.commons.ValueHelpField;
/**
* Detaches event handler fnFunction
from the {@link #event:valueHelpRequest valueHelpRequest} event of this sap.ui.commons.ValueHelpField
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.commons.ValueHelpField} Reference to this
in order to allow method chaining
*/
public detachValueHelpRequest(fnFunction: Function, oListener: any): sap.ui.commons.ValueHelpField;
/**
* Creates a new subclass of class sap.ui.commons.ValueHelpField with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.commons.TextField.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:valueHelpRequest valueHelpRequest} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.commons.ValueHelpField} Reference to this
in order to allow method chaining
*/
protected fireValueHelpRequest(mParameters?: any): sap.ui.commons.ValueHelpField;
/**
* Gets current value of property {@link #getIconDisabledURL iconDisabledURL}.
*
* URL of the icon for the value help when disabled. If no parameter is supplied the default icon image will be shown.
* If an icon font icon is used, this property is ignored.
* @returns {sap.ui.core.URI} Value of property iconDisabledURL
*/
public getIconDisabledURL(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconHoverURL iconHoverURL}.
*
* URL of the icon for the value help when hovered. If no parameter is supplied the standard icon image will be shown.
* If an icon font icon is used, this property is ignored.
* @returns {sap.ui.core.URI} Value of property iconHoverURL
*/
public getIconHoverURL(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconURL iconURL}.
*
* URL of the standard icon for the value help. If no parameter is supplied the default icon image will be shown.
* This can be a URI to an image or an icon font URI.
* @returns {sap.ui.core.URI} Value of property iconURL
*/
public getIconURL(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.ui.commons.ValueHelpField.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Handle F4 event
* @param {JQueryEventObject} oEvent - the occurring event
*/
protected onsapshow(oEvent: JQueryEventObject): void;
/**
* Sets a new value for property {@link #getIconDisabledURL iconDisabledURL}.
*
* URL of the icon for the value help when disabled. If no parameter is supplied the default icon image will be shown.
* If an icon font icon is used, this property is ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIconDisabledURL - New value for property iconDisabledURL
* @returns {sap.ui.commons.ValueHelpField} Reference to this
in order to allow method chaining
*/
public setIconDisabledURL(sIconDisabledURL: sap.ui.core.URI): sap.ui.commons.ValueHelpField;
/**
* Sets a new value for property {@link #getIconHoverURL iconHoverURL}.
*
* URL of the icon for the value help when hovered. If no parameter is supplied the standard icon image will be shown.
* If an icon font icon is used, this property is ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIconHoverURL - New value for property iconHoverURL
* @returns {sap.ui.commons.ValueHelpField} Reference to this
in order to allow method chaining
*/
public setIconHoverURL(sIconHoverURL: sap.ui.core.URI): sap.ui.commons.ValueHelpField;
/**
* Sets a new value for property {@link #getIconURL iconURL}.
*
* URL of the standard icon for the value help. If no parameter is supplied the default icon image will be shown.
* This can be a URI to an image or an icon font URI.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIconURL - New value for property iconURL
* @returns {sap.ui.commons.ValueHelpField} Reference to this
in order to allow method chaining
*/
public setIconURL(sIconURL: sap.ui.core.URI): sap.ui.commons.ValueHelpField;
}
}
/**
* The SAPUI5 Core Runtime.
*
* Contains the UI5 jQuery plugins (jQuery.sap.*), the Core and all its components,
* base classes for Controls, Components and the Model View Controller classes.
*/
namespace core {
/**
* Applies the support for custom style classes on the prototype of a sap.ui.core.Element
.
*
* All controls (subclasses of sap.ui.core.Control
) provide the support custom style classes. The control API provides functions
* to the application which allow it to add, remove or change style classes for the control.
* In general, this option is not available for elements because elements do not necessarily have a representation in the DOM.
*
* This function can be used by a control developer to explicitly enrich the API of his/her element implementation with the API functions
* for the custom style class support. It must be called on the prototype of the element.
*
* Usage Example:
*
* sap.ui.define(['sap/ui/core/Element', 'sap/ui/core/CustomStyleClassSupport'], function(Element, CustomStyleClassSupport) {
* "use strict";
* var MyElement = Element.extend("my.MyElement", {
* metadata : {
* //...
* }
* //...
* });
*
* CustomStyleClassSupport.apply(MyElement.prototype);
*
* return MyElement;
* }, true);
*
*
* Furthermore, the function oRenderManager.writeClasses(oElement);
({@link sap.ui.core.RenderManager#writeClasses}) must be called within
* the renderer of the control to which the element belongs, when writing the root tag of the element. This ensures the classes are written to the HTML.
*
* This function adds the following functions to the elements prototype:
*
* addStyleClass
: {@link sap.ui.core.Control#addStyleClass}
* removeStyleClass
: {@link sap.ui.core.Control#removeStyleClass}
* toggleStyleClass
: {@link sap.ui.core.Control#toggleStyleClass}
* hasStyleClass
: {@link sap.ui.core.Control#hasStyleClass}
*
* In addition the clone function of the element is extended to ensure that the custom style classes are also available on the cloned element.
*
* Note: This function can only be used within control development. An application cannot add style class support on existing elements by calling this function.
*/
function CustomStyleClassSupport(): void;
/**
* A string type that represents non-relative CSS size values.
*
* This is a subtype of the '<length> type'
defined in the CSS specifications.
* Allowed values are only absolute CSS sizes like "1px" or "2em". Percentage
* sizes like "50%" and the special values "auto" and "inherit" are
* NOT allowed. Mathematical expressions using the CSS3 calc(expression)
operator
* are allowed as long as they do not use percentage sizes.
*
* Note that CSS might not allow all these values for every CSS property representing a size.
* So even if a value is accepted by sap.ui.core.AbsoluteCSSSize
, it still might have no effect
* in a specific context. In other words: UI5 controls usually don't extend the range of allowed
* values in CSS.
*
*
* Units
*
* Valid font-relative units are em, ex
and rem
. Supported absolute units
* are cm, mm, in, pc, pt
and px
. Other units are not supported.
*
*
* Mathematical Expressions
*
* Expressions inside the calc()
operator are only roughly checked for validity.
* Not every value that this type accepts is a valid expression in the sense of the CSS spec.
* But vice versa, any expression that is valid according to the spec should be accepted by this type.
* The current implementation is based on the
* {@link http://dev.w3.org/csswg/css-values-3/#calc-syntax CSS3 Draft specification from 22 April 2015}.
*
* Noteworthy details:
*
* - whitespace is mandatory around a '-' or '+' operator and optional otherwise
* - parentheses are accepted but not checked for being balanced (a limitation of regexp based checks)
* - semantic constraints like type restrictions are not checked
*
*
* Future versions of UI5 might check calc()
expressions in more detail, so applications should
* not assume that a value, that is invalid according to the CSS spec but currently accepted by this type
* still will be accepted by future versions of this type.
*/
namespace AbsoluteCSSSize {
}
/**
* Defines the accessible landmark roles for ARIA support. This enumeration is used with the AccessibleRole control property.
* For more information, goto "Roles for Accessible Rich Internet Applications (WAI-ARIA Roles)" at the www.w3.org homepage.
*/
export enum AccessibleLandmarkRole {
/**
* Represents the ARIA role banner
.
*
* A banner usually appears at the top of the page and typically spans the full width.
*/
Banner = "Banner",
/**
* Represents the ARIA role complementary
.
*
* A section of the page, designed to be complementary to the main content at a similar level in the DOM hierarchy.
*/
Complementary = "Complementary",
/**
* Represents the ARIA role main
.
*
* The main content of a page.
*/
Main = "Main",
/**
* Represents the ARIA role navigation
.
*
* A region that contains a collection of items and objects that, as a whole, combine to create a navigation facility.
*/
Navigation = "Navigation",
/**
* No explicit role is applicable.
*
* The interpretation of this value depends on the control / element which defines a property with this type.
* Normally this value means that no accessible landmark should be written.
*/
None = "None",
/**
* Represents the ARIA role region
.
*
* A section of a page, that is important enough to be included in a page summary or table of contents.
*/
Region = "Region",
/**
* Represents the ARIA role search
.
*
* A region that contains a collection of items and objects that, as a whole, combine to create a search facility.
*/
Search = "Search",
}
/**
* Defines the accessible roles for ARIA support. This enumeration is used with the AccessibleRole control property.
* For more information, goto "Roles for Accessible Rich Internet Applications (WAI-ARIA Roles)" at the www.w3.org homepage.
*/
export enum AccessibleRole {
/**
* A message with an alert or error information.
*/
Alert = "Alert",
/**
* A separate window with an alert or error information.
*/
AlertDialog = "AlertDialog",
/**
* A software unit executing a set of tasks for the user.
*/
Application = "Application",
/**
* Usually defined as the advertisement at the top of a web page.
* The banner content typically contains the site or company logo, or other key advertisements.
*/
Banner = "Banner",
/**
* Allows user-triggered actions.
*/
Button = "Button",
/**
* A control that has three possible values: true, false, mixed.
*/
Checkbox = "Checkbox",
/**
* A table cell containing header information for a column.
*/
ColumnHeader = "ColumnHeader",
/**
* Allows selecting an item from a list, or to enter data directly in the input field.
*/
Combobox = "Combobox",
/**
* Information about the content on the page. Examples are footnotes, copyrights, or links to privacy statements.
*/
ContentInfo = "ContentInfo",
/**
* The content of the associated element represents a definition.
* If there is a definition element within the content, this one represents the term being defined.
*/
Definition = "Definition",
/**
* Descriptive content for a page element.
*/
Description = "Description",
/**
* A small window that is designed to interrupt the current application processing
* in order to inform the user and to get some response.
*/
Dialog = "Dialog",
/**
* A list of references to members of a single group.
*/
Directory = "Directory",
/**
* Content that contains related information, such as a book.
*/
Document = "Document",
/**
* Contains cells of tabular data arranged in rows and columns, for example in a table.
*/
Grid = "Grid",
/**
* A table cell in a grid where the cells can be active, editable, and selectable.
* Cells may have functional relationships to controls, for example.
*/
GridCell = "GridCell",
/**
* A section of user interface objects.
*/
Group = "Group",
/**
* A heading for a section of the page.
*/
Heading = "Heading",
/**
* A container for a collection of elements that form an image.
*/
Img = "Img",
/**
* An interactive reference to a resource.
*/
Link = "Link",
/**
* A container for non-interactive list items which are the children of the list.
*/
List = "List",
/**
* A widget that allows the user to select one or more items from a list.
* The items within the list are static and can contain images.
*/
Listbox = "Listbox",
/**
* A single item in a list.
*/
ListItem = "ListItem",
/**
* An area where new information is added, or old information disappears.
* Information types are chat logs, messaging, or error logs, for example.
* The log contains a sequence: New information is always added to the end of the log.
*/
Log = "Log",
/**
* Defines the main content of a document.
*/
Main = "Main",
/**
* Is used to scroll text across the page.
*/
Marquee = "Marquee",
/**
* Offers a list of choices to the user.
*/
Menu = "Menu",
/**
* A container for menu items where each item may activate a submenu.
*/
Menubar = "Menubar",
/**
* A child in a menu.
*/
MenuItem = "MenuItem",
/**
* A checkable menu item (tri-state).
*/
MenuItemCheckbox = "MenuItemCheckbox",
/**
* A menu item which is part of a group of menuitemradio roles.
*/
MenuItemRadio = "MenuItemRadio",
/**
* A collection of links suitable for use when navigating the document or related documents.
*/
Navigation = "Navigation",
/**
* The content is parenthetic or ancillary to the main content of the resource.
*/
Note = "Note",
/**
* A selectable item in a list represented by a select.
*/
Option = "Option",
/**
* An element whose role is presentational does not need to be mapped to the accessibility API.
*/
Presentation = "Presentation",
/**
* Shows the execution progress in applications providing functions that take a long time.
*/
ProgressBar = "ProgressBar",
/**
* An option in single-select list. Only one radio control in a radiogroup can be selected at the same time.
*/
Radio = "Radio",
/**
* A group of radio controls.
*/
RadioGroup = "RadioGroup",
/**
* A large section on the web page.
*/
Region = "Region",
/**
* A row of table cells.
*/
Row = "Row",
/**
* A table cell containing header information for a row.
*/
RowHeader = "RowHeader",
/**
* A search section of a web document. In many cases, this is a form used to submit search requests about the site,
* or a more general Internet wide search service.
*/
Search = "Search",
/**
* A unique section of the document. In the case of a portal, this may include time display, weather forecast,
* or stock price.
*/
Secondary = "Secondary",
/**
* Indicates that the element contains content that is related to the main content of the page.
*/
SeeAlso = "SeeAlso",
/**
* A line or bar that separates sections of content.
*/
Separator = "Separator",
/**
* A user input where the user selects an input in a given range. This form of range expects an analogous keyboard
* interface.
*/
Slider = "Slider",
/**
* Allows users to select a value from a list of given entries where exactly one value is displayed at runtime, and
* the other ones can be displayed by scrolling using the arrow up and arrow down key.
*/
SpinButton = "SpinButton",
/**
* A container for processing advisory information.
*/
Status = "Status",
/**
* A header for a tab panel.
*/
Tab = "Tab",
/**
* A list of tabs which are references to tab panels.
*/
Tablist = "Tablist",
/**
* A container for the resources associated with a tab.
*/
Tabpanel = "Tabpanel",
/**
* Inputs that allow free-form text as their value.
*/
Textbox = "Textbox",
/**
* A numerical counter which indicates an amount of elapsed time from a start point,
* or of the time remaining until a certain end point.
*/
Timer = "Timer",
/**
* A collection of commonly used functions represented in compact visual form.
*/
Toolbar = "Toolbar",
/**
* A popup that displays a description for an element when the user passes over or rests on that element.
* Supplement to the normal tooltip processing of the user agent.
*/
Tooltip = "Tooltip",
/**
* A form of a list (tree) having groups (subtrees) inside groups (subtrees), where the sub trees can be collapsed and expanded.
*/
Tree = "Tree",
/**
* A grid whose rows are expandable and collapsable in the same manner as the ones of trees.
*/
TreeGrid = "TreeGrid",
/**
* A tree node
*/
TreeItem = "TreeItem",
}
/**
* The AppCacheBuster is used to hook into URL relevant functions in jQuery
* and SAPUI5 and rewrite the URLs with a timestamp segment. The timestamp
* information is fetched from the server and used later on for the URL
* rewriting.
*/
namespace AppCacheBuster {
/**
* Converts the given URL if it matches a URL in the cachebuster index.
* If not then the same URL will be returned. To prevent URLs from being
* modified by the application cachebuster you can implement the function
* sap.ui.core.AppCacheBuster.handleURL
.
* @param {string} sUrl - any URL
* @returns {string} modified URL when matching the index or unmodified when not
*/
function convertURL(sUrl: string): string;
/**
* Callback function which can be overwritten to programmatically decide
* whether to rewrite the given URL or not.
* @param {string} sUrl - any URL
* @returns {boolean} true
to rewrite or false
to ignore
*/
function handleURL(sUrl: string): boolean;
/**
* Normalizes the given URL and make it absolute.
* @param {string} sUrl - any URL
* @returns {string} normalized URL
*/
function normalizeURL(sUrl: string): string;
/**
* Registers an application. Loads the cachebuster index file from this
* locations. All registered files will be considered by the cachebuster
* and the URLs will be prefixed with the timestamp of the index file.
* @param {string} base - URL of an application providing a cachebuster index file
*/
function register(base: string): void;
}
/**
* Configuration options for the colors of a progress bar
*/
export enum BarColor {
/**
* Color: yellow (#faf2b0)
*/
CRITICAL = "CRITICAL",
/**
* Color: red (#ff9a90)
*/
NEGATIVE = "NEGATIVE",
/**
* Color: blue (#b8d0e8)
*/
NEUTRAL = "NEUTRAL",
/**
* Color: green (#b5e7a8)
*/
POSITIVE = "POSITIVE",
}
/**
* Provides methods to show or hide a waiting animation covering the whole
* page and blocking user interaction.
*/
export class BusyIndicator {
/**
* Registers a handler for the "close" event
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function.
* @returns {sap.ui.core.BusyIndicator} this
to allow method chaining
*/
public static attachClose(fnFunction: Function, oListener?: any): sap.ui.core.BusyIndicator;
/**
* Registers a handler for the "open" event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function.
* @returns {sap.ui.core.BusyIndicator} this
to allow method chaining
*/
public static attachOpen(fnFunction: Function, oListener?: any): sap.ui.core.BusyIndicator;
/**
* Unregisters a handler for the "close" event
* @param {Function} fnFunction - The callback function to unregister
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.BusyIndicator} this
to allow method chaining
*/
public static detachClose(fnFunction: Function, oListener: any): sap.ui.core.BusyIndicator;
/**
* Unregisters a handler for the "open" event
* @param {Function} fnFunction - The callback function to unregister
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.BusyIndicator} this
to allow method chaining
*/
public static detachOpen(fnFunction: Function, oListener: any): sap.ui.core.BusyIndicator;
/**
* Removes the BusyIndicator from the screen
*/
public static hide(): void;
/**
* Displays the BusyIndicator and starts blocking all user input.
* This only happens after some delay and if after that delay the
* BusyIndicator.hide() has not yet been called in the meantime.
* There is a certain default value for the delay, but that one can be
* overridden.
* @param {number} iDelay - The delay in milliseconds before opening the BusyIndicator. It is not opened if hide() is called before end of the delay. If no delay (or no valid delay) is given, the default value is used.
*/
public static show(iDelay?: number): void;
}
/**
*/
namespace BusyIndicatorUtils {
}
/**
* The types of Calendar
*/
export enum CalendarType {
/**
* The Gregorian calendar
*/
Gregorian = "Gregorian",
/**
* The Islamic calendar
*/
Islamic = "Islamic",
/**
* The Japanese emperor calendar
*/
Japanese = "Japanese",
/**
* The Persian Jalali calendar
*/
Persian = "Persian",
}
/**
* Collision behavior: horizontal/vertical.
*
* Defines how the position of an element should be adjusted in case it overflows the window in some direction. For both
* directions this can be "flip", "fit" or "none". If only one behavior is provided it is applied to both directions.
* Examples: "flip", "fit none".
*/
export enum Collision {
Flip = "flip",
FlipFlip = "flip flip",
FlipFit = "flip fit",
FlipNone = "flip none",
Fit = "fit",
FitFlip = "fit flip",
FitFit = "fit fit",
FitNone = "fit none",
None = "none",
NoneFlip = "none flip",
NoneFit = "none fit",
NoneNone = "none none"
}
/**
* Base Class for Component.
*/
export class Component extends sap.ui.base.ManagedObject {
/**
* Callback handler which will be executed once a component instance has
* been created by {#link sap.ui.component}. The component instance and the
* configuration object will be passed into the registered function.
* For async scenarios (vConfig.async = true
) a Promise can be provided as
* return value from the callback handler to delay resolving the Promise
* returned by {@link sap.ui.component}.
* In synchronous scenarios the return value will be ignored.
*
* Example usage:
*
* sap.ui.require(['sap/ui/core/Component'], function(Component) {
* Component._fnOnInstanceCreated = function(oComponent, oConfig) {
* // do some logic with the config
*
* // optionally return a Promise
* return doAsyncStuff();
* };
* });
*
* ATTENTION: This hook must only be used by UI flexibility (library:
* sap.ui.fl) and will be replaced with a more generic solution!
*/
protected static _fnOnInstanceCreated: any;
/**
* Creates and initializes a new Component with the given sId
and
* settings.
*
* The set of allowed entries in the mSettings
object depends on
* the concrete subclass and is described there. See {@link sap.ui.core.Component}
* for a general description of this argument.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
*
* This class does not have its own settings, but all settings applicable to the base type
* {@link sap.ui.base.ManagedObject#constructor sap.ui.base.ManagedObject} can be used.
* @param {string} sId - Optional ID for the new control; generated automatically if no non-empty ID is given. Note: this can be omitted, no matter whether mSettings
are given or not!
* @param {any} mSettings - Optional object with initial settings for the new Component instance
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a nested component that is declared in the sap.ui5/componentUsages
section of
* the descriptor (manifest.json). The following snippet shows the declaration:
*
* {
* [...]
* "sap.ui5": {
* "componentUsages": {
* "myUsage": {
* "name": "my.useful.Component"
* }
* }
* }
* [...]
* }
*
* The syntax of the configuration object of the component usage matches the
* configuration object of the {#link sap.ui.component} factory function.
*
* This is an example of how the createComponent
function can
* be used for asynchronous scenarios:
*
* oComponent.createComponent("myUsage").then(function(oComponent) {
* oComponent.doSomething();
* }).catch(function(oError) {
* jQuery.sap.log.error(oError);
* });
*
*
* The following example shows how createComponent
can be used to create a nested
* component by providing specific properties like id
, async
,
* settings
, or componentData
:
*
* var oComponent = oComponent.createComponent({
* usage: "myUsage",
* id: "myId",
* settings: { ... },
* componentData: { ... }
* });
*
* The allowed list of properties are defined in the parameter documentation
* of this function.
*
* The properties can also be defined in the descriptor. These properties can
* be overwritten by the local properties of that function.
* @param {string|any} vUsage - ID of the component usage or the configuration object that creates the component
* @returns {sap.ui.core.Component|Promise} Component instance or Promise which will be resolved with the component instance (defaults to Promise / asynchronous behavior)
*/
public createComponent(vUsage: string|any): sap.ui.core.Component|Promise;
/**
* Cleans up the Component instance before destruction.
*
* Applications must not call this hook method directly, it is called by the
* framework when the element is {@link #destroy destroyed}.
*
* Subclasses of Component should override this hook to implement any necessary
* cleanup.
*/
protected exit(): void;
/**
* Creates a new subclass of class sap.ui.core.Component with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns user specific data object
* @returns {any} componentData
*/
public getComponentData(): any;
/**
* Returns the event bus of this component.
* @returns {sap.ui.core.EventBus} the event bus
*/
public getEventBus(): sap.ui.core.EventBus;
/**
* @returns {sap.ui.base.Interface}
*/
public getInterface(): sap.ui.base.Interface;
/**
* Returns the manifest defined in the metadata of the component.
* If not specified, the return value is null.
* @returns {any} manifest.
*/
public getManifest(): any;
/**
* Returns the configuration of a manifest section or the value for a
* specific path. If no section or key is specified, the return value is null.
*
* Example:
*
* {
* "sap.ui5": {
* "dependencies": {
* "libs": {
* "sap.m": {}
* },
* "components": {
* "my.component.a": {}
* }
* }
* });
*
*
* The configuration above can be accessed in the following ways:
*
* - By section/namespace:
oComponent.getManifestEntry("sap.ui5")
* - By path:
oComponent.getManifestEntry("/sap.ui5/dependencies/libs")
*
*
* By section/namespace returns the configuration for the specified manifest
* section and by path allows to specify a concrete path to a dedicated entry
* inside the manifest. The path syntax always starts with a slash (/).
* @param {string} sKey - Either the manifest section name (namespace) or a concrete path
* @returns {any|null} Value of the manifest section or the key (could be any kind of value)
*/
public getManifestEntry(sKey: string): any|null;
/**
* Returns the manifest object.
* @returns {sap.ui.core.Manifest} manifest.
*/
public getManifestObject(): sap.ui.core.Manifest;
/**
* Returns the metadata for the specific class of the current instance.
* @returns {sap.ui.base.Metadata} Metadata for the specific class of the current instance.
*/
public getMetadata(): sap.ui.base.Metadata;
/**
* Returns the metadata for the Component class.
* @returns {sap.ui.base.Metadata} Metadata for the Component class.
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the Component instance in whose "context" the given ManagedObject has been created
* or undefined
.
*
* This is a convenience wrapper around {@link sap.ui.core.Component.getOwnerIdFor Component.getOwnerIdFor}.
* If the owner ID cannot be determined for reasons documented on getOwnerForId
* or when the Component for the determined ID no longer exists, undefined
* will be returned.
* @param {sap.ui.base.ManagedObject} oObject - Object to retrieve the owner Component for
* @returns {sap.ui.core.Component} the owner Component or undefined
.
*/
public static getOwnerComponentFor(oObject: sap.ui.base.ManagedObject): sap.ui.core.Component;
/**
* Returns the ID of the object in whose "context" the given ManagedObject has been created.
*
* For objects that are not ManagedObjects or for which the owner is unknown,
* undefined
will be returned as owner ID.
*
* Note: Ownership for objects is only checked by the framework at the time
* when they are created. It is not checked or updated afterwards. And it can only be detected
* while the {@link sap.ui.core.Component#runAsOwner Component.runAsOwner} function is executing.
* Without further action, this is only the case while the content of a UIComponent is
* {@link sap.ui.core.UIComponent#createContent constructed} or when a
* {@link sap.ui.core.routing.Router Router} creates a new View and its content.
*
* Note: This method does not guarantee that the returned owner ID belongs
* to a Component. Currently, it always does. But future versions of UI5 might introduce a
* more fine grained ownership concept, e.g. taking Views into account. Callers that
* want to deal only with components as owners, should use the following method:
* {@link sap.ui.core.Component.getOwnerComponentFor Component.getOwnerComponentFor}.
* It guarantees that the returned object (if any) will be a Component.
*
* Further note that only the ID of the owner is recorded. In rare cases,
* when the lifecycle of a ManagedObject is not bound to the lifecycle of its owner,
* (e.g. by the means of aggregations), then the owner might have been destroyed already
* whereas the ManagedObject is still alive. So even the existence of an owner ID is
* not a guarantee for the existence of the corresponding owner.
* @param {sap.ui.base.ManagedObject} oObject - Object to retrieve the owner ID for
* @returns {string} ID of the owner or undefined
*/
public static getOwnerIdFor(oObject: sap.ui.base.ManagedObject): string;
/**
* Returns a service interface for the {@link sap.ui.core.service.Service Service}
* declared in the descriptor for components (manifest.json). The declaration needs
* to be done in the sap.ui5/services
section as follows:
*
* {
* [...]
* "sap.ui5": {
* "services": {
* "myLocalServiceAlias": {
* "factoryName": "my.ServiceFactory",
* ["optional": true]
* }
* }
* }
* [...]
* }
*
* The service declaration is used to define a mapping between the local
* alias for the service that can be used in the Component and the name of
* the service factory which will be used to create a service instance.
*
* The getService
function will look up the service factory and will
* create a new instance by using the service factory function
* {@link sap.ui.core.service.ServiceFactory#createInstance createInstance}
* The optional property defines that the service is not mandatory and the
* usage will not depend on the availability of this service. When requesting
* an optional service the getService
function will reject but
* there will be no error logged in the console.
*
* When creating a new instance of the service the Component context will be
* passed as oServiceContext
as follows:
*
* {
* "scopeObject": this, // the Component instance
* "scopeType": "component" // the stereotype of the scopeObject
* }
*
*
* The service will be created only once per Component and reused in future
* calls to the getService
function.
*
* This function will return a Promise
which provides the service
* interface when resolved. If the factoryName
could not
* be found in the {@link sap.ui.core.service.ServiceFactoryRegistry Service Factory Registry}
* or the service declaration in the descriptor for components (manifest.json)
* is missing the Promise will reject.
*
* This is an example of how the getService
function can be used:
*
* oComponent.getService("myLocalServiceAlias").then(function(oService) {
* oService.doSomething();
* }).catch(function(oError) {
* jQuery.sap.log.error(oError);
* });
*
* @param {string} sLocalServiceAlias - Local service alias as defined in the manifest.json
* @returns {Promise} Promise which will be resolved with the Service interface
*/
public getService(sLocalServiceAlias: string): Promise;
/**
* Initializes the Component instance after creation.
*
* Applications must not call this hook method directly, it is called by the
* framework while the constructor of a Component is executed.
*
* Subclasses of Component should override this hook to implement any necessary
* initialization.
*/
protected init(): void;
/**
* The hook which gets called when the static configuration of the component
* has been changed by some configuration extension.
* @param {string} sConfigKey - Error message.
*/
public onConfigChange(sConfigKey: string): void;
/**
* The window before unload hook. Override this method in your Component class
* implementation, to handle cleanup before the real unload or to prompt a question
* to the user, if the component should be exited.
* @returns {string} a string if a prompt should be displayed to the user confirming closing the Component (e.g. when the Component is not yet saved).
*/
public onWindowBeforeUnload(): string;
/**
* The window error hook. Override this method in your Component class implementation
* to listen to unhandled errors.
* @param {string} sMessage - The error message.
* @param {string} sFile - File where the error occurred
* @param {number} iLine - Line number of the error
*/
public onWindowError(sMessage: string, sFile: string, iLine: number): void;
/**
* The window unload hook. Override this method in your Component class
* implementation, to handle cleanup of the component once the window
* will be unloaded (e.g. closed).
*/
public onWindowUnload(): void;
/**
* Calls the function fn
once and marks all ManagedObjects
* created during that call as "owned" by this Component.
*
* Nested calls of this method are supported (e.g. inside a newly created,
* nested component). The currently active owner Component will be remembered
* before executing fn
and restored afterwards.
* @param {Function} fn - Function to execute
* @returns {any} result of function fn
*/
public runAsOwner(fn: Function): any;
}
/**
* Component Container
*/
export class ComponentContainer extends sap.ui.core.Control {
/**
* Constructor for a new ComponentContainer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.ComponentContainer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAsync async}.
*
* Flag whether the component should be created sync (default) or async.
* This property can only be applied initially.
*
* Default value is false
.
* @returns {boolean} Value of property async
*/
public getAsync(): boolean;
/**
* Gets current value of property {@link #getAutoPrefixId autoPrefixId}.
*
* Flag, whether to autoprefix the id of the nested Component or not. If
* this property is set to true the ID of the Component will be prefixed
* with the ID of the ComponentContainer followed by a single dash.
* This property can only be applied initially.
*
* Default value is false
.
* @returns {boolean} Value of property autoPrefixId
*/
public getAutoPrefixId(): boolean;
/**
* ID of the element which is the current target of the association {@link #getComponent component}, or null
.
* @returns {sap.ui.core.ID}
*/
public getComponent(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getHandleValidation handleValidation}.
*
* Enable/disable validation handling by MessageManager for this component.
* The resulting Messages will be propagated to the controls.
* This property can only be applied initially.
*
* Default value is false
.
* @returns {boolean} Value of property handleValidation
*/
public getHandleValidation(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* Container height in CSS size
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getLifecycle lifecycle}.
*
* Lifecycle behavior for the Component associated by the ComponentContainer
.
* The default behavior is Legacy
. This means that the ComponentContainer
* takes care that the Component is destroyed when the ComponentContainer
is destroyed,
* but it is not destroyed when a new Component is associated.
* If you use the usage
property to create the Component,
* the default behavior is Container
. This means that
* the Component is destroyed when the ComponentContainer
is destroyed or a new
* Component is associated.
* This property must only be applied before a component instance is created.
*
* Default value is Legacy
.
* @returns {sap.ui.core.ComponentLifecycle} Value of property lifecycle
*/
public getLifecycle(): sap.ui.core.ComponentLifecycle;
/**
* Returns a metadata object for class sap.ui.core.ComponentContainer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* Component name, the package where the component is contained. This property can only be applied initially.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets current value of property {@link #getPropagateModel propagateModel}.
*
* Defines whether binding information is propagated to the component.
*
* Default value is false
.
* @returns {boolean} Value of property propagateModel
*/
public getPropagateModel(): boolean;
/**
* Gets current value of property {@link #getSettings settings}.
*
* The settings object passed to the component when created. This property can only be applied initially.
* @returns {any} Value of property settings
*/
public getSettings(): any;
/**
* Gets current value of property {@link #getUrl url}.
*
* The URL of the component. This property can only be applied initially.
* @returns {sap.ui.core.URI} Value of property url
*/
public getUrl(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getUsage usage}.
*
* The component usage. If the ComponentContainer is used inside a
* Component, this Component can define a usage which will be used for creating
* the Component.
* This property can only be applied initially.
* @returns {string} Value of property usage
*/
public getUsage(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Container width in CSS size
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getAsync async}.
*
* Flag whether the component should be created sync (default) or async.
* This property can only be applied initially.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bAsync - New value for property async
* @returns {sap.ui.core.ComponentContainer} Reference to this
in order to allow method chaining
*/
public setAsync(bAsync: boolean): sap.ui.core.ComponentContainer;
/**
* Sets a new value for property {@link #getAutoPrefixId autoPrefixId}.
*
* Flag, whether to autoprefix the id of the nested Component or not. If
* this property is set to true the ID of the Component will be prefixed
* with the ID of the ComponentContainer followed by a single dash.
* This property can only be applied initially.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bAutoPrefixId - New value for property autoPrefixId
* @returns {sap.ui.core.ComponentContainer} Reference to this
in order to allow method chaining
*/
public setAutoPrefixId(bAutoPrefixId: boolean): sap.ui.core.ComponentContainer;
/**
* Sets the component of the container. Depending on the ComponentContainer's
* lifecycle this might destroy the old associated Component.
*
* Once the component is associated with the container the cross connection
* to the component will be set and the models will be propagated if defined.
* If the usage
property is set the ComponentLifecycle is processed like a "Container" lifecycle.
* @param {string|sap.ui.core.UIComponent} vComponent - ID of an element which becomes the new target of this component association. Alternatively, an element instance may be given.
* @returns {sap.ui.core.ComponentContainer} the reference to this
in order to allow method chaining
*/
public setComponent(vComponent: string|sap.ui.core.UIComponent): sap.ui.core.ComponentContainer;
/**
* Sets a new value for property {@link #getHandleValidation handleValidation}.
*
* Enable/disable validation handling by MessageManager for this component.
* The resulting Messages will be propagated to the controls.
* This property can only be applied initially.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bHandleValidation - New value for property handleValidation
* @returns {sap.ui.core.ComponentContainer} Reference to this
in order to allow method chaining
*/
public setHandleValidation(bHandleValidation: boolean): sap.ui.core.ComponentContainer;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Container height in CSS size
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.core.ComponentContainer} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.core.ComponentContainer;
/**
* Sets a new value for property {@link #getLifecycle lifecycle}.
*
* Lifecycle behavior for the Component associated by the ComponentContainer
.
* The default behavior is Legacy
. This means that the ComponentContainer
* takes care that the Component is destroyed when the ComponentContainer
is destroyed,
* but it is not destroyed when a new Component is associated.
* If you use the usage
property to create the Component,
* the default behavior is Container
. This means that
* the Component is destroyed when the ComponentContainer
is destroyed or a new
* Component is associated.
* This property must only be applied before a component instance is created.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Legacy
.
* @param {sap.ui.core.ComponentLifecycle} sLifecycle - New value for property lifecycle
* @returns {sap.ui.core.ComponentContainer} Reference to this
in order to allow method chaining
*/
public setLifecycle(sLifecycle: sap.ui.core.ComponentLifecycle): sap.ui.core.ComponentContainer;
/**
* Sets a new value for property {@link #getName name}.
*
* Component name, the package where the component is contained. This property can only be applied initially.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.ui.core.ComponentContainer} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.ui.core.ComponentContainer;
/**
* Sets a new value for property {@link #getPropagateModel propagateModel}.
*
* Defines whether binding information is propagated to the component.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bPropagateModel - New value for property propagateModel
* @returns {sap.ui.core.ComponentContainer} Reference to this
in order to allow method chaining
*/
public setPropagateModel(bPropagateModel: boolean): sap.ui.core.ComponentContainer;
/**
* Sets a new value for property {@link #getSettings settings}.
*
* The settings object passed to the component when created. This property can only be applied initially.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oSettings - New value for property settings
* @returns {sap.ui.core.ComponentContainer} Reference to this
in order to allow method chaining
*/
public setSettings(oSettings: any): sap.ui.core.ComponentContainer;
/**
* Sets a new value for property {@link #getUrl url}.
*
* The URL of the component. This property can only be applied initially.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sUrl - New value for property url
* @returns {sap.ui.core.ComponentContainer} Reference to this
in order to allow method chaining
*/
public setUrl(sUrl: sap.ui.core.URI): sap.ui.core.ComponentContainer;
/**
* Sets a new value for property {@link #getUsage usage}.
*
* The component usage. If the ComponentContainer is used inside a
* Component, this Component can define a usage which will be used for creating
* the Component.
* This property can only be applied initially.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sUsage - New value for property usage
* @returns {sap.ui.core.ComponentContainer} Reference to this
in order to allow method chaining
*/
public setUsage(sUsage: string): sap.ui.core.ComponentContainer;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Container width in CSS size
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.core.ComponentContainer} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.core.ComponentContainer;
}
/**
* Enumeration for different lifecycle behaviors of Components created by the
* ComponentContainer.
*/
export enum ComponentLifecycle {
/**
* Application managed lifecycle means that the Application takes care
* to destroy the Components associated with the ComponentContainer.
*/
Application = "Application",
/**
* Container managed lifecycle means that the ComponentContainer takes
* care to destroy the Components associated with the ComponentContainer
* once the ComponentContainer is destroyed or a new Component is associated.
*/
Container = "Container",
/**
* Legacy lifecycle means that the ComponentContainer takes care
* to destroy the Component which is associated with the
* ComponentContainer once the ComponentContainer is destroyed but
* not when a new Component is associated.
*/
Legacy = "Legacy",
}
/**
*/
export class ComponentMetadata {
/**
* Creates a new metadata object for a Component subclass.
* @param {string} sClassName - Fully qualified name of the class that is described by this metadata object
* @param {any} oStaticInfo - Static info to construct the metadata from
*/
public constructor(sClassName: string, oStaticInfo: any);
/**
* Returns the name of the Component (which is the namespace only with the module name)
* @returns {string} Component name
*/
public getComponentName(): string;
/**
* Returns array of components specified in the metadata of the Component.
* If not specified or the array is empty, the return value is null.
*
* Important:
* If a Component is loaded using the manifest URL (or according the
* "manifest first" strategy), this function ignores the entries of the
* manifest file! It returns only the entries which have been defined in
* the Component metadata or in the proper Component manifest.
* @returns {string[]} Required Components.
*/
public getComponents(): string[];
/**
* Returns a copy of the configuration property to disallow modifications.
* If no key is specified it returns the complete configuration property
* @param {string} sKey - Key of the configuration property
* @param {boolean} bDoNotMerge - If set to true
, only the local configuration is returned
* @returns {any} the value of the configuration property
*/
public getConfig(sKey?: string, bDoNotMerge?: boolean): any;
/**
* Returns the custom Component configuration entry with the specified key (this must be a JSON object).
* If no key is specified, the return value is null.
*
* Example:
*
* sap.ui.core.Component.extend("sample.Component", {
* metadata: {
* "my.custom.config" : {
* "property1" : true,
* "property2" : "Something else"
* }
* }
* });
*
*
* The configuration above can be accessed via sample.Component.getMetadata().getCustomEntry("my.custom.config")
.
* @param {string} sKey - Key of the custom configuration (must be prefixed with a namespace)
* @param {boolean} bMerged - Indicates whether the custom configuration is merged with the parent custom configuration of the Component.
* @returns {Object} custom Component configuration with the specified key.
*/
public getCustomEntry(sKey: string, bMerged: boolean): Object;
/**
* Returns the dependencies defined in the metadata of the Component. If not specified, the return value is null.
*
* Important:
* If a Component is loaded using the manifest URL (or according the
* "manifest first" strategy), this function ignores the entries of the
* manifest file! It returns only the entries which have been defined in
* the Component metadata or in the proper Component manifest.
* @returns {Object} Component dependencies.
*/
public getDependencies(): Object;
/**
* Returns the array of the included files that the Component requires such
* as CSS and JavaScript. If not specified or the array is empty, the return
* value is null.
*
* Important:
* If a Component is loaded using the manifest URL (or according the
* "manifest first" strategy), this function ignores the entries of the
* manifest file! It returns only the entries which have been defined in
* the Component metadata or in the proper Component manifest.
* @returns {string[]} Included files.
*/
public getIncludes(): string[];
/**
* Returns array of libraries specified in metadata of the Component, that
* are automatically loaded when an instance of the component is created.
* If not specified or the array is empty, the return value is null.
*
* Important:
* If a Component is loaded using the manifest URL (or according the
* "manifest first" strategy), this function ignores the entries of the
* manifest file! It returns only the entries which have been defined in
* the Component metadata or in the proper Component manifest.
* @returns {string[]} Required libraries.
*/
public getLibs(): string[];
/**
* Returns the manifest defined in the metadata of the Component.
* If not specified, the return value is null.
* @returns {Object} manifest.
*/
public getManifest(): Object;
/**
* Returns the configuration of a manifest section or the value for a
* specific path. If no section or key is specified, the return value is null.
*
* Example:
*
* {
* "sap.ui5": {
* "dependencies": {
* "libs": {
* "sap.m": {}
* },
* "components": {
* "my.component.a": {}
* }
* }
* });
*
*
* The configuration above can be accessed in the following ways:
*
* - By section/namespace:
oComponent.getMetadata().getManifestEntry("sap.ui5")
* - By path:
oComponent.getMetadata().getManifestEntry("/sap.ui5/dependencies/libs")
*
*
* By section/namespace returns the configuration for the specified manifest
* section and by path allows to specify a concrete path to a dedicated entry
* inside the manifest. The path syntax always starts with a slash (/).
* @param {string} sKey - Either the manifest section name (namespace) or a concrete path
* @param {boolean} bMerged - Indicates whether the custom configuration is merged with the parent custom configuration of the Component.
* @returns {any|null} Value of the manifest section or the key (could be any kind of value)
*/
public getManifestEntry(sKey: string, bMerged?: boolean): any|null;
/**
* Returns the manifest object.
* @returns {sap.ui.core.Manifest} manifest.
*/
public getManifestObject(): sap.ui.core.Manifest;
/**
* Returns the version of the metadata which could be 1 or 2. 1 is for legacy
* metadata whereas 2 is for the manifest.
* @returns {number} metadata version (1: legacy metadata, 2: manifest)
*/
protected getMetadataVersion(): number;
/**
* Returns the raw manifest defined in the metadata of the Component.
* If not specified, the return value is null.
* @returns {Object} manifest
*/
public getRawManifest(): Object;
/**
* Returns the required version of SAPUI5 defined in the metadata of the
* Component. If returned value is null, then no special UI5 version is
* required.
*
* Important:
* If a Component is loaded using the manifest URL (or according the
* "manifest first" strategy), this function ignores the entries of the
* manifest file! It returns only the entries which have been defined in
* the Component metadata or in the proper Component manifest.
* @returns {string} Required version of UI5 or if not specified then null.
*/
public getUI5Version(): string;
/**
* Returns the version of the component. If not specified, the return value
* is null.
*
* Important:
* If a Component is loaded using the manifest URL (or according the
* "manifest first" strategy), this function ignores the entries of the
* manifest file! It returns only the entries which have been defined in
* the Component metadata or in the proper Component manifest.
* @returns {string} The version of the component.
*/
public getVersion(): string;
/**
* Returns whether the class of this metadata is a component base class
* or not.
* @returns {boolean} true if it is sap.ui.core.Component or sap.ui.core.UIComponent
*/
protected isBaseClass(): boolean;
}
/**
* Collects and stores the configuration of the current environment.
*
* The Configuration is initialized once when the {@link sap.ui.core.Core} is created.
* There are different ways to set the environment configuration (in ascending priority):
*
* - System defined defaults
*
- Server wide defaults, read from /sap-ui-config.json
*
- Properties of the global configuration object window["sap-ui-config"]
*
- A configuration string in the data-sap-ui-config attribute of the bootstrap tag
*
- Individual data-sap-ui-xyz attributes of the bootstrap tag
*
- Using URL parameters
*
- Setters in this Configuration object (only for some parameters)
*
*
* That is, attributes of the DOM reference override the system defaults, URL parameters
* override the DOM attributes (where empty URL parameters set the parameter back to its
* system default). Calling setters at runtime will override any previous settings
* calculated during object creation.
*
* The naming convention for parameters is:
*
* - in the URL : sap-ui-PARAMETER-NAME="value"
*
- in the DOM : data-sap-ui-PARAMETER-NAME="value"
*
* where PARAMETER-NAME is the name of the parameter in lower case.
*
* Values of boolean parameters are case insensitive where "true" and "x" are interpreted as true.
*/
export class Configuration extends sap.ui.base.Object {
/**
* Creates a new Configuration object.
*/
public constructor();
/**
* Applies multiple changes to the configuration at once.
*
* If the changed settings contain localization related settings like language
* or calendarType
, then only a single localizationChanged
event will
* be fired. As the framework has to inform all existing components, elements, models etc.
* about localization changes, using applySettings
can significantly reduce the
* overhead for multiple changes, esp. when they occur after the UI has been created already.
*
* The mSettings
can contain any property xyz
for which a
* setter method setXYZ
exists in the API of this class.
* Similarly, values for the {@link sap.ui.core.Configuration.FormatSettings format settings}
* API can be provided in a nested object with name formatSettings
.
* @param {any} mSettings - Configuration options to apply
* @returns {sap.ui.core.Configuration} Returns this
to allow method chaining
*/
public applySettings(mSettings: any): sap.ui.core.Configuration;
/**
* Creates a new subclass of class sap.ui.core.Configuration with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns whether the accessibility mode is used or not.
* @returns {boolean} whether the accessibility mode is used or not
*/
public getAccessibility(): boolean;
/**
* Returns whether the animations are globally used.
* @returns {boolean} whether the animations are globally used
*/
public getAnimation(): boolean;
/**
* Base URLs to AppCacheBuster ETag-Index files.
* @returns {string[]} array of base URLs
*/
public getAppCacheBuster(): string[];
/**
* Object defining the callback hooks for the AppCacheBuster like e.g.
* handleURL
, onIndexLoad
or onIndexLoaded
.
* @returns {any} object containing the callback functions for the AppCacheBuster
*/
protected getAppCacheBusterHooks(): any;
/**
* The loading mode (sync|async|batch) of the AppCacheBuster (sync is default)
* @returns {string} "sync" | "async"
*/
public getAppCacheBusterMode(): string;
/**
* The name of the application to start or empty.
* @returns {string} name of the application
*/
public getApplication(): string;
/**
* Returns whether the framework automatically adds automatically
* the ARIA role 'application' to the HTML body or not.
* @returns {boolean}
*/
public getAutoAriaBodyRole(): boolean;
/**
* Returns the used compatibility version for the given feature.
* @param {string} sFeature - the key of desired feature
* @returns {typeof jQuery.sap.Version} the used compatibility version
*/
public getCompatibilityVersion(sFeature: string): typeof jQuery.sap.Version;
/**
* Return whether the controller code is deactivated. During design mode the.
* @returns {boolean} whether the activation of the controller code is suppressed or not
*/
protected getControllerCodeDeactivated(): boolean;
/**
* Returns whether the page runs in debug mode.
* @returns {boolean} whether the page runs in debug mode
*/
public getDebug(): boolean;
/**
* Return whether the design mode is active or not.
* @returns {boolean} whether the design mode is active or not.
*/
protected getDesignMode(): boolean;
/**
* Flag, whether the customizing is disabled or not.
* @returns {boolean} true if customizing is disabled
*/
protected getDisableCustomizing(): boolean;
/**
* Returns whether the Fiori2Adaptation is on.
* @returns {boolean|string} false - no adaptation, true - full adaptation, comma-separated list - partial adaptation Possible values: style, collapse, title, back, hierarchy
*/
public getFiori2Adaptation(): boolean|string;
/**
* Returns the format locale string with language and region code. Falls back to
* language configuration, in case it has not been explicitly defined.
* @returns {string} the format locale string with language and country code
*/
public getFormatLocale(): string;
/**
* Returns a configuration object that bundles the format settings of UI5.
* @returns {sap.ui.core.Configuration.FormatSettings} A FormatSettings object.
*/
public getFormatSettings(): sap.ui.core.Configuration.FormatSettings;
/**
* frameOptions mode (allow/deny/trusted).
* @returns {string} frameOptions mode
*/
public getFrameOptions(): string;
/**
* Returns whether the UI5 control inspector is displayed.
* Has only an effect when the sap-ui-debug module has been loaded
* @returns {boolean} whether the UI5 control inspector is displayed
*/
public getInspect(): boolean;
/**
* Returns a string that identifies the current language.
*
* The value returned by this methods in most cases corresponds to the exact value that has been
* configured by the user or application or that has been determined from the user agent settings.
* It has not been normalized, but has been validated against a relaxed version of
* {@link http://www.ietf.org/rfc/bcp/bcp47.txt BCP47}, allowing underscores ('_') instead of the
* suggested dashes ('-') and not taking the case of letters into account.
*
* The exceptions mentioned above affect languages that have been specified via the URL parameter
* sap-language
. That parameter by definition represents an SAP logon language code
* ('ABAP language'). Most but not all of these language codes are valid ISO639 two-letter languages
* and as such are valid BCP47 language tags. For better BCP47 compliance, the framework
* maps the following non-BCP47 SAP logon codes to a BCP47 substitute:
*
* "ZH" --> "zh-Hans" // script 'Hans' added to distinguish it from zh-Hant
* "ZF" --> "zh-Hant" // ZF is not a valid ISO639 code, use the compliant language + script 'Hant'
* " "1Q" --> "en-US-x-saptrc" // special language code for supportability (tracing),
* represented as en-US with a private extension
* "2Q" --> "en-US-x-sappsd" // special language code for supportability (pseudo translation),
* represented as en-US with a private extension
*
*
* For a normalized BCP47 tag, call {@link #getLanguageTag} or call {@link getLocale} to get a
* {@link sap.ui.core.Locale Locale} object matching the language.
* @returns {string} Language string as configured
*/
public getLanguage(): string;
/**
* Returns a BCP47-compliant language tag for the current language.
*
* The return value of this method is especially useful for an HTTP Accept
header.
* @returns {string} The language tag for the current language, conforming to BCP47
*/
public getLanguageTag(): string;
/**
* Returns a Locale object for the current language.
*
* The Locale is derived from the {@link #getLanguage language} property.
* @returns {sap.ui.core.Locale} The locale
*/
public getLocale(): sap.ui.core.Locale;
/**
* Flag whether a Component should load the manifest first.
* @returns {boolean} true if a Component should load the manifest first
*/
public getManifestFirst(): boolean;
/**
* Returns a metadata object for class sap.ui.core.Configuration.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns whether there should be an exception on any duplicate element IDs.
* @returns {boolean} whether there should be an exception on any duplicate element IDs
*/
public getNoDuplicateIds(): boolean;
/**
* Returns whether the text origin information is collected.
* @returns {boolean} whether the text info is collected
*/
public getOriginInfo(): boolean;
/**
* The name of the root component to start or empty.
* @returns {string} name of the root component
*/
public getRootComponent(): string;
/**
* Returns whether the page uses the RTL text direction.
*
* If no mode has been explicitly set (neither true nor false),
* the mode is derived from the current language setting.
* @returns {boolean} whether the page uses the RTL text direction
*/
public getRTL(): boolean;
/**
* Returns an SAP logon language for the current language.
* @returns {string} The SAP logon language code for the current language
*/
public getSAPLogonLanguage(): string;
/**
* Return whether the activation of the controller code is suppressed.
* @returns {boolean} whether the activation of the controller code is suppressed or not
*/
protected getSuppressDeactivationOfControllerCode(): boolean;
/**
* Returns the theme name
* @returns {string} the theme name
*/
public getTheme(): string;
/**
* Prefix to be used for automatically generated control IDs.
* Default is a double underscore "__".
* @returns {string} the prefix to be used
*/
public getUIDPrefix(): string;
/**
* Returns the version of the framework.
*
* Similar to sap.ui.version
.
* @returns {typeof jQuery.sap.Version} the version
*/
public getVersion(): typeof jQuery.sap.Version;
/**
* URL of the whitelist service.
* @returns {string} whitelist service URL
*/
public getWhitelistService(): string;
/**
* Sets the new calendar type to be used from now on in locale dependent functionalities (for example,
* formatting, translation texts, etc.).
* @param {sap.ui.core.CalendarType|null} sCalendarType - the new calendar type. Set it with null to clear the calendar type and the calendar type is calculated based on the format settings and current locale.
* @returns {sap.ui.core.Configuration} this
to allow method chaining
*/
public setCalendarType(sCalendarType: sap.ui.core.CalendarType|null): sap.ui.core.Configuration;
/**
* Sets a new format locale to be used from now on for retrieving locale
* specific formatters. Modifying this setting does not have an impact on
* the retrieval of translated texts!
*
* Can either be set to a concrete value (a BCP47 or Java locale compliant
* language tag) or to null
. When set to null
(default
* value) then locale specific formatters are retrieved for the current language.
*
* After changing the format locale, the framework tries to update localization
* specific parts of the UI. See the documentation of {@link #setLanguage} for
* details and restrictions.
*
* Note: When a format locale is set, it has higher priority than a number,
* date or time format defined with a call to setLegacyNumberFormat
,
* setLegacyDateFormat
or setLegacyTimeFormat.
*
* Note: See documentation of {@link #setLanguage} for restrictions.
* @param {string|null} sFormatLocale - the new format locale as a BCP47 compliant language tag; case doesn't matter and underscores can be used instead of dashes to separate components (compatibility with Java Locale IDs)
* @returns {sap.ui.core.Configuration} this
to allow method chaining
*/
public setFormatLocale(sFormatLocale: string|null): sap.ui.core.Configuration;
/**
* Sets a new language to be used from now on for language/region dependent
* functionality (e.g. formatting, data types, translated texts, ...).
*
* When the language can't be interpreted as a BCP47 language (using the relaxed syntax
* described in {@link #getLanguage}, an error will be thrown.
*
* When the language has changed, the Core will fire its
* {@link sap.ui.core.Core#event:localizationChanged localizationChanged} event.
*
*
* Restrictions
*
* The framework does not guarantee that already created, language
* dependent objects will be updated by this call. It therefore remains best practice
* for applications to switch the language early, e.g. before any language dependent
* objects are created. Applications that need to support more dynamic changes of
* the language should listen to the localizationChanged
event and adapt
* all language dependent objects that they use (e.g. by rebuilding their UI).
*
* Currently, the framework notifies the following objects about a change of the
* localization settings before it fires the localizationChanged
event:
*
*
* - date and number data types that are used in property bindings or composite
* bindings in existing Elements, Controls, UIAreas or Components
* - ResourceModels currently assigned to the Core, a UIArea, Component,
* Element or Control
* - Elements or Controls that implement the
onlocalizationChanged
hook
* (note the lowercase 'l' in onlocalizationChanged)
*
*
* It furthermore derives the RTL mode from the new language, if no explicit RTL
* mode has been set. If the RTL mode changes, the following additional actions will be taken:
*
*
* - the URLs of already loaded library theme files will be changed
* - the
dir
attribute of the page will be changed to reflect the new mode.
* - all UIAreas will be invalidated (which results in a rendering of the whole UI5 UI)
*
*
* This method does not accept SAP language codes for sLanguage
. Instead, a second
* parameter sSAPLogonLanguage
can be provided with an SAP language code corresponding
* to the given language. A given value will be returned by the {@link #getSAPLogonLanguage} method.
* It is up to the caller to provide a consistent pair of BCP47 language and SAP language code.
* The SAP language code is only checked to be of length 2 and must consist of letters or digits only.
*
* Note: When using this method please take note of and respect the above mentioned restrictions.
* @param {string} sLanguage - the new language as a BCP47 compliant language tag; case doesn't matter and underscores can be used instead of dashes to separate components (compatibility with Java Locale IDs)
* @param {string} sSAPLogonLanguage - SAP language code that corresponds to the sLanguage
; if a value is specified, future calls to getSAPLogonLanguage
will return that value; if no value is specified, the framework will use the ISO639 language part of sLanguage
as SAP Logon language.
* @returns {sap.ui.core.Configuration} this
to allow method chaining
*/
public setLanguage(sLanguage: string, sSAPLogonLanguage?: string): sap.ui.core.Configuration;
/**
* Sets the character orientation mode to be used from now on.
*
* Can either be set to a concrete value (true meaning right-to-left,
* false meaning left-to-right) or to null
which means that
* the character orientation mode should be derived from the current
* language (incl. region) setting.
*
* After changing the character orientation mode, the framework tries
* to update localization specific parts of the UI. See the documentation of
* {@link #setLanguage} for details and restrictions.
*
* Note: See documentation of {@link #setLanguage} for restrictions.
* @param {boolean|null} bRTL - new character orientation mode or null
* @returns {sap.ui.core.Configuration} this
to allow method chaining
*/
public setRTL(bRTL: boolean|null): sap.ui.core.Configuration;
}
namespace Configuration {
/**
* Encapsulates configuration settings that are related to data formatting/parsing.
*
* Note: When format configuration settings are modified through this class,
* UI5 only ensures that formatter objects created after that point in time will honor
* the modifications. To be on the safe side, applications should do any modifications
* early in their lifecycle or recreate any model/UI that is locale dependent.
*/
export class FormatSettings extends sap.ui.base.Object {
/**
*/
public constructor();
/**
* Creates a new subclass of class sap.ui.core.Configuration.FormatSettings with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the currently set date pattern or undefined if no pattern has been defined.
* @returns {any}
*/
public getDatePattern(): any;
/**
* Returns the locale to be used for formatting.
*
* If no such locale has been defined, this method falls back to the language,
* see {@link sap.ui.core.Configuration#getLanguage Configuration.getLanguage()}.
*
* If any user preferences for date, time or number formatting have been set,
* and if no format locale has been specified, then a special private use subtag
* is added to the locale, indicating to the framework that these user preferences
* should be applied.
* @returns {sap.ui.core.Locale} the format locale
*/
public getFormatLocale(): sap.ui.core.Locale;
/**
* Returns the currently set customizing data for Islamic calendar support
* @returns {any[]} Returns an array contains the customizing data. Each element in the array has properties: dateFormat, islamicMonthStart, gregDate. For details, please see {@link #setLegacyDateCalendarCustomizing}
*/
public getLegacyDateCalendarCustomizing(): any[];
/**
* Returns the currently set legacy ABAP date format (its id) or undefined if none has been set.
* @returns {any}
*/
public getLegacyDateFormat(): any;
/**
* Returns the currently set legacy ABAP number format (its id) or undefined if none has been set.
* @returns {any}
*/
public getLegacyNumberFormat(): any;
/**
* Returns the currently set legacy ABAP time format (its id) or undefined if none has been set.
* @returns {any}
*/
public getLegacyTimeFormat(): any;
/**
* Returns a metadata object for class sap.ui.core.Configuration.FormatSettings.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the currently set number symbol of the given type or undefined if no symbol has been defined.
* @returns {any}
*/
public getNumberSymbol(): any;
/**
* Returns the currently set time pattern or undefined if no pattern has been defined.
* @returns {any}
*/
public getTimePattern(): any;
/**
* Defines the preferred format pattern for the given date format style.
*
* Calling this method with a null or undefined pattern removes a previously set pattern.
*
* If a pattern is defined, it will be preferred over patterns derived from the current locale.
*
* See class {@link sap.ui.core.format.DateFormat} for details about the pattern syntax.
*
* After changing the date pattern, the framework tries to update localization
* specific parts of the UI. See the documentation of {@link sap.ui.core.Configuration#setLanguage}
* for details and restrictions.
* @param {string} sStyle - must be one of short, medium, long or full.
* @param {string} sPattern - the format pattern to be used in LDML syntax.
* @returns {sap.ui.core.Configuration.FormatSettings} Returns this
to allow method chaining
*/
public setDatePattern(sStyle: string, sPattern: string): sap.ui.core.Configuration.FormatSettings;
/**
* Defines the day used as the first day of the week.
*
* The day is set as an integer value between 0 (Sunday) and 6 (Saturday).
* Calling this method with a null or undefined symbol removes a previously set value.
*
* If a value is defined, it will be preferred over values derived from the current locale.
*
* Usually in the US the week starts on Sunday while in most European countries on Monday.
* There are special cases where you want to have the first day of week set independent of the
* user locale.
*
* After changing the first day of week, the framework tries to update localization
* specific parts of the UI. See the documentation of {@link sap.ui.core.Configuration#setLanguage}
* for details and restrictions.
* @param {number} iValue - must be an integer value between 0 and 6
* @returns {sap.ui.core.Configuration.FormatSettings} Returns this
to allow method chaining
*/
public setFirstDayOfWeek(iValue: number): sap.ui.core.Configuration.FormatSettings;
/**
* Allows to specify the customizing data for Islamic calendar support
* @param {any[]} aMappings - contains the customizing data for the support of Islamic calendar.
* @returns {sap.ui.core.Configuration.FormatSettings} Returns this
to allow method chaining
*/
public setLegacyDateCalendarCustomizing(aMappings: any[]): sap.ui.core.Configuration.FormatSettings;
/**
* Allows to specify one of the legacy ABAP date formats.
*
* This method modifies the date patterns for 'short' and 'medium' style with the corresponding ABAP
* format. When called with a null or undefined format id, any previously applied format will be removed.
*
* After changing the legacy date format, the framework tries to update localization
* specific parts of the UI. See the documentation of {@link sap.ui.core.Configuration#setLanguage}
* for details and restrictions.
*
* Note: Iranian date format 'C' is NOT yet supported by UI5. It's accepted by this method for convenience
* (user settings from ABAP system can be used without filtering), but it's ignored. Instead, the formats
* from the current format locale will be used and a warning will be logged.
* @param {string} sFormatId - id of the ABAP data format (one of '1','2','3','4','5','6','7','8','9','A','B','C')
* @returns {sap.ui.core.Configuration.FormatSettings} Returns this
to allow method chaining
*/
public setLegacyDateFormat(sFormatId: string): sap.ui.core.Configuration.FormatSettings;
/**
* Allows to specify one of the legacy ABAP number format.
*
* This method will modify the 'group' and 'decimal' symbols. When called with a null
* or undefined format id, any previously applied format will be removed.
*
* After changing the legacy number format, the framework tries to update localization
* specific parts of the UI. See the documentation of {@link sap.ui.core.Configuration#setLanguage}
* for details and restrictions.
* @param {string} sFormatId - id of the ABAP number format set (one of ' ','X','Y')
* @returns {sap.ui.core.Configuration.FormatSettings} Returns this
to allow method chaining
*/
public setLegacyNumberFormat(sFormatId: string): sap.ui.core.Configuration.FormatSettings;
/**
* Allows to specify one of the legacy ABAP time formats.
*
* This method sets the time patterns for 'short' and 'medium' style to the corresponding ABAP
* formats and sets the day period texts to "AM"/"PM" or "am"/"pm" respectively. When called
* with a null or undefined format id, any previously applied format will be removed.
*
* After changing the legacy time format, the framework tries to update localization
* specific parts of the UI. See the documentation of {@link sap.ui.core.Configuration#setLanguage}
* for details and restrictions.
* @param {string} sFormatId - id of the ABAP time format (one of '0','1','2','3','4')
* @returns {sap.ui.core.Configuration.FormatSettings} Returns this
to allow method chaining
*/
public setLegacyTimeFormat(sFormatId: string): sap.ui.core.Configuration.FormatSettings;
/**
* Defines the string to be used for the given number symbol.
*
* Calling this method with a null or undefined symbol removes a previously set symbol string.
* Note that an empty string is explicitly allowed.
*
* If a symbol is defined, it will be preferred over symbols derived from the current locale.
*
* See class {@link sap.ui.core.format.NumberFormat} for details about the symbols.
*
* After changing the number symbol, the framework tries to update localization
* specific parts of the UI. See the documentation of {@link sap.ui.core.Configuration#setLanguage}
* for details and restrictions.
* @param {string} sStyle - must be one of decimal, group, plusSign, minusSign.
* @param {string} sSymbol - will be used to represent the given symbol type
* @returns {sap.ui.core.Configuration.FormatSettings} Returns this
to allow method chaining
*/
public setNumberSymbol(sStyle: string, sSymbol: string): sap.ui.core.Configuration.FormatSettings;
/**
* Defines the preferred format pattern for the given time format style.
*
* Calling this method with a null or undefined pattern removes a previously set pattern.
*
* If a pattern is defined, it will be preferred over patterns derived from the current locale.
*
* See class {@link sap.ui.core.format.DateFormat} for details about the pattern syntax.
*
* After changing the time pattern, the framework tries to update localization
* specific parts of the UI. See the documentation of {@link sap.ui.core.Configuration#setLanguage}
* for details and restrictions.
* @param {string} sStyle - must be one of short, medium, long or full.
* @param {string} sPattern - the format pattern to be used in LDML syntax.
* @returns {sap.ui.core.Configuration.FormatSettings} Returns this
to allow method chaining
*/
public setTimePattern(sStyle: string, sPattern: string): sap.ui.core.Configuration.FormatSettings;
}
}
/**
* Base Class for Controls.
*/
export class Control extends sap.ui.core.Element {
/**
* Creates and initializes a new control with the given sId
and settings.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Optional ID for the new control; generated automatically if no non-empty ID is given Note: this can be omitted, no matter whether mSettings
will be given or not!
* @param {any} mSettings - Object with initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* The string given as "sStyleClass" will be added to the "class" attribute of this control's root HTML element.
*
* This method is intended to be used to mark controls as being of a special type for which
* special styling can be provided using CSS selectors that reference this style class name.
*
*
* Example:
* myButton.addStyleClass("myRedTextButton"); // add a CSS class to one button instance
*
* ...and in CSS:
* .myRedTextButton {
* color: red;
* }
*
*
* This will add the CSS class "myRedTextButton" to the Button HTML and the CSS code above will then
* make the text in this particular button red.
*
* Only characters allowed inside HTML attributes are allowed.
* Quotes are not allowed and this method will ignore any strings containing quotes.
* Strings containing spaces are interpreted as multiple custom style classes which are split by space and can be removed
* individually later by calling removeStyleClass.
* Multiple calls with the same sStyleClass will have no different effect than calling once.
* If sStyleClass is null, empty string or it contains quotes, the call is ignored.
* @param {string} sStyleClass - the CSS class name to be added
* @returns {sap.ui.core.Control} Returns this
to allow method chaining
*/
public addStyleClass(sStyleClass: string): sap.ui.core.Control;
/**
* Defines whether the user can select text inside this control.
* Defaults to true
as long as this method has not been called.
*
* Note:This only works in IE and Safari; for Firefox the element's style must
* be set to:
*
* -moz-user-select: none;
*
* in order to prevent text selection.
* @param {boolean} bAllow - whether to allow text selection or not
* @returns {sap.ui.core.Control} Returns this
to allow method chaining
*/
public allowTextSelection(bAllow: boolean): sap.ui.core.Control;
/**
* Allows binding handlers for any native browser event to the root HTML element of this Control. This internally handles
* DOM element replacements caused by re-rendering.
*
* IMPORTANT:
* This should be only used as FALLBACK when the Control events do not cover a specific use-case! Always try using
* SAPUI5 control events, as e.g. accessibility-related functionality is then provided automatically.
* E.g. when working with a sap.ui.commons.Button
, always use the Button's "press" event, not the native "click" event, because
* "press" is also guaranteed to be fired when certain keyboard activity is supposed to trigger the Button.
*
* In the event handler, this
refers to the Control - not to the root DOM element like in jQuery. While the DOM element can
* be used and modified, the general caveats for working with SAPUI5 control DOM elements apply. In particular the DOM element
* may be destroyed and replaced by a new one at any time, so modifications that are required to have permanent effect may not
* be done. E.g. use {@link sap.ui.core.Control.prototype.addStyleClass} instead if the modification is of visual nature.
*
* Use {@link #detachBrowserEvent} to remove the event handler(s) again.
* @param {string} sEventType - A string containing one or more JavaScript event types, such as "click" or "blur".
* @param {Function} fnHandler - A function to execute each time the event is triggered.
* @param {any} oListener - The object, that wants to be notified, when the event occurs
* @returns {sap.ui.core.Control} Returns this
to allow method chaining
*/
public attachBrowserEvent(sEventType?: string, fnHandler?: Function, oListener?: any): sap.ui.core.Control;
/**
* Attaches event handler fnFunction
to the {@link #event:validateFieldGroup validateFieldGroup} event of this sap.ui.core.Control
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.Control
itself.
*
* Event is fired if a logical field group defined by fieldGroupIds
of a control was left or the user explicitly pressed a validation key combination.
* Use this event to validate data of the controls belonging to a field group.
* See {@link sap.ui.core.Control#setFieldGroupIds}.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.Control
itself
* @returns {sap.ui.core.Control} Reference to this
in order to allow method chaining
*/
public attachValidateFieldGroup(fnFunction: Function, oListener?: any): sap.ui.core.Control;
/**
* Attaches event handler fnFunction
to the {@link #event:validateFieldGroup validateFieldGroup} event of this sap.ui.core.Control
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.Control
itself.
*
* Event is fired if a logical field group defined by fieldGroupIds
of a control was left or the user explicitly pressed a validation key combination.
* Use this event to validate data of the controls belonging to a field group.
* See {@link sap.ui.core.Control#setFieldGroupIds}.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.Control
itself
* @returns {sap.ui.core.Control} Reference to this
in order to allow method chaining
*/
public attachValidateFieldGroup(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.Control;
/**
* Returns whether the control has a given field group.
* If vFieldGroupIds
is not given it checks whether at least one field group ID is given for this control.
* If vFieldGroupIds
is an empty array or empty string, true is returned if there is no field group ID set for this control.
* If vFieldGroupIds
is a string array or a string all expected field group IDs are checked and true is returned if all are contained for given for this control.
* The comma delimiter can be used to separate multiple field group IDs in one string.
* @param {string|string[]} vFieldGroupIds - ID of the field group or an array of field group IDs to match
* @returns {boolean} true if a field group ID matches
*/
public checkFieldGroupIds(vFieldGroupIds?: string|string[]): boolean;
/**
* Overrides {@link sap.ui.core.Element#clone Element.clone} to clone additional
* internal state.
*
* The additionally cloned information contains:
*
* - browser event handlers attached with {@link #attachBrowserEvent}
*
- text selection behavior
*
- style classes added with {@link #addStyleClass}
*
* @param {string} sIdSuffix - a suffix to be appended to the cloned element id
* @param {string[]} aLocalIds - an array of local IDs within the cloned hierarchy (internally used)
* @returns {sap.ui.core.Element} reference to the newly created clone
*/
protected clone(sIdSuffix?: string, aLocalIds?: string[]): sap.ui.core.Element;
/**
* Removes event handlers which have been previously attached using {@link #attachBrowserEvent}.
*
* Note: listeners are only removed, if the same combination of event type, callback function
* and context object is given as in the call to attachBrowserEvent
.
* @param {string} sEventType - A string containing one or more JavaScript event types, such as "click" or "blur".
* @param {Function} fnHandler - The function that is to be no longer executed.
* @param {any} oListener - The context object that was given in the call to attachBrowserEvent
.
*/
public detachBrowserEvent(sEventType?: string, fnHandler?: Function, oListener?: any): void;
/**
* Detaches event handler fnFunction
from the {@link #event:validateFieldGroup validateFieldGroup} event of this sap.ui.core.Control
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.core.Control} Reference to this
in order to allow method chaining
*/
public detachValidateFieldGroup(fnFunction: Function, oListener: any): sap.ui.core.Control;
/**
* Creates a new subclass of class sap.ui.core.Control with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:validateFieldGroup validateFieldGroup} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.core.Control} Reference to this
in order to allow method chaining
*/
protected fireValidateFieldGroup(mParameters?: any): sap.ui.core.Control;
/**
* This function (if available on the concrete control) provides
* the current accessibility state of the control.
*
* Applications must not call this hook method directly, it is called by the framework.
*
* Subclasses of Control should implement this hook to provide any necessary accessibility information:
*
*
* MyControl.prototype.getAccessibilityInfo = function() {
* return {
* role: "textbox", // String which represents the WAI-ARIA role which is implemented by the control.
* type: "date input", // String which represents the control type (Must be a translated text). Might correlate with
* // the role.
* description: "value", // String which describes the most relevant control state (e.g. the inputs value). Must be a
* // translated text.
* // Note: The type and the enabled/editable state must not be handled here.
* focusable: true, // Boolean which describes whether the control can get the focus.
* enabled: true, // Boolean which describes whether the control is enabled. If not relevant it must not be set or
* // null
can be provided.
* editable: true, // Boolean which describes whether the control is editable. If not relevant it must not be set or
* // null
can be provided.
* children: [] // Aggregations of the given control (e.g. when the control is a layout). Primitive aggregations will be ignored.
* // Note: Children should only be provided when it is helpful to understand the accessibility context
* // (e.g. a form control must not provide details of its internals (fields, labels, ...) but a
* // layout should).
* };
* };
*
*
* Note: The returned object provides the accessibility state of the control at the point in time when this function is called.
* @returns {any} Current accessibility state of the control.
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getBusy busy}.
*
* Whether the control is currently in busy state.
*
* Default value is false
.
* @returns {boolean} Value of property busy
*/
public getBusy(): boolean;
/**
* Gets current value of property {@link #getBusyIndicatorDelay busyIndicatorDelay}.
*
* The delay in milliseconds, after which the busy indicator will show up for this control.
*
* Default value is 1000
.
* @returns {number} Value of property busyIndicatorDelay
*/
public getBusyIndicatorDelay(): number;
/**
* Returns a list of all child controls with a field group ID.
* See {@link #checkFieldGroupIds checkFieldGroupIds} for a description of the
* vFieldGroupIds
parameter.
* Associated controls are not taken into account.
* @param {string|string[]} vFieldGroupIds - ID of the field group or an array of field group IDs to match
* @returns {sap.ui.core.Control[]} The list of controls with a field group ID
*/
public getControlsByFieldGroupId(vFieldGroupIds?: string|string[]): sap.ui.core.Control[];
/**
* Returns a copy of the field group IDs array. Modification of the field group IDs
* need to call {@link #setFieldGroupIds setFieldGroupIds} to apply the changes.
* @returns {string[]} copy of the field group IDs
*/
public getFieldGroupIds(): string[];
/**
* Returns the DOMNode Id to be used for the "labelFor" attribute of the label.
*
* By default, this is the Id of the control itself.
* @returns {string} Id to be used for the labelFor
*/
public getIdForLabel(): string;
/**
* Returns a metadata object for class sap.ui.core.Control.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns a renderer for this control instance.
*
* It is retrieved using the RenderManager as done during rendering.
* @returns {any} a Renderer suitable for this Control instance.
*/
protected getRenderer(): any;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Whether the control should be visible on the screen. If set to false, a placeholder is rendered instead of the real control
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Returns true if the given style class or all multiple style classes which are generated by splitting the given string with space are already set on the control
* via previous call(s) to addStyleClass().
* @param {string} sStyleClass - the style to check for
* @returns {boolean}
*/
public hasStyleClass(sStyleClass: string): boolean;
/**
* Triggers rerendering of this element and its children.
*
* As sap.ui.core.Element
"bubbles up" the invalidate, changes to children
* potentially result in rerendering of the whole sub tree.
*
* The oOrigin
parameter was introduced to allow parent controls to limit
* their rerendering to certain areas that have been invalidated by their children.
* As there is no strong guideline for control developers to provide the parameter, it is
* not a reliable source of information. It is therefore not recommended in general to use
* it, only in scenarios where a control and its descendants know each other very well
* (e.g. complex controls where parent and children have the same code owner).
* @param {sap.ui.base.ManagedObject} oOrigin - Child control for which the method was called
*/
protected invalidate(oOrigin?: sap.ui.base.ManagedObject): void;
/**
* Check if the control is currently in busy state.
* @returns {any} boolean
*/
public isBusy(): any;
/**
* Function is called when the rendering of the control is completed.
*
* Applications must not call this hook method directly, it is called by the framework.
*
* Subclasses of Control should override this hook to implement any necessary actions after the rendering.
*/
protected onAfterRendering(): void;
/**
* Function is called before the rendering of the control is started.
*
* Applications must not call this hook method directly, it is called by the framework.
*
* Subclasses of Control should override this hook to implement any necessary actions before the rendering.
*/
protected onBeforeRendering(): void;
/**
* Puts this
control into the specified container (oRef
) at the given
* position (oPosition
).
*
* First it is checked whether oRef
is a container element / control (has a
* multiple aggregation with type sap.ui.core.Control
and name 'content') or is an Id String
* of such a container.
* If this is not the case oRef
can either be a Dom Reference or Id String of the UIArea
* (if it does not yet exist implicitly a new UIArea is created),
*
* The oPosition
can be one of the following:
*
*
* - "first": The control is added as the first element to the container.
* - "last": The control is added as the last element to the container (default).
* - "only": All existing children of the container are removed (not destroyed!) and the control is added as new child.
* - index: The control is added at the specified index to the container.
*
* @param {string|Element|sap.ui.core.Control} oRef - container into which the control should be put
* @param {string|number} vPosition - Describes the position where the control should be put into the container
* @returns {sap.ui.core.Control} Returns this
to allow method chaining
*/
public placeAt(oRef: string|Element|sap.ui.core.Control, vPosition?: string|number): sap.ui.core.Control;
/**
* Removes the given string from the list of custom style classes that have been set previously.
* Regular style classes like "sapUiBtn" cannot be removed.
* @param {string} sStyleClass - the style to be removed
* @returns {sap.ui.core.Control} Returns this
to allow method chaining
*/
public removeStyleClass(sStyleClass: string): sap.ui.core.Control;
/**
* Tries to replace its DOM reference by re-rendering.
*/
protected rerender(): void;
/**
* Set the controls busy state.
* @param {boolean} bBusy - The new busy state to be set
* @returns {sap.ui.core.Control} this
to allow method chaining
*/
public setBusy(bBusy: boolean): sap.ui.core.Control;
/**
* Define the delay, after which the busy indicator will show up.
* @param {number} iDelay - The delay in ms
* @returns {sap.ui.core.Control} this
to allow method chaining
*/
public setBusyIndicatorDelay(iDelay: number): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getFieldGroupIds fieldGroupIds}.
*
* The IDs of a logical field group that this control belongs to. All fields in a logical field group should share the same fieldGroupId
.
* Once a logical field group is left, the validateFieldGroup event is raised.
*
* See {@link sap.ui.core.Control#attachValidateFieldGroup}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is []
.
* @param {string[]} sFieldGroupIds - New value for property fieldGroupIds
* @returns {sap.ui.core.Control} Reference to this
in order to allow method chaining
*/
public setFieldGroupIds(sFieldGroupIds: string[]): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Whether the control should be visible on the screen. If set to false, a placeholder is rendered instead of the real control
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.ui.core.Control} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.core.Control;
/**
* The string given as "sStyleClass" will be be either added to or removed from the "class" attribute of this control's root HTML element,
* depending on the value of "bAdd": if bAdd is true, sStyleClass will be added.
* If bAdd is not given, sStyleClass will be removed if it is currently present and will be added if not present.
* If sStyleClass is null or empty string, the call is ignored.
*
* See addStyleClass and removeStyleClass for further documentation.
* @param {string} sStyleClass - the CSS class name to be added or removed
* @param {boolean} bAdd - whether sStyleClass should be added (or removed); when this parameter is not given, sStyleClass will be toggled (removed, if present, and added if not present)
* @returns {sap.ui.core.Control} Returns this
to allow method chaining
*/
public toggleStyleClass(sStyleClass: string, bAdd: boolean): sap.ui.core.Control;
/**
* Triggers the validateFieldGroup
event for this control.
*
* Called by sap.ui.core.UIArea
if a field group should be validated after it lost
* the focus or when the key combination was pressed that was configured to trigger validation
* (defined in the UI area member UIArea._oFieldGroupValidationKey
).
*
* See {@link #attachValidateFieldGroup}.
*/
public triggerValidateFieldGroup(): void;
}
/**
* Core Class of the SAP UI Library.
*
* This class boots the Core framework and makes it available for the application
* via method sap.ui.getCore()
.
*
* Example:
*
*
* var oCore = sap.ui.getCore();
*
*
*
* With methods of the Core framework you can {@link #attachInit execute code} after the framework has been initialized.
* It provides access to the {@link #getConfiguration configuration} and exposes events that
* an application or a control can register to (e.g. {@link #event:localizationChanged localizationChanged},
* {@link #event:parseError parseError}, {@link #event:validationError validationError},
* {@link #event:formatError formatError}, {@link #event:validationSuccess validationSuccess}).
*
* Example:
*
*
* oCore.attachInit(function() {
* if ( oCore.getConfiguration().getRTL() ) {
* ...
* }
* });
*
* oCore.attachLocalizationChanged(function(oEvent) {
* ...
* });
*
*
*/
export class Core extends sap.ui.base.Object {
/**
*/
public constructor();
/**
* Enforces an immediate update of the visible UI (aka "rendering").
*
* In general, applications should avoid calling this method and
* instead let the framework manage any necessary rendering.
*/
public applyChanges(): void;
/**
* Applies the theme with the given name (by loading the respective style sheets, which does not disrupt the application).
*
* By default, the theme files are expected to be located at path relative to the respective control library ([libraryLocation]/themes/[themeName]).
* Different locations can be configured by using the method setThemePath() or by using the second parameter "sThemeBaseUrl" of applyTheme().
* Usage of this second parameter is a shorthand for setThemePath and internally calls setThemePath, so the theme location is then known.
*
* sThemeBaseUrl is a single URL to specify the default location of all theme files. This URL is the base folder below which the control library folders
* are located. E.g. if the CSS files are not located relative to the root location of UI5, but instead they are at locations like
* http://my.server/myapp/resources/sap/ui/core/themes/my_theme/library.css
* then the URL that needs to be given is:
* http://my.server/myapp/resources
* All theme resources are then loaded from below this folder - except if for a certain library a different location has been registered.
*
* If the theme resources are not all either below this base location or with their respective libraries, then setThemePath must be
* used to configure individual locations.
* @param {string} sThemeName - the name of the theme to be loaded
* @param {string} sThemeBaseUrl - the (optional) base location of the theme
*/
public applyTheme(sThemeName: string, sThemeBaseUrl?: string): void;
/**
* Registers a listener for control events.
* @param {Function} fnFunction - callback to be called for each control event
* @param {any} oListener - optional context object to call the callback on.
*/
public attachControlEvent(fnFunction: Function, oListener?: any): void;
/**
* Attach event-handler fnFunction
to the 'formatError' event of sap.ui.core.Core
.
* Please note that this event is a bubbling event and may already be canceled before reaching the core.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
public attachFormatError(fnFunction: Function, oListener?: any): sap.ui.core.Core;
/**
* Registers a given function that is executed after the framework has been initialized.
*
* The given function will either be called as soon as the framework has been initialized
* or, if it has been initialized already, it will be called immediately.
* @param {Function} fnFunction - Function to be after initialization of the framework
*/
public attachInit(fnFunction: Function): void;
/**
* Registers a given function that is executed after the framework has been initialized.
*
* The method is executed only once and only if the framework has not been initialized already.
* This could be checked by calling {@link #isInitialized}, but in most cases it is more convenient to
* use {@link #attachInit} instead. This guarantees that the given function is executed exactly once,
* independent of the state of the framework.
* @param {Function} fnFunction - Function that is called after initialization of the framework
*/
public attachInitEvent(fnFunction: Function): void;
/**
* Registers a listener to the central interval timer.
* @param {Function} fnFunction - callback to be called periodically
* @param {any} oListener - optional context object to call the callback on.
*/
public attachIntervalTimer(fnFunction: Function, oListener?: any): void;
/**
* Register a listener for the localizationChanged
event.
* @param {Function} fnFunction - callback to be called
* @param {any} oListener - context object to cal lthe function on.
*/
public attachLocalizationChanged(fnFunction: Function, oListener: any): void;
/**
* Attach event-handler fnFunction
to the 'parseError' event of sap.ui.core.Core
.
* Please note that this event is a bubbling event and may already be canceled before reaching the core.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
public attachParseError(fnFunction: Function, oListener?: any): sap.ui.core.Core;
/**
* Attach event-handler fnFunction
to the 'parseError' event of sap.ui.core.Core
.
* Please note that this event is a bubbling event and may already be canceled before reaching the core.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
public attachParseError(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.Core;
/**
* Attach event-handler fnFunction
to the ThemeChanged
event of this sap.ui.core.Core
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function.
*/
public attachThemeChanged(fnFunction: Function, oListener?: any): void;
/**
* Attach event-handler fnFunction
to the 'validationError' event of sap.ui.core.Core
.
* Please note that this event is a bubbling event and may already be canceled before reaching the core.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
public attachValidationError(fnFunction: Function, oListener?: any): sap.ui.core.Core;
/**
* Attach event-handler fnFunction
to the 'validationError' event of sap.ui.core.Core
.
* Please note that this event is a bubbling event and may already be canceled before reaching the core.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
public attachValidationError(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.Core;
/**
* Attach event-handler fnFunction
to the 'validationSuccess' event of sap.ui.core.Core
.
* Please note that this event is a bubbling event and may already be canceled before reaching the core.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
public attachValidationSuccess(fnFunction: Function, oListener?: any): sap.ui.core.Core;
/**
* Attach event-handler fnFunction
to the 'validationSuccess' event of sap.ui.core.Core
.
* Please note that this event is a bubbling event and may already be canceled before reaching the core.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
public attachValidationSuccess(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.Core;
/**
* Returns a list of all controls with a field group ID.
* See {@link sap.ui.core.Control#checkFieldGroupIds Control.prototype.checkFieldGroupIds} for a description of the
* vFieldGroupIds
parameter.
* @param {string|string[]} vFieldGroupIds - ID of the field group or an array of field group IDs to match
* @returns {sap.ui.core.Control[]} The list of controls with matching field group IDs
*/
public byFieldGroupId(vFieldGroupIds?: string|string[]): sap.ui.core.Control[];
/**
* Returns the registered element for the given id, if any.
* @param {string} sId
* @returns {sap.ui.core.Element} the element for the given id
*/
public byId(sId: string): sap.ui.core.Element;
/**
* Creates a component with the provided id and settings.
*
* When the optional parameter sUrl
is given, then all request for resources of the
* library will be redirected to the given Url. This is convenience for a call to
*
* jQuery.sap.registerModulePath(sName, sUrl);
*
* @param {string|any} vComponent - name of the component to import or object containing all needed parameters
* @param {string} sUrl - the URL to load the component from
* @param {string} sId - the ID for the component instance
* @param {any} mSettings - the settings object for the component
*/
public createComponent(vComponent: string|any, sUrl?: string, sId?: string, mSettings?: any): void;
/**
* Returns a new instance of the RenderManager for exclusive use by the caller.
*
* The caller must take care to destroy the render manager when it is no longer needed.
* Calling this method before the Core has been {@link #isInitialized initialized},
* is not recommended.
* @returns {sap.ui.core.RenderManager} New instance of the RenderManager
*/
public createRenderManager(): sap.ui.core.RenderManager;
/**
* Creates a new sap.ui.core.UIArea.
* @param {string|Element} oDomRef - a DOM Element or ID string of the UIArea
* @returns {sap.ui.core.UIArea} a new UIArea
*/
public createUIArea(oDomRef: string|Element): sap.ui.core.UIArea;
/**
* Unregisters a listener for control events.
*
* A listener will only be unregistered if the same function/context combination
* is given as in the attachControlEvent call.
* @param {Function} fnFunction - function to unregister
* @param {any} oListener - context object given during registration
*/
public detachControlEvent(fnFunction: Function, oListener?: any): void;
/**
* Detach event-handler fnFunction
from the 'formatError' event of sap.ui.core.Core
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The callback function to unregister
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
public detachFormatError(fnFunction: Function, oListener: any): sap.ui.core.Core;
/**
* Unregisters a listener for the central interval timer.
*
* A listener will only be unregistered if the same function/context combination
* is given as in the attachIntervalTimer call.
* @param {Function} fnFunction - function to unregister
* @param {any} oListener - context object given during registration
*/
public detachIntervalTimer(fnFunction: Function, oListener?: any): void;
/**
* Unregister a listener from the localizationChanged
event.
*
* The listener will only be unregistered if the same function/context combination
* is given as in the call to attachLocalizationListener
.
* @param {Function} fnFunction - callback to be deregistered
* @param {any} oListener - context object given in a previous call to attachLocalizationChanged.
*/
public detachLocalizationChanged(fnFunction: Function, oListener: any): void;
/**
* Detach event-handler fnFunction
from the 'parseError' event of sap.ui.core.Core
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The callback function to unregister.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
public detachParseError(fnFunction: Function, oListener: any): sap.ui.core.Core;
/**
* Detach event-handler fnFunction
from the ThemeChanged
event of this sap.ui.core.Core
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
*/
public detachThemeChanged(fnFunction: Function, oListener?: any): void;
/**
* Detach event-handler fnFunction
from the 'validationError' event of sap.ui.core.Core
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The callback function to unregister
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
public detachValidationError(fnFunction: Function, oListener: any): sap.ui.core.Core;
/**
* Detach event-handler fnFunction
from the 'validationSuccess' event of sap.ui.core.Core
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
public detachValidationSuccess(fnFunction: Function, oListener: any): sap.ui.core.Core;
/**
* Creates a new subclass of class sap.ui.core.Core with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event formatError to attached listeners.
*
* Expects following event parameters:
*
* - 'element' of type
sap.ui.core.Element
* - 'property' of type
string
* - 'type' of type
string
* - 'newValue' of type
object
* - 'oldValue' of type
object
* - 'exception' of type
object
*
* @param {{ [key: string]: any }} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
protected fireFormatError(mArguments?: { [key: string]: any }): sap.ui.core.Core;
/**
* Fire event parseError to attached listeners.
*
* Expects following event parameters:
*
* - 'element' of type
sap.ui.core.Element
* - 'property' of type
string
* - 'type' of type
string
* - 'newValue' of type
object
* - 'oldValue' of type
object
* - 'exception' of type
object
*
* @param {{ [key: string]: any }} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
protected fireParseError(mArguments?: { [key: string]: any }): sap.ui.core.Core;
/**
* Fire event ThemeChanged
to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
*/
protected fireThemeChanged(mParameters?: any): void;
/**
* Fire event validationError to attached listeners.
*
* Expects following event parameters:
*
* - 'element' of type
sap.ui.core.Element
* - 'property' of type
string
* - 'type' of type
string
* - 'newValue' of type
object
* - 'oldValue' of type
object
* - 'exception' of type
object
*
* @param {{ [key: string]: any }} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
protected fireValidationError(mArguments?: { [key: string]: any }): sap.ui.core.Core;
/**
* Fire event validationSuccess to attached listeners.
*
* Expects following event parameters:
*
* - 'element' of type
sap.ui.core.Element
* - 'property' of type
string
* - 'type' of type
string
* - 'newValue' of type
object
* - 'oldValue' of type
object
*
* @param {{ [key: string]: any }} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
protected fireValidationSuccess(mArguments?: { [key: string]: any }): sap.ui.core.Core;
/**
* Returns the instance of the application (if exists).
* @returns {sap.ui.app.Application} instance of the current application
*/
public getApplication(): sap.ui.app.Application;
/**
* Returns the registered component for the given id, if any.
* @param {string} sId
* @returns {sap.ui.core.Component} the component for the given id
*/
public getComponent(sId: string): sap.ui.core.Component;
/**
* Returns the Configuration of the Core.
* @returns {sap.ui.core.Configuration} the Configuration of the current Core.
*/
public getConfiguration(): sap.ui.core.Configuration;
/**
* Returns the registered element for the given ID, if any.
* @param {string} sId
* @returns {sap.ui.core.Element} the element for the given id
*/
public getControl(sId: string): sap.ui.core.Element;
/**
* Returns the Id of the control/element currently in focus.
* @returns {string} the Id of the control/element currently in focus.
*/
public getCurrentFocusedControlId(): string;
/**
* Returns the registered element for the given ID, if any.
* @param {string} sId
* @returns {sap.ui.core.Element} the element for the given id
*/
public getElementById(sId: string): sap.ui.core.Element;
/**
* Returns the event bus.
* @returns {sap.ui.core.EventBus} the event bus
*/
public getEventBus(): sap.ui.core.EventBus;
/**
* Retrieves a resource bundle for the given library and locale.
*
* If only one argument is given, it is assumed to be the libraryName. The locale
* then falls back to the current {@link sap.ui.core.Configuration#getLanguage session locale}.
* If no argument is given, the library also falls back to a default: "sap.ui.core".
* @param {string} sLibraryName - name of the library to retrieve the bundle for
* @param {string} sLocale - locale to retrieve the resource bundle for
* @returns {typeof jQuery.sap.util.ResourceBundle} the best matching resource bundle for the given parameters or undefined
*/
public getLibraryResourceBundle(sLibraryName?: string, sLocale?: string): typeof jQuery.sap.util.ResourceBundle;
/**
* Returns a map of library info objects for all currently loaded libraries,
* keyed by their names.
*
* The structure of the library info objects matches the structure of the info object
* that the {@link #initLibrary} method expects. Only property names documented with
* initLibrary
should be accessed, any additional properties might change or
* disappear in future. When a property does not exists, its default value (as documented
* with initLibrary
) should be assumed.
*
* Note: The returned info objects must not be modified. They might be a living
* copy of the internal data (for efficiency reasons) and the framework is not prepared
* to handle modifications to these objects.
* @returns {{ [key: string]: any }} Map of library info objects keyed by the library names.
*/
public getLoadedLibraries(): { [key: string]: any };
/**
* Returns the active MessageManager
instance.
* @returns {sap.ui.core.message.MessageManager}
*/
public getMessageManager(): sap.ui.core.message.MessageManager;
/**
* Returns a metadata object for class sap.ui.core.Core.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Get the model with the given model name.
*
* The name can be omitted to reference the default model or it must be a non-empty string.
*
* Note: to be compatible with future versions of this API, applications must not use the value null
,
* the empty string ""
or the string literals "null"
or "undefined"
as model name.
* @param {string|any} sName - name of the model to be retrieved
* @returns {sap.ui.model.Model} oModel
*/
public getModel(sName?: string|any): sap.ui.model.Model;
/**
* @returns {any}
*/
public getRenderManager(): any;
/**
* Returns the instance of the root component (if exists).
* @returns {sap.ui.core.Component} instance of the current root component
*/
public getRootComponent(): sap.ui.core.Component;
/**
* Returns the static, hidden area DOM element belonging to this core instance.
*
* It can be used e.g. for hiding elements like Popups, Shadow, Blocklayer etc.
*
* If it is not yet available, a DIV is created and appended to the body.
* @returns {Element} the static, hidden area DOM element belonging to this core instance.
*/
public getStaticAreaRef(): Element;
/**
* Returns the registered template for the given id, if any.
* @param {string} sId
* @returns {sap.ui.core.Component} the template for the given id
*/
public getTemplate(sId: string): sap.ui.core.Component;
/**
* Returns a UIArea if the given ID/Element belongs to one.
* @param {string|Element} o - a DOM Element or ID string of the UIArea
* @returns {sap.ui.core.UIArea} a UIArea with a given id or dom ref.
*/
public getUIArea(o: string|Element): sap.ui.core.UIArea;
/**
* Returns true
if there are any pending rendering tasks or when
* such rendering tasks are currently being executed.
* @returns {boolean} true if there are pending (or executing) rendering tasks.
*/
public getUIDirty(): boolean;
/**
* Check if a Model is set to the core
* @returns {boolean} true or false
*/
public hasModel(): boolean;
/**
* Includes a library theme into the current page (if a variant is specified it
* will include the variant library theme)
* @param {string} sLibName - the name of the UI library
* @param {string} sVariant - the variant to include (optional)
* @param {string} sQuery - to be used only by the Core
*/
public includeLibraryTheme(sLibName: string, sVariant?: string, sQuery?: string): void;
/**
* Provides the framework with information about a library.
*
* This method is intended to be called exactly once while the main module of a library
* (its library.js
module) is executing, typically at its begin. The single
* parameter oLibInfo
is an info object that describes the content of the library.
*
* When the oLibInfo
has been processed, a normalized version of it will be kept
* and will be returned as library information in later calls to {@link #getLoadedLibraries}.
* Finally, initLibrary
fires (the currently private) {@link #event:LibraryChanged}
* event with operation 'add' for the newly loaded library.
*
*
* Side Effects
*
* While analyzing the oLibInfo
, the framework takes some additional actions:
*
*
* - If the info object contains a list of
interfaces
, they will be registered
* with the {@link sap.ui.base.DataType} class to make them available as aggregation types
* in managed objects.
*
* - If the object contains a list of
controls
or elements
,
* {@link sap.ui.lazyRequire lazy stubs} will be created for their constructor as well as for
* their static extend
and getMetadata
methods.
* Note: Future versions might abandon the concept of lazy stubs as it requires synchronous
* XMLHttpRequests which have been deprecated (see {@link http://xhr.spec.whatwg.org}). To be on the
* safe side, productive applications should always require any modules that they directly depend on.
*
* - With the
noLibraryCSS
property, the library can be marked as 'theming-free'.
* Otherwise, the framework will add a <link> tag to the page's head, pointing to the library's
* theme-specific stylesheet. The creation of such a <link> tag can be suppressed with the
* {@link sap.ui.core.Configuration global configuration option} preloadLibCss
.
* It can contain a list of library names for which no stylesheet should be included.
* This is e.g. useful when an application merges the CSS for multiple libraries and already
* loaded the resulting stylesheet.
*
* - If a list of library
dependencies
is specified in the info object, those
* libraries will be loaded synchronously by initLibrary
.
* Note: Dependencies between libraries don't have to be modeled as AMD dependencies.
* Only when enums or types from an additional library are used in the coding of the
* library.js
module, the library should be additionally listed in the AMD dependencies.
*
*
* Last but not least, higher layer frameworks might want to include their own metadata for libraries.
* The property extensions
might contain such additional metadata. Its structure is not defined
* by the framework, but it is strongly suggested that each extension only occupies a single property
* in the extensions
object and that the name of that property contains some namespace
* information (e.g. library name that introduces the feature) to avoid conflicts with other extensions.
* The framework won't touch the content of extensions
but will make it available
* in the library info objects returned by {@link #getLoadedLibraries}.
*
*
* Relationship to Descriptor for Libraries (manifest.json)
*
* The information contained in oLibInfo
is partially redundant to the content of the descriptor
* for the same library (its manifest.json
file). Future versions of UI5 might ignore the information
* provided in oLibInfo
and might evaluate the descriptor file instead. Library developers therefore
* should keep the information in both files in sync.
*
* When the manifest.json
is generated from the .library
file (which is the default
* for UI5 libraries built with Maven), then the content of the .library
and library.js
* files must be kept in sync.
* @param {any} oLibInfo - Info object for the library
*/
public initLibrary(oLibInfo: any): void;
/**
* Returns true if the Core has already been initialized. This means that instances
* of RenderManager etc. do already exist and the init event has already been fired
* (and will not be fired again).
* @returns {boolean} whether the Core has already been initialized
*/
public isInitialized(): boolean;
/**
* Returns the locked state of the sap.ui.core.Core
* @returns {boolean} locked state
*/
public isLocked(): boolean;
/**
* Check if the script is running on mobile
* @returns {boolean} true or false
*/
public isMobile(): boolean;
/**
* Used to find out whether a certain DOM element is the static area
* @param {any} oDomRef
* @returns {boolean} whether the given DomRef is the StaticAreaRef
*/
protected isStaticAreaRef(oDomRef: any): boolean;
/**
* Returns true, if the styles of the current theme are already applied, false otherwise.
*
* This function must not be used before the init event of the Core.
* If the styles are not yet applied a theme changed event will follow when the styles will be applied.
* @returns {boolean} whether the styles of the current theme are already applied
*/
public isThemeApplied(): boolean;
/**
* Loads a set of libraries, preferably asynchronously.
*
* The module loading is still synchronous, so if a library loads additional modules besides
* its library.js file, those modules might be loaded synchronously by the library.js
* The async loading is only supported by the means of the library-preload.js(on) files, so if a
* library doesn't provide a preload or when the preload is deactivated (configuration, debug mode)
* then this API falls back to synchronous loading. However, the contract (Promise) remains valid
* and a Promise will be returned if async is specified - even when the real loading
* is done synchronously.
* @param {string[]} aLibraries - set of libraries that should be loaded
* @param {any} mOptions - configuration options
* @returns {Promise|any} returns a Promise in async mode, otherwise undefined
*/
protected loadLibraries(aLibraries: string[], mOptions?: any): Promise|any;
/**
* Loads the given library and its dependencies and makes it available to the application.
*
* When library preloads are not suppressed for the given library, then a library-preload bundle
* will be loaded for it. By default, the bundle will be loaded synchronously (for compatibility
* reasons). Only when the optional parameter vUrl
is given as true
or as
* a configuration object with a property of async:true
, then the bundle will be loaded
* asynchronously and a Promise
will be returned (preferred usage).
*
* After preloading the bundle, dependency information from the bundle is evaluated and any
* missing libraries are also preloaded.
*
* Only then the library entry module (named your/lib/library.js
) will be required
* and executed. The module is supposed to call sap.ui.getCore().initLibrary(...)
* providing the framework with additional metadata about the library, e.g. its version, the set of contained
* enums, types, interfaces, controls and elements and whether the library requires CSS. If the library
* requires CSS, a <link> will be added to the page referring to the corresponding library.css
* stylesheet for the library and the current theme.
*
* When the optional parameter vUrl
is given as a string or when a configuration object is given
* with a non-empty, string-valued property url
, then that URL will be registered for the
* namespace of the library and all resources will be loaded from that location. This is convenience for
* a call like
*
* jQuery.sap.registerModulePath(sLibrary, vUrl); // or vUrl.url resp.
*
*
* When the given library has been loaded already, no further action will be taken, especially, a given
* URL will not be registered! In the case of asynchronous loading, a Promise will be returned, but will be
* resolved immediately.
* @param {string} sLibrary - name of the library to load
* @param {string|boolean|any} vUrl - URL to load the library from or the async flag or a complex configuration object
* @returns {Object|Promise} An info object for the library (sync) or a Promise (async)
*/
public loadLibrary(sLibrary: string, vUrl?: string|boolean|any): Object|Promise;
/**
* Locks the Core. No browser events are dispatched to the controls.
*
* Lock should be called before and after the dom is modified for rendering, roundtrips...
* Exceptions might be the case for asynchronous UI behavior
*/
public lock(): void;
/**
* Registers a Plugin to the sap.ui.core.Core
, which lifecycle
* will be managed (start and stop).
*
* Plugin object need to implement two methods:
*
* startPlugin(oCore)
: will be invoked, when the Plugin
* should start (as parameter the reference to the Core will be provided
* stopPlugin()
: will be invoked, when the Plugin should stop
*
* @param {any} oPlugin - reference to a Plugin object
*/
public registerPlugin(oPlugin: any): void;
/**
* Sets or unsets a model for the given model name.
*
* The sName
must either be undefined
(or omitted) or a non-empty string.
* When the name is omitted, the default model is set/unset.
*
* When oModel
is null
or undefined
, a previously set model
* with that name is removed from the Core.
*
* Any change (new model, removed model) is propagated to all existing UIAreas and their descendants
* as long as a descendant doesn't have its own model set for the given name.
*
* Note: to be compatible with future versions of this API, applications must not use the value null
,
* the empty string ""
or the string literals "null"
or "undefined"
as model name.
* @param {sap.ui.model.Model} oModel - the model to be set or null
or undefined
* @param {string} sName - the name of the model or undefined
* @returns {sap.ui.core.Core} this
to allow method chaining
*/
public setModel(oModel: sap.ui.model.Model, sName?: string): sap.ui.core.Core;
/**
* Implicitly creates a new UIArea
(or reuses an exiting one) for the given DOM reference and
* adds the given control reference to the UIAreas content (existing content will be removed).
* @param {string|Element} oDomRef - a DOM Element or Id (string) of the UIArea
* @param {sap.ui.base.Interface|sap.ui.core.Control} oControl - the Control that should be the added to the UIArea
.
*/
public setRoot(oDomRef: string|Element, oControl: sap.ui.base.Interface|sap.ui.core.Control): void;
/**
* Defines the root directory from below which UI5 should load the theme with the given name.
* Optionally allows restricting the setting to parts of a theme covering specific control libraries.
*
* Example:
*
* sap.ui.getCore().setThemeRoot("my_theme", "https://mythemeserver.com/allThemes");
* sap.ui.getCore().applyTheme("my_theme");
*
*
* will cause the following file to be loaded (assuming that the bootstrap is configured to load
* libraries sap.m
and sap.ui.layout
):
*
* https://mythemeserver.com/allThemes/sap/ui/core/themes/my_theme/library.css
* https://mythemeserver.com/allThemes/sap/ui/layout/themes/my_theme/library.css
* https://mythemeserver.com/allThemes/sap/m/themes/my_theme/library.css
*
*
* If parts of the theme are at different locations (e.g. because you provide a standard theme
* like "sap_belize" for a custom control library and this self-made part of the standard theme is at a
* different location than the UI5 resources), you can also specify for which control libraries the setting
* should be used, by giving an array with the names of the respective control libraries as second parameter:
*
* sap.ui.getCore().setThemeRoot("sap_belize", ["my.own.library"], "https://mythemeserver.com/allThemes");
*
*
* This will cause the Belize theme to be loaded from the UI5 location for all standard libs.
* Resources for styling the my.own.library
controls will be loaded from the configured
* location:
*
* https://openui5.hana.ondemand.com/resources/sap/ui/core/themes/sap_belize/library.css
* https://openui5.hana.ondemand.com/resources/sap/ui/layout/themes/sap_belize/library.css
* https://openui5.hana.ondemand.com/resources/sap/m/themes/sap_belize/library.css
* https://mythemeserver.com/allThemes/my/own/library/themes/sap_belize/library.css
*
*
* If the custom theme should be loaded initially (via bootstrap attribute), the themeRoots
* property of the window["sap-ui-config"]
object must be used instead of calling
* sap.ui.getCore().setThemeRoot(...)
in order to configure the theme location early enough.
* @param {string} sThemeName - Name of the theme for which to configure the location
* @param {string} sThemeBaseUrl - Base URL below which the CSS file(s) will be loaded from
* @returns {sap.ui.core.Core} the Core, to allow method chaining
*/
public setThemeRoot(sThemeName: string, sThemeBaseUrl: string): sap.ui.core.Core;
/**
* Defines the root directory from below which UI5 should load the theme with the given name.
* Optionally allows restricting the setting to parts of a theme covering specific control libraries.
*
* Example:
*
* sap.ui.getCore().setThemeRoot("my_theme", "https://mythemeserver.com/allThemes");
* sap.ui.getCore().applyTheme("my_theme");
*
*
* will cause the following file to be loaded (assuming that the bootstrap is configured to load
* libraries sap.m
and sap.ui.layout
):
*
* https://mythemeserver.com/allThemes/sap/ui/core/themes/my_theme/library.css
* https://mythemeserver.com/allThemes/sap/ui/layout/themes/my_theme/library.css
* https://mythemeserver.com/allThemes/sap/m/themes/my_theme/library.css
*
*
* If parts of the theme are at different locations (e.g. because you provide a standard theme
* like "sap_belize" for a custom control library and this self-made part of the standard theme is at a
* different location than the UI5 resources), you can also specify for which control libraries the setting
* should be used, by giving an array with the names of the respective control libraries as second parameter:
*
* sap.ui.getCore().setThemeRoot("sap_belize", ["my.own.library"], "https://mythemeserver.com/allThemes");
*
*
* This will cause the Belize theme to be loaded from the UI5 location for all standard libs.
* Resources for styling the my.own.library
controls will be loaded from the configured
* location:
*
* https://openui5.hana.ondemand.com/resources/sap/ui/core/themes/sap_belize/library.css
* https://openui5.hana.ondemand.com/resources/sap/ui/layout/themes/sap_belize/library.css
* https://openui5.hana.ondemand.com/resources/sap/m/themes/sap_belize/library.css
* https://mythemeserver.com/allThemes/my/own/library/themes/sap_belize/library.css
*
*
* If the custom theme should be loaded initially (via bootstrap attribute), the themeRoots
* property of the window["sap-ui-config"]
object must be used instead of calling
* sap.ui.getCore().setThemeRoot(...)
in order to configure the theme location early enough.
* @param {string} sThemeName - Name of the theme for which to configure the location
* @param {string[]} aLibraryNames - Optional library names to which the configuration should be restricted
* @param {string} sThemeBaseUrl - Base URL below which the CSS file(s) will be loaded from
* @returns {sap.ui.core.Core} the Core, to allow method chaining
*/
public setThemeRoot(sThemeName: string, aLibraryNames: string[], sThemeBaseUrl: string): sap.ui.core.Core;
/**
* Unlocks the Core.
*
* Browser events are dispatched to the controls again after this method is called.
*/
public unlock(): void;
/**
* Unregisters a Plugin out of the sap.ui.core.Core
* @param {any} oPlugin - reference to a Plugin object
*/
public unregisterPlugin(oPlugin: any): void;
}
/**
* A string type that represents CSS color values.
*
* Allowed values are CSS hex colors like "#666666" or "#fff", RGB/HSL values like "rgb(0,0,0)"
* or "hsla(50%,10%,30%,0.5)" as well as CSS color names like "green" and "darkblue" and special
* values like "inherit" and "transparent".
*
* The empty string is also allowed and has the same effect as setting no color.
*/
export type CSSColor = string;
/**
* A string type that represents CSS size values.
*
* The CSS specifications calls this the '<length> type'
.
* Allowed values are CSS sizes like "1px" or "2em" or "50%". The special values auto
* and inherit
are also accepted as well as mathematical expressions using the CSS3
* calc(expression)
operator.
*
* Note that CSS does not allow all these values for every CSS property representing a size.
* E.g. padding-left
doesn't allow the value auto
. So even if a value is
* accepted by sap.ui.core.CSSSize
, it still might have no effect in a specific context.
* In other words: UI5 controls usually don't extend the range of allowed values in CSS.
*
*
* Units
*
* Valid font-relative units are em, ex
and rem
. Supported absolute units
* are cm, mm, in, pc, pt
and px
. Other units are not supported yet.
*
*
* Mathematical Expressions
*
* Expressions inside the calc()
operator are only roughly checked for validity.
* Not every value that this type accepts might be a valid expression in the sense of the CSS spec.
* But vice versa, any expression that is valid according to the spec should be accepted by this type.
* The current implementation is based on the
* {@link http://dev.w3.org/csswg/css-values-3/#calc-syntax CSS3 Draft specification from 22 April 2015}.
*
* Noteworthy details:
*
* - whitespace is mandatory around a '-' or '+' operator and optional otherwise
* - parentheses are accepted but not checked for being balanced (a limitation of regexp based checks)
* - semantic constraints like type restrictions are not checked
*
*
* Future versions of UI5 might check calc()
expressions in more detail, so applications should
* not assume that a value, that is invalid according to the CSS spec but currently accepted by this type
* still will be accepted by future versions of this type.
*/
export type CSSSize = string;
/**
* This type checks the short hand form of a margin or padding definition.
*
* E.g. "1px 1px" or up to four CSSSize values are allowed or tHe special keyword inherit
.
*/
namespace CSSSizeShortHand {
}
/**
* Contains a single key/value pair of custom data attached to an Element. See method data().
*/
export class CustomData extends sap.ui.core.Element {
/**
* Constructor for a new CustomData.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.CustomData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getKey key}.
*
* The key of the data in this CustomData object.
* When the data is just stored, it can be any string, but when it is to be written to HTML (writeToDom == true) then it must also be a valid HTML attribute name (it must conform to the sap.ui.core.ID type and may contain no colon) to avoid collisions, it also may not start with "sap-ui". When written to HTML, the key is prefixed with "data-".
* If any restriction is violated, a warning will be logged and nothing will be written to the DOM.
* @returns {string} Value of property key
*/
public getKey(): string;
/**
* Returns a metadata object for class sap.ui.core.CustomData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getValue value}.
*
* The data stored in this CustomData object.
* When the data is just stored, it can be any JS type, but when it is to be written to HTML (writeToDom == true) then it must be a string.
* If this restriction is violated, a warning will be logged and nothing will be written to the DOM.
* @returns {any} Value of property value
*/
public getValue(): any;
/**
* Gets current value of property {@link #getWriteToDom writeToDom}.
*
* If set to "true" and the value is of type "string" and the key conforms to the documented restrictions, this custom data is written to the HTML root element of the control as a "data-*" attribute.
* If the key is "abc" and the value is "cde", the HTML will look as follows:
* <SomeTag ... data-abc="cde" ... >
* Thus the application can provide stable attributes by data binding which can be used for styling or identification purposes.
* ATTENTION: use carefully to not create huge attributes or a large number of them.
*
* Default value is false
.
* @returns {boolean} Value of property writeToDom
*/
public getWriteToDom(): boolean;
/**
* Sets a new value for property {@link #getKey key}.
*
* The key of the data in this CustomData object.
* When the data is just stored, it can be any string, but when it is to be written to HTML (writeToDom == true) then it must also be a valid HTML attribute name (it must conform to the sap.ui.core.ID type and may contain no colon) to avoid collisions, it also may not start with "sap-ui". When written to HTML, the key is prefixed with "data-".
* If any restriction is violated, a warning will be logged and nothing will be written to the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sKey - New value for property key
* @returns {sap.ui.core.CustomData} Reference to this
in order to allow method chaining
*/
public setKey(sKey: string): sap.ui.core.CustomData;
/**
* Sets a new value for property {@link #getValue value}.
*
* The data stored in this CustomData object.
* When the data is just stored, it can be any JS type, but when it is to be written to HTML (writeToDom == true) then it must be a string.
* If this restriction is violated, a warning will be logged and nothing will be written to the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oValue - New value for property value
* @returns {sap.ui.core.CustomData} Reference to this
in order to allow method chaining
*/
public setValue(oValue: any): sap.ui.core.CustomData;
/**
* Sets a new value for property {@link #getWriteToDom writeToDom}.
*
* If set to "true" and the value is of type "string" and the key conforms to the documented restrictions, this custom data is written to the HTML root element of the control as a "data-*" attribute.
* If the key is "abc" and the value is "cde", the HTML will look as follows:
* <SomeTag ... data-abc="cde" ... >
* Thus the application can provide stable attributes by data binding which can be used for styling or identification purposes.
* ATTENTION: use carefully to not create huge attributes or a large number of them.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bWriteToDom - New value for property writeToDom
* @returns {sap.ui.core.CustomData} Reference to this
in order to allow method chaining
*/
public setWriteToDom(bWriteToDom: boolean): sap.ui.core.CustomData;
}
/**
* Static class for enabling declarative UI support.
*/
export class DeclarativeSupport {
/**
*/
public constructor();
/**
* Enhances the given DOM element by parsing the Control and Elements info and creating
* the SAPUI5 controls for them.
* @param {Element} oElement - the DOM element to compile
* @param {sap.ui.core.mvc.HTMLView} oView - The view instance to use
* @param {boolean} isRecursive - Whether the call of the function is recursive.
*/
public static compile(oElement: Element, oView?: sap.ui.core.mvc.HTMLView, isRecursive?: boolean): void;
}
/**
*/
namespace delegate {
/**
* Delegate for the navigation between DOM nodes with the keyboard.
*
* The ItemNavigation
provides keyboard and mouse navigation between DOM nodes representing items.
* This means that controls rendering a list of items can attach this delegate to get a common keyboard and mouse support
* to navigate between these items.
* It is possible to navigate between the items via the arrow keys.
* If needed, paging using the Page Up and Page Down keys is possible. (To activate call setPageSize
with a value > 0.)
* HOME and END keys are also supported.
* Focusing an item via mouse also is also supported. For mouse navigation, the mousedown
event is used.
*
* As the ItemNavigation
works with DOM nodes, the items and the control area must be provided as
* DOM references. There is one root DOM reference (set via setRootDomRef
).
* All item DOM references (set via setItemDomRefs
) must be places somewhere inside of this root DOM reference.
* Only focusable items are used for the navigation, meaning disabled items or separator items are just ignored by navigating
* through the items. In some cases however, it makes sense to put the non-focusable items in the array of the DOM references to
* keep the indexes stable or like in the calling control.
* Hint: To make a DOM reference focusable a tabindex
of -1 can be set.
*
* Note After re-rendering of the control or changing the DOM nodes of the control, the
* DOM references of the ItemNavigation
must be updated. Then the same item
* (corresponding to the index) will get the focus.
*
* The ItemNavigation
adjusts the tabindex
of all DOM references relating to the current
* focused item. So if the control containing the items gets the focus (e.g. via tab navigation),
* it is always the focused items which will be focused.
*
* Note: If the ItemNavigation
is nested in another ItemNavigation
* (e.g. SegmentedButton
in Toolbar
), the RootDomRef
will always have tabindex
-1.
*
* Per default the ItemNavigation
cycles over the items.
* It navigates again to the first item if the Arrow Down or Arrow Right key is pressed while
* the last item has the focus. It navigates to the last item if arrow up or
* arrow left is pressed while the first item has the focus.
* If you want to stop the navigation at the first and last item,
* call the setCycling
method with a value of false
.
*
* It is possible to have multiple columns in the item navigation. If multiple columns
* are used, the keyboard navigation changes. The Arrow Right and Arrow Left keys will take the user to the next or previous
* item, and the Arrow Up and Arrow Down keys will navigate the same way but in a vertical direction.
*
* The ItemNavigation
also allows setting a selected index that is used to identify
* the selected item. Initially, if no other focus is set, the selected item will be the focused one.
* Note that navigating through the items will not change the selected item, only the focus.
* (For example a radio group has one selected item.)
*/
export class ItemNavigation extends sap.ui.base.EventProvider {
/**
* Creates an ItemNavigation
delegate that can be attached to controls requiring
* capabilities for keyboard navigation between items.
* @param {Element} oDomRef - The root DOM reference that includes all items
* @param {Element[]} aItemDomRefs - Array of DOM references representing the items for the navigation
* @param {boolean} bNotInTabChain - Whether the selected element should be in the tab chain or not
*/
public constructor(oDomRef: Element, aItemDomRefs: Element[], bNotInTabChain?: boolean);
/**
* Creates a new subclass of class sap.ui.core.delegate.ItemNavigation with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns disabled modifiers
* These modifiers will not be handled by the ItemNavigation
* @param {any} oDisabledModifiers - Object that includes event type with disabled keys as an array
* @returns {any} Object that includes event type with disabled keys as an array
*/
public getDisabledModifiers(oDisabledModifiers: any): any;
/**
* Returns the array of item DOM references
* @returns {Element[]} Array of item DOM references
*/
public getItemDomRefs(): Element[];
/**
* Returns a metadata object for class sap.ui.core.delegate.ItemNavigation.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the root DOM reference surrounding the items
* @returns {Element} Root DOM reference
*/
public getRootDomRef(): Element;
/**
* Check whether given event has disabled modifier or not
* @param {JQueryEventObject} oEvent - jQuery event
* @returns {boolean} Flag if disabled modifiers are set
*/
public hasDisabledModifier(oEvent: JQueryEventObject): boolean;
/**
* Sets whether the items are displayed in columns.
*
* If columns are used, the Arrow Up and Arrow Down keys navigate to the next or previous
* item of the column. If the first or last item of the column is reached, the next focused
* item is then in the next or previous column.
* @param {number} iColumns - Count of columns for the table mode or cycling mode
* @param {boolean} bNoColumnChange - Forbids jumping to an other column with Arrow Up and Arrow Down keys
* @returns {sap.ui.core.delegate.ItemNavigation} this
to allow method chaining
*/
public setColumns(iColumns: number, bNoColumnChange: boolean): sap.ui.core.delegate.ItemNavigation;
/**
* Sets whether the ItemNavigation
should cycle through the items.
*
* If cycling is disabled the navigation stops at the first and last item, if the corresponding arrow keys are used.
* @param {boolean} bCycling - Set to true if cycling should be done, else false
* @returns {sap.ui.core.delegate.ItemNavigation} this
to allow method chaining
*/
public setCycling(bCycling: boolean): sap.ui.core.delegate.ItemNavigation;
/**
* Sets the disabled modifiers
* These modifiers will not be handled by the ItemNavigation
*
*
* Example: Disable shift + up handling of the ItemNavigation
*
* oItemNavigation.setDisabledModifiers({
* sapnext : ["shift"]
* });
*
* Possible keys are : "shift", "alt", "ctrl", "meta"
* Possible events are : "sapnext", "sapprevious", "saphome", "sapend"
*
* @param {Object} oDisabledModifiers - Object that includes event type with disabled keys as an array
* @returns {sap.ui.core.delegate.ItemNavigation} this
to allow method chaining
*/
public setDisabledModifiers(oDisabledModifiers: Object): sap.ui.core.delegate.ItemNavigation;
/**
* Sets behavior of HOME and END keys if columns are used.
* @param {boolean} bStayInRow - HOME -> go to first item in row; END -> go to last item in row
* @param {boolean} bCtrlEnabled - HOME/END with CTRL -> go to first/last item of all
* @returns {sap.ui.core.delegate.ItemNavigation} this
to allow method chaining
*/
public setHomeEndColumnMode(bStayInRow: boolean, bCtrlEnabled: boolean): sap.ui.core.delegate.ItemNavigation;
/**
* Sets the item DOM references as an array for the items
* @param {Element[]} aItemDomRefs - Array of DOM references or DOM node list object, representing the items
* @returns {sap.ui.core.delegate.ItemNavigation} this
to allow method chaining
*/
public setItemDomRefs(aItemDomRefs: Element[]): sap.ui.core.delegate.ItemNavigation;
/**
* Sets the page size of the item navigation to allow Page Up and Page Down keys.
* @param {number} iPageSize - The page size, needs to be at least 1
* @returns {sap.ui.core.delegate.ItemNavigation} this
to allow method chaining
*/
public setPageSize(iPageSize: number): sap.ui.core.delegate.ItemNavigation;
/**
* Sets the root DOM reference surrounding the items
* @param {any} oDomRef - Root DOM reference
* @returns {sap.ui.core.delegate.ItemNavigation} this
to allow method chaining
*/
public setRootDomRef(oDomRef: any): sap.ui.core.delegate.ItemNavigation;
/**
* Sets the selected index if the used control supports selection.
* @param {number} iIndex - Index of the first selected item
* @returns {sap.ui.core.delegate.ItemNavigation} this
to allow method chaining
*/
public setSelectedIndex(iIndex: number): sap.ui.core.delegate.ItemNavigation;
/**
* Sets whether the ItemNavigation
should use the table mode to navigate through
* the items (navigation in a grid).
* @param {boolean} bTableMode - Set to true if table mode should be used, else false
* @param {boolean} bTableList - This sets a different behavior for table mode. In this mode we keep using table navigation but there are some differences. e.g. - Page-up moves focus to the first row, not to the first cell like in table mode
- Page-down moves focus to the last row, not to the last cell like in table mode
* @returns {sap.ui.core.delegate.ItemNavigation} this
to allow method chaining
*/
public setTableMode(bTableMode: boolean, bTableList?: boolean): sap.ui.core.delegate.ItemNavigation;
}
/**
* Delegate for touch scrolling on mobile devices
*
* This delegate uses native scrolling of mobile and desktop browsers. Third party scrolling libraries are not supported.
*
* Controls that implement ScrollEnablement should additionally provide the getScrollDelegate method that returns
* the current instance of this delegate object
*/
export class ScrollEnablement extends sap.ui.base.Object {
/**
* Creates a ScrollEnablement delegate that can be attached to Controls requiring
* capabilities for scrolling of a certain part of their DOM.
* @param {sap.ui.core.Control} oControl - the Control of which this Scroller is the delegate
* @param {string} sScrollContentDom - the Id of the element within the DOM of the Control which should be scrollable
* @param {any} oConfig - the configuration of the scroll delegate
*/
public constructor(oControl: sap.ui.core.Control, sScrollContentDom: string, oConfig: any);
/**
* Destroys this Scrolling delegate.
*
* This function must be called by the control which uses this delegate in the exit
function.
*/
public destroy(): void;
/**
* Creates a new subclass of class sap.ui.core.delegate.ScrollEnablement with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Calculates scroll position of a child of a container.
* @param {HTMLElement|JQuery} vElement - An element(DOM or jQuery) for which the scroll position will be calculated.
* @returns {any} Position object.
*/
protected getChildPosition(vElement: HTMLElement|JQuery): any;
/**
* Get current setting for horizontal scrolling.
* @returns {boolean} true if horizontal scrolling is enabled
*/
protected getHorizontal(): boolean;
/**
* Returns a metadata object for class sap.ui.core.delegate.ScrollEnablement.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Get current setting for vertical scrolling.
* @returns {boolean} true if vertical scrolling is enabled
*/
protected getVertical(): boolean;
/**
* Refreshes this Scrolling delegate.
*/
protected refresh(): void;
/**
* Scrolls to an element within a container.
* @param {HTMLElement} oElement - A DOM element.
* @param {number} iTime - The duration of animated scrolling in milliseconds. To scroll immediately without animation, give 0 as value.
* @returns {sap.ui.core.delegate.ScrollEnablement}
*/
protected scrollToElement(oElement: HTMLElement, iTime?: number): sap.ui.core.delegate.ScrollEnablement;
/**
* Setter for property bounce
.
* @param {boolean} bBounce - new value for property bounce
.
*/
protected setBounce(bBounce: boolean): void;
/**
* Sets GrowingList control to scroll container
* @param {Function} fnScrollLoadCallback - Scrolling callback
* @param {sap.m.ListGrowingDirection} sScrollLoadDirection - Scrolling direction
*/
protected setGrowingList(fnScrollLoadCallback: Function, sScrollLoadDirection: sap.m.ListGrowingDirection): void;
/**
* Enable or disable horizontal scrolling.
* @param {boolean} bHorizontal - set true to enable horizontal scrolling, false - to disable
*/
protected setHorizontal(bHorizontal: boolean): void;
/**
* Sets IconTabBar control to scroll container
* @param {sap.m.IconTabBar} oIconTabBar - instance
* @param {Function} fnScrollEndCallback - callback function for the scroll end event
* @param {Function} fnScrollStartCallback - callback function for the scroll start event
*/
protected setIconTabBar(oIconTabBar: sap.m.IconTabBar, fnScrollEndCallback: Function, fnScrollStartCallback: Function): void;
/**
* Set overflow control on top of scroll container.
* @param {sap.ui.core.Control} oControl - Top control that should be normally hidden over the top border of the scroll container (pull-down content).
*/
protected setPullDown(oControl: sap.ui.core.Control): void;
/**
* Enable or disable vertical scrolling.
* @param {boolean} bVertical - set true to enable vertical scrolling, false - to disable
*/
protected setVertical(bVertical: boolean): void;
}
}
/**
* Font design for texts
*/
export enum Design {
/**
* Mono space font
*/
Monospace = "Monospace",
/**
* Standard font
*/
Standard = "Standard",
}
/**
* Docking position: horizontal/vertical.
*
* Defines a position on the element which is used for aligned positioning of another element (e.g. the left top
* corner of a popup is positioned at the left bottom corner of the input field). For the horizontal position possible values
* are "begin", "left", "center", "right" and "end", where left/right always are left and right, or begin/end which are
* dependent on the text direction. For the vertical position possible values are "top", "center" and "bottom".
* Examples: "left top", "end bottom", "center center".
*/
export enum Dock {
BeginTop = "begin top",
BeginCenter = "begin center",
BeginBottom = "begin bottom",
LeftTop = "left top",
LeftCenter = "left center",
LeftBottom = "left bottom",
CenterTop = "center top",
CenterCenter = "center center",
CenterBottom = "center bottom",
RightTop = "right top",
RightCenter = "right center",
RightBottom = "right bottom",
EndTop = "end top",
EndCenter = "end center",
EndBottom = "end bottom",
}
/**
* Base Class for Elements.
*/
export class Element extends sap.ui.base.ManagedObject {
/**
* Constructs and initializes a UI Element with the given sId
and settings.
*
* If the optional mSettings
are given, they must be a JSON-like object (object literal)
* that defines values for properties, aggregations, associations or events keyed by their name.
*
* Valid Names:
*
* The property (key) names supported in the object literal are exactly the (case sensitive)
* names documented in the JSDoc for the properties, aggregations, associations and events
* of the control and its base classes. Note that for 0..n aggregations and associations this
* usually is the plural name, whereas it is the singular name in case of 0..1 relations.
*
* If a key name is ambiguous for a specific control class (e.g. a property has the same
* name as an event), then this method prefers property, aggregation, association and
* event in that order. To resolve such ambiguities, the keys can be prefixed with
* aggregation:
, association:
or event:
.
* In that case the keys must be quoted due to the ':'.
*
* Each subclass should document the set of supported names in its constructor documentation.
*
* Valid Values:
*
*
* - for normal properties, the value has to be of the correct simple type (no type conversion occurs)
*
- for 0..1 aggregations, the value has to be an instance of the aggregated control or element type
*
- for 0..n aggregations, the value has to be an array of instances of the aggregated type
*
- for 0..1 associations, an instance of the associated type or an id (string) is accepted
*
- 0..n associations are not supported yet
*
- for events either a function (event handler) is accepted or an array of length 2
* where the first element is a function and the 2nd element is an object to invoke the method on.
*
*
* Special aggregation dependents
is connected to the lifecycle management and databinding,
* but not rendered automatically and can be used for popups or other dependent controls or elements.
* This allows the definition of popup controls in declarative views and enables propagation of model
* and context information to them.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control; generated automatically if no non-empty id is given Note: this can be omitted, no matter whether mSettings
will be given or not!
* @param {any} mSettings - optional map/JSON-object with initial property values, aggregated objects etc. for the new element
*/
public constructor(sId?: string, mSettings?: any);
/**
* Returns the best suitable DOM node that represents this Element wrapped as jQuery object.
* I.e. the element returned by {@link sap.ui.core.Element#getDomRef} is wrapped and returned.
*
* If an ID suffix is given, the ID of this Element is concatenated with the suffix
* (separated by a single dash) and the DOM node with that compound ID will be wrapped by jQuery.
* This matches the UI5 naming convention for named inner DOM nodes of a control.
* @param {string} sSuffix - ID suffix to get a jQuery object for
* @returns {JQuery} The jQuery wrapped element's DOM reference
*/
protected $(sSuffix?: string): JQuery;
/**
* Registers the given event handler to change events of the screen width/closest media container width, based on the range set with the specified name.
* @param {any} fnFunction
* @param {any} oListener
* @param {any} sName
*/
protected _attachMediaContainerWidthChange(fnFunction: any, oListener: any, sName: any): void;
/**
* Removes a previously attached event handler from the change events of the screen width/closest media container width.
* @param {any} fnFunction
* @param {any} oListener
* @param {any} sName
*/
protected _detachMediaContainerWidthChange(fnFunction: any, oListener: any, sName: any): void;
/**
* Returns the current media range of the Device or the closest media container
* @param {any} sName
* @returns {{ [key: string]: any }}
*/
protected _getCurrentMediaContainerRange(sName: any): { [key: string]: any };
/**
* Returns the contextual width of an element, if set, or undefined
otherwise
* @returns {number|undefined}
*/
protected _getMediaContainerWidth(): number|undefined;
/**
* Adds some customData to the aggregation {@link #getCustomData customData}.
* @param {sap.ui.core.CustomData} oCustomData - the customData to add; if empty, nothing is inserted
* @returns {sap.ui.core.Element} Reference to this
in order to allow method chaining
*/
public addCustomData(oCustomData: sap.ui.core.CustomData): sap.ui.core.Element;
/**
* Adds some dependent to the aggregation {@link #getDependents dependents}.
* @param {sap.ui.core.Element} oDependent - the dependent to add; if empty, nothing is inserted
* @returns {sap.ui.core.Element} Reference to this
in order to allow method chaining
*/
public addDependent(oDependent: sap.ui.core.Element): sap.ui.core.Element;
/**
* Adds a delegate that listens to the events that are fired on this element (as opposed to events which are fired BY this element).
*
* When this element is cloned, the same delegate will be added to all clones. This behavior is well-suited for applications which want to add delegates
* that also work with templates in aggregation bindings.
* For control development the internal "addDelegate" method which does not clone delegates by default may be more suitable, as typically each control instance takes care of its own delegates.
*
* To avoid double registrations, all registrations of the given delegate are first
* removed and then the delegate is added.
*
* Important: If event delegates were added the delegate will still be called even if
* the event was processed and/or cancelled via preventDefault
by the Element or another event delegate.
* preventDefault
only prevents the event from bubbling.
* It should be checked e.g. in the event delegate's listener whether an Element is still enabled via getEnabled
.
* Additionally there might be other things that delegates need to check depending on the event
* (e.g. not adding a key twice to an output string etc.).
* @param {any} oDelegate - the delegate object
* @param {any} oThis - if given, this object will be the "this" context in the listener methods; default is the delegate object itself
* @returns {sap.ui.core.Element} Returns this
to allow method chaining
*/
public addEventDelegate(oDelegate: any, oThis?: any): sap.ui.core.Element;
/**
* Applies the focus info.
*
* To be overwritten by the specific control method.
* @param {any} oFocusInfo
*/
protected applyFocusInfo(oFocusInfo: any): void;
/**
* Bind the object to the referenced entity in the model, which is used as the binding context
* to resolve bound properties or aggregations of the object itself and all of its children
* relatively to the given path.
* If a relative binding path is used, this will be applied whenever the parent context changes.
* There is no difference between {@link sap.ui.core.Element#bindElement} and {@link sap.ui.base.ManagedObject#bindObject}.
* @param {string|any} vPath - the binding path or an object with more detailed binding options
* @param {any} mParameters - map of additional parameters for this binding (only taken into account when vPath is a string in that case the properties described for vPath above are valid here). The supported parameters are listed in the corresponding model-specific implementation of sap.ui.model.ContextBinding
.
* @returns {sap.ui.core.Element} reference to the instance itself
*/
public bindElement(vPath: string|any, mParameters?: any): sap.ui.core.Element;
/**
* Create a clone of this Element.
*
* Calls ManagedObject#clone
and additionally clones event delegates.
* @param {string} sIdSuffix - Suffix to be appended to the cloned element ID
* @param {string[]} aLocalIds - Array of local IDs within the cloned hierarchy (internally used)
* @returns {sap.ui.base.ManagedObject} reference to the newly created clone
*/
protected clone(sIdSuffix?: string, aLocalIds?: string[]): sap.ui.base.ManagedObject;
/**
* Creates a new Element from the given data.
*
* If vData
is an Element already, that element is returned.
* If vData
is an object (literal), then a new element is created with vData
as settings.
* The type of the element is either determined by a property named Type
in the vData
or
* by a type information in the oKeyInfo
object
* @param {sap.ui.core.Element|any} vData - Data to create the element from
* @param {any} oKeyInfo - An entity information (e.g. aggregation info)
*/
public static create(vData: sap.ui.core.Element|any, oKeyInfo?: any): void;
/**
* Attaches custom data to an Element
or retrieves attached data.
*
* Usage:
*
* data("myKey", myData)
*
* Attaches myData
(which can be any JS data type, e.g. a number, a string, an object, or a function)
* to this element, under the given key "myKey". If the key already exists,the value will be updated.
*
*
* data("myKey", myData, writeToDom)
*
* Attaches myData
to this element, under the given key "myKey" and (if writeToDom
* is true) writes key and value to the HTML. If the key already exists,the value will be updated.
* While oValue
can be any JS data type to be attached, it must be a string to be also
* written to DOM. The key must also be a valid HTML attribute name (it must conform to sap.ui.core.ID
* and may contain no colon) and may not start with "sap-ui". When written to HTML, the key is prefixed with "data-".
*
*
* data("myKey")
*
* Retrieves whatever data has been attached to this element (using the key "myKey") before
*
*
* data("myKey", null)
*
* Removes whatever data has been attached to this element (using the key "myKey") before
*
*
* data(null)
*
* Removes all data
*
*
* data()
*
* Returns all data, as a map
*/
public data(): void;
/**
* Creates metadata for a UI Element by extending the Object Metadata.
* @param {string} sClassName - name of the class to build the metadata for
* @param {any} oStaticInfo - static information used to build the metadata
* @param {Function} fnMetaImpl - constructor to be used for the metadata
* @returns {sap.ui.base.Metadata} the created metadata
*/
public static defineClass(sClassName: string, oStaticInfo: any, fnMetaImpl?: Function): sap.ui.base.Metadata;
/**
* Cleans up the resources associated with this element and all its children.
*
* After an element has been destroyed, it can no longer be used in the UI!
*
* Applications should call this method if they don't need the element any longer.
* @param {boolean} bSuppressInvalidate - if true, the UI element is not marked for redraw
*/
public destroy(bSuppressInvalidate?: boolean): void;
/**
* Destroys all the customData in the aggregation {@link #getCustomData customData}.
* @returns {sap.ui.core.Element} Reference to this
in order to allow method chaining
*/
public destroyCustomData(): sap.ui.core.Element;
/**
* Destroys all the dependents in the aggregation {@link #getDependents dependents}.
* @returns {sap.ui.core.Element} Reference to this
in order to allow method chaining
*/
public destroyDependents(): sap.ui.core.Element;
/**
* Destroys the layoutData in the aggregation {@link #getLayoutData layoutData}.
* @returns {sap.ui.core.Element} Reference to this
in order to allow method chaining
*/
public destroyLayoutData(): sap.ui.core.Element;
/**
* Destroys the tooltip in the aggregation
* named tooltip
.
* @returns {sap.ui.core.Element} this
to allow method chaining
*/
public destroyTooltip(): sap.ui.core.Element;
/**
* Allows the parent of a control to enhance the aria information during rendering.
*
* This function is called by the RenderManager's writeAccessibilityState method
* for the parent of the currently rendered control - if the parent implements it.
* @param {sap.ui.core.Element} oElement - the Control/Element for which aria properties are rendered
* @param {any} mAriaProps - map of aria properties keyed by there name (without prefix "aria-")
* @returns {any} map of enhanced aria properties
*/
protected enhanceAccessibilityState(oElement: sap.ui.core.Element, mAriaProps: any): any;
/**
* Cleans up the element instance before destruction.
*
* Applications must not call this hook method directly, it is called by the framework
* when the element is {@link #destroy destroyed}.
*
* Subclasses of Element should override this hook to implement any necessary cleanup.
*/
protected exit(): void;
/**
* Creates a new subclass of class sap.ui.core.Element with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Searches and returns an array of child elements and controls which are
* referenced within an aggregation or aggregations of child elements/controls.
* This can be either done recursive or not.
*
* Take care: this operation might be expensive.
* @param {boolean} bRecursive - true, if all nested children should be returned.
* @returns {sap.ui.core.Element[]} array of child elements and controls
*/
public findElements(bRecursive: boolean): sap.ui.core.Element[];
/**
* Fires the given event and notifies all listeners. Listeners must not change
* the content of the event.
* @param {string} sEventId - the event id
* @param {any} mParameters - the parameter map
* @returns {sap.ui.base.EventProvider|boolean} Returns this
to allow method chaining
*/
protected fireEvent(sEventId: string, mParameters: any): sap.ui.base.EventProvider|boolean;
/**
* Sets the focus to the stored focus DOM reference
*/
public focus(): void;
/**
* Gets content of aggregation {@link #getCustomData customData}.
*
* Custom Data, a data structure like a map containing arbitrary key value pairs.
* @returns {sap.ui.core.CustomData[]}
*/
public getCustomData(): sap.ui.core.CustomData[];
/**
* Gets content of aggregation {@link #getDependents dependents}.
*
* Dependents are not rendered, but their databinding context and lifecycle are bound to the aggregating Element.
* @returns {sap.ui.core.Element[]}
*/
public getDependents(): sap.ui.core.Element[];
/**
* Returns the best suitable DOM Element that represents this UI5 Element.
* By default the DOM Element with the same ID as this Element is returned.
* Subclasses should override this method if the lookup via id is not sufficient.
*
* Note that such a DOM Element does not necessarily exist in all cases.
* Some elements or controls might not have a DOM representation at all (e.g.
* a naive FlowLayout) while others might not have one due to their current
* state (e.g. an initial, not yet rendered control).
*
* If an ID suffix is given, the ID of this Element is concatenated with the suffix
* (separated by a single dash) and the DOM node with that compound ID will be returned.
* This matches the UI5 naming convention for named inner DOM nodes of a control.
* @param {string} sSuffix - ID suffix to get the DOMRef for
* @returns {HTMLElement} The Element's DOM Element sub DOM Element or null
*/
protected getDomRef(sSuffix?: string): HTMLElement;
/**
* Get the element binding object for a specific model
* @param {string} sModelName - the name of the model
* @returns {sap.ui.model.Binding} the element binding for the given model name
*/
public getElementBinding(sModelName: string): sap.ui.model.Binding;
/**
* Returns the DOM Element that should get the focus.
*
* To be overwritten by the specific control method.
* @returns {HTMLElement} Returns the DOM Element that should get the focus
*/
protected getFocusDomRef(): HTMLElement;
/**
* Returns an object representing the serialized focus information
* To be overwritten by the specific control method
* @returns {any} an object representing the serialized focus information
*/
protected getFocusInfo(): any;
/**
* @returns {sap.ui.base.Interface}
*/
public getInterface(): sap.ui.base.Interface;
/**
* Gets content of aggregation {@link #getLayoutData layoutData}.
*
* Defines the layout constraints for this control when it is used inside a Layout.
* LayoutData classes are typed classes and must match the embedding Layout.
* See VariantLayoutData for aggregating multiple alternative LayoutData instances to a single Element.
* @returns {sap.ui.core.LayoutData}
*/
public getLayoutData(): sap.ui.core.LayoutData;
/**
* Returns the runtime metadata for this UI element.
*
* When using the defineClass method, this function is automatically created and returns
* a runtime representation of the design time metadata.
* @returns {sap.ui.base.Metadata} runtime metadata
*/
public getMetadata(): sap.ui.base.Metadata;
/**
* Returns a metadata object for class sap.ui.core.Element.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the tooltip for this element if any or an undefined value.
* The tooltip can either be a simple string or a subclass of
* {@link sap.ui.core.TooltipBase}.
*
* Callers that are only interested in tooltips of type string (e.g. to render
* them as a title
attribute), should call the convenience method
* {@link #getTooltip_AsString} instead. If they want to get a tooltip text no
* matter where it comes from (be it a string tooltip or the text from a TooltipBase
* instance) then they could call {@link #getTooltip_Text} instead.
* @returns {string|sap.ui.core.TooltipBase} The tooltip for this Element.
*/
public getTooltip(): string|sap.ui.core.TooltipBase;
/**
* Returns the tooltip for this element but only if it is a simple string.
* Otherwise an undefined value is returned.
* @returns {string} string tooltip or undefined
*/
public getTooltip_AsString(): string;
/**
* Returns the main text for the current tooltip or undefined if there is no such text.
* If the tooltip is an object derived from sap.ui.core.Tooltip, then the text property
* of that object is returned. Otherwise the object itself is returned (either a string
* or undefined or null).
* @returns {string} text of the current tooltip or undefined
*/
public getTooltip_Text(): string;
/**
* Checks for the provided sap.ui.core.CustomData
in the aggregation {@link #getCustomData customData}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.CustomData} oCustomData - The customData whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfCustomData(oCustomData: sap.ui.core.CustomData): number;
/**
* Checks for the provided sap.ui.core.Element
in the aggregation {@link #getDependents dependents}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Element} oDependent - The dependent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfDependent(oDependent: sap.ui.core.Element): number;
/**
* Initializes the element instance after creation.
*
* Applications must not call this hook method directly, it is called by the framework
* while the constructor of an element is executed.
*
* Subclasses of Element should override this hook to implement any necessary initialization.
*/
protected init(): void;
/**
* Inserts a customData into the aggregation {@link #getCustomData customData}.
* @param {sap.ui.core.CustomData} oCustomData - the customData to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the customData should be inserted at; for a negative value of iIndex
, the customData is inserted at position 0; for a value greater than the current size of the aggregation, the customData is inserted at the last position
* @returns {sap.ui.core.Element} Reference to this
in order to allow method chaining
*/
public insertCustomData(oCustomData: sap.ui.core.CustomData, iIndex: number): sap.ui.core.Element;
/**
* Inserts a dependent into the aggregation {@link #getDependents dependents}.
* @param {sap.ui.core.Element} oDependent - the dependent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the dependent should be inserted at; for a negative value of iIndex
, the dependent is inserted at position 0; for a value greater than the current size of the aggregation, the dependent is inserted at the last position
* @returns {sap.ui.core.Element} Reference to this
in order to allow method chaining
*/
public insertDependent(oDependent: sap.ui.core.Element, iIndex: number): sap.ui.core.Element;
/**
* This function either calls set[sPropertyName] or get[sPropertyName] with the specified property name
* depending if an oValue
is provided or not.
* @param {string} sPropertyName - name of the property to set
* @param {any} oValue - value to set the property to
* @returns {any|sap.ui.core.Element} Returns this
to allow method chaining in case of setter and the property value in case of getter
*/
public prop(sPropertyName: string, oValue?: any): any|sap.ui.core.Element;
/**
* Removes all the controls from the aggregation {@link #getCustomData customData}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.CustomData[]} An array of the removed elements (might be empty)
*/
public removeAllCustomData(): sap.ui.core.CustomData[];
/**
* Removes all the controls from the aggregation {@link #getDependents dependents}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Element[]} An array of the removed elements (might be empty)
*/
public removeAllDependents(): sap.ui.core.Element[];
/**
* Removes a customData from the aggregation {@link #getCustomData customData}.
* @param {number|string|sap.ui.core.CustomData} vCustomData - The customData to remove or its index or id
* @returns {sap.ui.core.CustomData} The removed customData or null
*/
public removeCustomData(vCustomData: number|string|sap.ui.core.CustomData): sap.ui.core.CustomData;
/**
* Removes a dependent from the aggregation {@link #getDependents dependents}.
* @param {number|string|sap.ui.core.Element} vDependent - The dependent to remove or its index or id
* @returns {sap.ui.core.Element} The removed dependent or null
*/
public removeDependent(vDependent: number|string|sap.ui.core.Element): sap.ui.core.Element;
/**
* Removes the given delegate from this element.
*
* This method will remove all registrations of the given delegate, not only one.
* @param {any} oDelegate - the delegate object
* @returns {sap.ui.core.Element} Returns this
to allow method chaining
*/
public removeEventDelegate(oDelegate: any): sap.ui.core.Element;
/**
* This triggers immediate rerendering of its parent and thus of itself and its children.
As sap.ui.core.Element
"bubbles up" the
* rerender, changes to child-Elements
will also result in immediate rerendering of the whole sub tree.
*/
protected rerender(): void;
/**
* Sets the {@link sap.ui.core.LayoutData} defining the layout constraints
* for this control when it is used inside a layout.
* @param {sap.ui.core.LayoutData} oLayoutData
*/
public setLayoutData(oLayoutData: sap.ui.core.LayoutData): void;
/**
* Sets a new tooltip for this object. The tooltip can either be a simple string
* (which in most cases will be rendered as the title
attribute of this
* Element) or an instance of {@link sap.ui.core.TooltipBase}.
*
* If a new tooltip is set, any previously set tooltip is deactivated.
* @param {string|sap.ui.core.TooltipBase} vTooltip
*/
public setTooltip(vTooltip: string|sap.ui.core.TooltipBase): void;
/**
* Returns a simple string representation of this element.
*
* Mainly useful for tracing purposes.
* @returns {string} a string description of this element
*/
public toString(): string;
/**
* Removes the defined binding context of this object, all bindings will now resolve
* relative to the parent context again.
* @param {string} sModelName
* @returns {sap.ui.base.ManagedObject} reference to the instance itself
*/
public unbindElement(sModelName: string): sap.ui.base.ManagedObject;
}
/**
* Helper Class for enhancement of a Control with propagation of enabled property.
*
* This constructor should be applied to the prototype of a control
*
* Example:
*
* sap.ui.core.EnabledPropagator.call(Some-Control.prototype, Default-value, ...);
*
* e.g.
*
* sap.ui.core.EnabledPropagator.call(sap.ui.commons.Button.prototype);
*
*/
export class EnabledPropagator {
/**
* @param {boolean} bDefault - the value that should be used as default value for the enhancement of the control.
* @param {boolean} bLegacy - whether the introduced property should use the old name 'Enabled'
*/
public constructor(bDefault?: boolean, bLegacy?: boolean);
}
/**
* Provides eventing capabilities for applications like firing events and attaching or detaching event
* handlers for events which are notified when events are fired.
*/
export class EventBus extends sap.ui.base.Object {
/**
* Creates an instance of EventBus.
*/
public constructor();
/**
* Cleans up the internal structures and removes all event handlers.
*
* The object must not be used anymore after destroy was called.
*/
public destroy(): void;
/**
* Creates a new subclass of class sap.ui.core.EventBus with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.EventBus.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Fires an event using the specified settings and notifies all attached event handlers.
* @param {string} sEventId - The identifier of the event to fire
* @param {any} oData - The parameters which should be carried by the event
*/
public publish(sEventId: string, oData?: any): void;
/**
* Fires an event using the specified settings and notifies all attached event handlers.
* @param {string} sChannelId - The channel of the event to fire. If not given, the default channel is used. The channel "sap.ui"
is reserved by the UI5 framework. An application might listen to events on this channel but is not allowed to publish its own events there.
* @param {string} sEventId - The identifier of the event to fire
* @param {any} oData - The parameters which should be carried by the event
*/
public publish(sChannelId: string, sEventId: string, oData?: any): void;
/**
* Attaches an event handler to the event with the given identifier on the given event channel.
* @param {string} sEventId - The identifier of the event to listen for
* @param {Function} fnFunction - The handler function to call when the event occurs. This function will be called in the context of the oListener
instance (if present) or on the event bus instance. The channel is provided as first argument of the handler, and the event identifier is provided as the second argument. The parameter map carried by the event is provided as the third argument (if present). Handlers must not change the content of this map.
* @param {any} oListener - The object that wants to be notified when the event occurs (this
context within the handler function). If it is not specified, the handler function is called in the context of the event bus.
* @returns {sap.ui.core.EventBus} Returns this
to allow method chaining
*/
public subscribe(sEventId: string, fnFunction: Function, oListener?: any): sap.ui.core.EventBus;
/**
* Attaches an event handler to the event with the given identifier on the given event channel.
* @param {string} sChannelId - The channel of the event to subscribe to. If not given, the default channel is used. The channel "sap.ui"
is reserved by the UI5 framework. An application might listen to events on this channel but is not allowed to publish its own events there.
* @param {string} sEventId - The identifier of the event to listen for
* @param {Function} fnFunction - The handler function to call when the event occurs. This function will be called in the context of the oListener
instance (if present) or on the event bus instance. The channel is provided as first argument of the handler, and the event identifier is provided as the second argument. The parameter map carried by the event is provided as the third argument (if present). Handlers must not change the content of this map.
* @param {any} oListener - The object that wants to be notified when the event occurs (this
context within the handler function). If it is not specified, the handler function is called in the context of the event bus.
* @returns {sap.ui.core.EventBus} Returns this
to allow method chaining
*/
public subscribe(sChannelId: string, sEventId: string, fnFunction: Function, oListener?: any): sap.ui.core.EventBus;
/**
* Attaches an event handler, called one time only, to the event with the given identifier on the given event channel.
*
* When the event occurs, the handler function is called and the handler registration is automatically removed afterwards.
* @param {string} sEventId - The identifier of the event to listen for
* @param {Function} fnFunction - The handler function to call when the event occurs. This function will be called in the context of the oListener
instance (if present) or on the event bus instance. The channel is provided as first argument of the handler, and the event identifier is provided as the second argument. The parameter map carried by the event is provided as the third argument (if present). Handlers must not change the content of this map.
* @param {any} oListener - The object that wants to be notified when the event occurs (this
context within the handler function). If it is not specified, the handler function is called in the context of the event bus.
* @returns {sap.ui.core.EventBus} Returns this
to allow method chaining
*/
public subscribeOnce(sEventId: string, fnFunction: Function, oListener?: any): sap.ui.core.EventBus;
/**
* Attaches an event handler, called one time only, to the event with the given identifier on the given event channel.
*
* When the event occurs, the handler function is called and the handler registration is automatically removed afterwards.
* @param {string} sChannelId - The channel of the event to subscribe to. If not given, the default channel is used. The channel "sap.ui"
is reserved by the UI5 framework. An application might listen to events on this channel but is not allowed to publish its own events there.
* @param {string} sEventId - The identifier of the event to listen for
* @param {Function} fnFunction - The handler function to call when the event occurs. This function will be called in the context of the oListener
instance (if present) or on the event bus instance. The channel is provided as first argument of the handler, and the event identifier is provided as the second argument. The parameter map carried by the event is provided as the third argument (if present). Handlers must not change the content of this map.
* @param {any} oListener - The object that wants to be notified when the event occurs (this
context within the handler function). If it is not specified, the handler function is called in the context of the event bus.
* @returns {sap.ui.core.EventBus} Returns this
to allow method chaining
*/
public subscribeOnce(sChannelId: string, sEventId: string, fnFunction: Function, oListener?: any): sap.ui.core.EventBus;
/**
* Removes a previously subscribed event handler from the event with the given identifier on the given event channel.
*
* The passed parameters must match those used for registration with {@link #subscribe } beforehand!
* @param {string} sEventId - The identifier of the event to unsubscribe from
* @param {Function} fnFunction - The handler function to unsubscribe from the event
* @param {any} oListener - The object that wanted to be notified when the event occurred
* @returns {sap.ui.core.EventBus} Returns this
to allow method chaining
*/
public unsubscribe(sEventId: string, fnFunction: Function, oListener?: any): sap.ui.core.EventBus;
/**
* Removes a previously subscribed event handler from the event with the given identifier on the given event channel.
*
* The passed parameters must match those used for registration with {@link #subscribe } beforehand!
* @param {string} sChannelId - The channel of the event to unsubscribe from. If not given, the default channel is used.
* @param {string} sEventId - The identifier of the event to unsubscribe from
* @param {Function} fnFunction - The handler function to unsubscribe from the event
* @param {any} oListener - The object that wanted to be notified when the event occurred
* @returns {sap.ui.core.EventBus} Returns this
to allow method chaining
*/
public unsubscribe(sChannelId: string, sEventId: string, fnFunction: Function, oListener?: any): sap.ui.core.EventBus;
}
/**
* Format classes
*/
namespace format {
/**
* The DateFormat is a static class for formatting and parsing single date and time values or date and time intervals according
* to a set of format options.
*
* Supported format options are pattern based on Unicode LDML Date Format notation.
* If no pattern is specified a default pattern according to the locale settings is used.
*/
export class DateFormat {
/**
* Constructor for DateFormat - must not be used: To get a DateFormat instance, please use getDateInstance, getDateTimeInstance or getTimeInstance.
*/
public constructor();
/**
* Format a date according to the given format options.
* @param {Date|Date[]} vJSDate - the value to format
* @param {boolean} bUTC - whether to use UTC
* @returns {string} the formatted output value. If an invalid date is given, an empty string is returned.
*/
public format(vJSDate: Date|Date[], bUTC: boolean): string;
/**
* Get a date instance of the DateFormat, which can be used for formatting.
* @param {any} oFormatOptions - Object which defines the format options
* @param {sap.ui.core.Locale} oLocale - Locale to ask for locale specific texts/settings
* @returns {sap.ui.core.format.DateFormat} date instance of the DateFormat
*/
public static getDateInstance(oFormatOptions?: any, oLocale?: sap.ui.core.Locale): sap.ui.core.format.DateFormat;
/**
* Get a datetime instance of the DateFormat, which can be used for formatting.
* @param {any} oFormatOptions - Object which defines the format options
* @param {sap.ui.core.Locale} oLocale - Locale to ask for locale specific texts/settings
* @returns {sap.ui.core.format.DateFormat} datetime instance of the DateFormat
*/
public static getDateTimeInstance(oFormatOptions?: any, oLocale?: sap.ui.core.Locale): sap.ui.core.format.DateFormat;
/**
* Get a time instance of the DateFormat, which can be used for formatting.
* @param {any} oFormatOptions - Object which defines the format options
* @param {sap.ui.core.Locale} oLocale - Locale to ask for locale specific texts/settings
* @returns {sap.ui.core.format.DateFormat} time instance of the DateFormat
*/
public static getTimeInstance(oFormatOptions?: any, oLocale?: sap.ui.core.Locale): sap.ui.core.format.DateFormat;
/**
* Parse a string which is formatted according to the given format options.
* @param {string} sValue - the string containing a formatted date/time value
* @param {boolean} bUTC - whether to use UTC, if no timezone is contained
* @param {boolean} bStrict - to use strict value check
* @returns {Date} the parsed value
*/
public parse(sValue: string, bUTC: boolean, bStrict: boolean): Date;
}
/**
* The FileSizeFormat is a static class for formatting and parsing numeric file size values according
* to a set of format options.
*
* Supports the same options as {@link sap.ui.core.format.NumberFormat.getFloatInstance NumberFormat.getFloatInstance}
* For format options which are not specified default values according to the type and locale settings are used.
*
* Supported format options (additional to NumberFormat):
*
* - binaryFilesize: if true, base 2 is used: 1 Kibibyte = 1024 Byte, ... , otherwise base 10 is used: 1 Kilobyte = 1000 Byte (Default is false)
*
*/
export class FileSizeFormat extends sap.ui.base.Object {
/**
* Constructor for FileSizeFormat - must not be used: To get a FileSizeFormat instance, please use getInstance.
*/
public constructor();
/**
* Creates a new subclass of class sap.ui.core.format.FileSizeFormat with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Format a filesize (in bytes) according to the given format options.
* @param {number|string} oValue - the number (or hex string) to format
* @returns {string} the formatted output value
*/
public format(oValue: number|string): string;
/**
* Get an instance of the FileSizeFormat, which can be used for formatting.
*
* If no locale is given, the currently configured
* {@link sap.ui.core.Configuration.FormatSettings#getFormatLocale formatLocale} will be used.
* @param {any} oFormatOptions - Object which defines the format options
* @param {sap.ui.core.Locale} oLocale - Locale to get the formatter for
* @returns {sap.ui.core.format.FileSizeFormat} instance of the FileSizeFormat
*/
public static getInstance(oFormatOptions?: any, oLocale?: sap.ui.core.Locale): sap.ui.core.format.FileSizeFormat;
/**
* Returns a metadata object for class sap.ui.core.format.FileSizeFormat.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Parse a string which is formatted according to the given format options.
* @param {string} sValue - the string containing a formatted filesize value
* @returns {number} the parsed value in bytes
*/
public parse(sValue: string): number;
}
/**
* The NumberFormat is a static class for formatting and parsing numeric values according
* to a set of format options.
*/
export class NumberFormat extends sap.ui.base.Object {
/**
* Constructor for NumberFormat - must not be used: To get a NumberFormat instance, please use getInstance, getFloatInstance or getIntegerInstance.
* @param {any} oFormatOptions - The option object which support the following parameters. If no options is given, default values according to the type and locale settings are used.
*/
public constructor(oFormatOptions?: any);
/**
* Creates a new subclass of class sap.ui.core.format.NumberFormat with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Format a number according to the given format options.
* @param {number|any[]} oValue - the number to format or an array which contains the number to format and the sMeasure parameter
* @param {string} sMeasure - a measure which has an impact on the formatting
* @returns {string} the formatted output value
*/
public format(oValue: number|any[], sMeasure?: string): string;
/**
* Get a currency instance of the NumberFormat, which can be used for formatting.
*
* If no locale is given, the currently configured
* {@link sap.ui.core.Configuration.FormatSettings#getFormatLocale formatLocale} will be used.
*
*
* This instance has HALF_AWAY_FROM_ZERO set as default rounding mode.
* Please set the roundingMode property in oFormatOptions to change the
* default value.
*
* @param {any} oFormatOptions - Object which defines the format options
* @param {sap.ui.core.Locale} oLocale - Locale to get the formatter for
* @returns {sap.ui.core.format.NumberFormat} integer instance of the NumberFormat
*/
public static getCurrencyInstance(oFormatOptions?: any, oLocale?: sap.ui.core.Locale): sap.ui.core.format.NumberFormat;
/**
* Get a float instance of the NumberFormat, which can be used for formatting.
*
* If no locale is given, the currently configured
* {@link sap.ui.core.Configuration.FormatSettings#getFormatLocale formatLocale} will be used.
*
*
* This instance has HALF_AWAY_FROM_ZERO set as default rounding mode.
* Please set the roundingMode property in oFormatOptions to change the
* default value.
*
* @param {any} oFormatOptions - Object which defines the format options
* @param {sap.ui.core.Locale} oLocale - Locale to get the formatter for
* @returns {sap.ui.core.format.NumberFormat} float instance of the NumberFormat
*/
public static getFloatInstance(oFormatOptions?: any, oLocale?: sap.ui.core.Locale): sap.ui.core.format.NumberFormat;
/**
* Get an integer instance of the NumberFormat, which can be used for formatting.
*
* If no locale is given, the currently configured
* {@link sap.ui.core.Configuration.FormatSettings#getFormatLocale formatLocale} will be used.
*
*
* This instance has TOWARDS_ZERO set as default rounding mode.
* Please set the roundingMode property in oFormatOptions to change the
* default value.
*
* @param {any} oFormatOptions - Object which defines the format options
* @param {sap.ui.core.Locale} oLocale - Locale to get the formatter for
* @returns {sap.ui.core.format.NumberFormat} integer instance of the NumberFormat
*/
public static getIntegerInstance(oFormatOptions?: any, oLocale?: sap.ui.core.Locale): sap.ui.core.format.NumberFormat;
/**
* Returns a metadata object for class sap.ui.core.format.NumberFormat.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Get a percent instance of the NumberFormat, which can be used for formatting.
*
* If no locale is given, the currently configured
* {@link sap.ui.core.Configuration.FormatSettings#getFormatLocale formatLocale} will be used.
*
*
* This instance has HALF_AWAY_FROM_ZERO set as default rounding mode.
* Please set the roundingMode property in oFormatOptions to change the
* default value.
*
* @param {any} oFormatOptions - Object which defines the format options
* @param {sap.ui.core.Locale} oLocale - Locale to get the formatter for
* @returns {sap.ui.core.format.NumberFormat} integer instance of the NumberFormat
*/
public static getPercentInstance(oFormatOptions?: any, oLocale?: sap.ui.core.Locale): sap.ui.core.format.NumberFormat;
/**
* Parse a string which is formatted according to the given format options.
* @param {string} sValue - the string containing a formatted numeric value
* @returns {number|any[]} the parsed value or an array which contains the parsed value and the currency code (symbol) when the NumberFormat is a currency instance
*/
public parse(sValue: string): number|any[];
}
namespace NumberFormat {
/**
* Specifies a rounding behavior for numerical operations capable of discarding precision. Each rounding mode in this object indicates how the least
* significant returned digits of rounded result is to be calculated.
*/
export enum RoundingMode {
/**
* Rounding mode to round away from zero
*/
AWAY_FROM_ZERO = "AWAY_FROM_ZERO",
/**
* Rounding mode to round towards positive infinity
*/
CEILING = "CEILING",
/**
* Rounding mode to round towards negative infinity
*/
FLOOR = "FLOOR",
/**
* Rounding mode to round towards the nearest neighbor unless both neighbors are equidistant, in which case round away from zero.
*/
HALF_AWAY_FROM_ZERO = "HALF_AWAY_FROM_ZERO",
/**
* Rounding mode to round towards the nearest neighbor unless both neighbors are equidistant, in which case round towards positive infinity.
*/
HALF_CEILING = "HALF_CEILING",
/**
* Rounding mode to round towards the nearest neighbor unless both neighbors are equidistant, in which case round towards negative infinity.
*/
HALF_FLOOR = "HALF_FLOOR",
/**
* Rounding mode to round towards the nearest neighbor unless both neighbors are equidistant, in which case round towards zero.
*/
HALF_TOWARDS_ZERO = "HALF_TOWARDS_ZERO",
/**
* Rounding mode to round towards zero
*/
TOWARDS_ZERO = "TOWARDS_ZERO",
}
}
}
/**
* Fragments support the definition of light-weight stand-alone UI control trees.
* This class acts as factory which returns the UI control tree defined inside the Fragments. When used within declarative Views,
* the Fragment content is imported and seamlessly integrated into the View.
*
* Fragments are used similar as sap.ui.core.mvc.Views, but Fragments do not have a Controller on their own (they may know one, though),
* they are not a Control, they are not part of the UI tree and they have no representation in HTML.
* By default, in contrast to declarative Views, they do not do anything to guarantee ID uniqueness.
*
* But like Views they can be defined in several Formats (XML, declarative HTML, JavaScript; support for other types can be plugged in),
* the declaration syntax is the same as in declarative Views and the name and location of the Fragment files is similar to Views.
* Controller methods can also be referenced in the declarations, but as Fragments do not have their own controllers,
* this requires the Fragments to be used within a View which does have a controller.
* That controller is used, then.
*
* Do not call the Fragment constructor directly!
*
*
* Use-cases for Fragments are e.g.:
* - Modularization of UIs without fragmenting the controller structure
* - Re-use of UI parts
* - 100%-declarative definition of Views
*/
export class Fragment extends sap.ui.base.ManagedObject {
/**
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
*/
public constructor();
/**
* Returns an Element/Control by its ID in the context of the Fragment with the given ID
* @param {string} sFragmentId
* @param {string} sId
* @returns {any} Element by its ID and Fragment ID
*/
public static byId(sFragmentId: string, sId: string): any;
/**
* Returns the ID which a Control with the given ID in the context of the Fragment with the given ID would have
* @param {string} sFragmentId
* @param {string} sId
* @returns {any} the prefixed ID
*/
public static createId(sFragmentId: string, sId: string): any;
/**
* Creates a new subclass of class sap.ui.core.Fragment with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.Fragment.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getType type}.
* @returns {string} Value of property type
*/
public getType(): string;
/**
* Registers a new Fragment type
* @param {string} sType - the Fragment type. Types "XML", "HTML" and JS" are built-in and always available.
* @param {any} oFragmentImpl - an object having a property "init" of type "function" which is called on Fragment instantiation with the settings map as argument
*/
public static registerType(sType: string, oFragmentImpl: any): void;
/**
* Sets a new value for property {@link #getType type}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sType - New value for property type
* @returns {sap.ui.core.Fragment} Reference to this
in order to allow method chaining
*/
public setType(sType: string): sap.ui.core.Fragment;
}
/**
* Base Class for fragment controls.
*/
export class FragmentControl extends sap.ui.core.Control {
/**
* Fragment Control is the base class for composite controls that use a XML fragment representation
* for their visual parts. From a user perspective such controls appear as any other control, but internally the
* rendering part is added as a fragment.
* The fragment that is used should appear in the same folder as the control"s JS implementation with the file extension
* .control.xml
.
* The fragment"s content can access the interface data from the fragment control via bindings. Currently only aggregations and properties
* can be used with bindings inside a fragment.
* The exposed model that is used for internal bindings in the fragment has the default name $this
. The name will always start
* with an $
. The metadata of the derived control can define the alias with its metadata. A code example can be found below.
*
* As fragment controls compose other controls, fragment controls are only invalidated and re-rendered if explicitly defined. Additional metadata
* for invalidation can be given for properties and aggregation. The default invalidation is "none"
.
* Setting invalidate to true
for properties and aggregations sets the complete FragmentControl
* to invalidate and rerender. For templating scenarios the Fragment Control can also be forced to re-template completely. In such case set invalidate
* of the corresponding property to "template"
*
* Example:
*
* FragmentControl.extend("sap.mylib.MyFragmentControl", {
* metadata : {
* library: "sap.mylib",
* properties : {
* text: { //changing this property will not re-render the FragmentControl
* type: "string",
* defaultValue: ""
* },
* title: { //changing this property will re-render the FragmentControl as it defines invalidate: true
* type: "string",
* defaultValue: "",
* invalidate: true
* },
* value: { //changing this property will re-render the FragmentControl as it defines invalidate: true
* type: "string",
* defaultValue: "",
* invalidate: true
* },
* progress: { //changing this property will re-template the FragmentControl as it defines invalidate: true
* type: "int",
* defaultValue: "",
* invalidate: "template"
* }
* },
* defaultProperty : "text",
* aggregations : {
* items : {
* type: "sap.ui.core.Control",
* invalidate: true
* },
* header : {
* type: "sap.mylib.FancyHeader",
* multiple : false
* }
* },
* defaultAggregation : "items"
* events: {
* outerEvent : {
* parameters : {
* opener : "sap.ui.core.Control"
* }
* }
* }
* },
* //alias defaults to "this"
* alias: "mycontrolroot" //inner bindings will use model name $mycontrolroot
* //fragment defaults to {control name}.control.xml in this case sap.mylib.MyFragmentControl.control.xml
* fragment: "sap.mylib.MyFragmentControlOther.control.xml" //the name of the fragment
* });
*
*
* Internally the FragmentControl instantiates and initializes the given fragment and stores the resulting control in a hidden
* aggregation named _content
. The fragment should only include one root element.
*
* Bindings of inner controls to the interface of the Fragment Control can be done with normal binding syntax.
* Here properties are used as property bindings and aggregations are used as list bindings.
* Currently it is not possible to bind associations in a fragment.
*
* Example:
*
* <core:FragmentDefinition xmlns:m="sap.m" xmlns:core="sap.ui.core">
* <m:Text text="{$this>text}" visible="{= ${$this>text} !== ""}" />
* </core:FragmentDefinition>
*
*
* <core:FragmentDefinition xmlns:m="sap.m" xmlns:core="sap.ui.core">
* <m:VBox items="{path:"$this>texts", filters:{path:"text", operator:"Contains", value1:"Text"}, sorter:{path:"text", descending:true}}">
* <m:Text text="{$this>text}" />
* </m:VBox>
* </core:FragmentDefinition>
*
*
* <core:FragmentDefinition xmlns:m="sap.m" xmlns:core="sap.ui.core">
* <m:Button text="Press Me" press="handlePress"/>
* </core:FragmentDefinition>
*
*
* All events handled within the fragment will be dispatched to the Fragment Control. It is recommended to follow this paradigm to allow
* reuse of a Fragment Control without any dependency to controller code of the current embedding view.
*
*
* MyFragmentControl.prototype.handlePress = function() {
* this.fireOuterEvent(); // passing on the event to the outer view
* }
*
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
*/
public constructor();
/**
* Creates a new subclass of class sap.ui.core.FragmentControl with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.FragmentControl.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* History handles the history of certain controls (e.g. sap.ui.commons.SearchField).
*/
export class History extends sap.ui.base.Object {
/**
* Creates an instance of the History.
*
* Attention: The Web Storage API which is used by this class stores the data on the client.
* Therefore do not use this API for confidential information.
* @param {string} sId - id for the history
* @param {any} mSettings - optional map/JSON-object with additional settings
*/
public constructor(sId: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.History with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.History.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Configuration options for horizontal alignments of controls
*/
export enum HorizontalAlign {
/**
* Locale-specific positioning at the beginning of the line
*/
Begin = "Begin",
/**
* Centered alignment of text
*/
Center = "Center",
/**
* Locale-specific positioning at the end of the line
*/
End = "End",
/**
* Hard option for left alignment
*/
Left = "Left",
/**
* Hard option for right alignment
*/
Right = "Right",
}
/**
* Embeds standard HTML in an SAPUI5 control tree.
*
* Security Hint: By default, the HTML content (property 'content') is not sanitized and therefore
* open to XSS attacks. Applications that want to show user defined input in an HTML control, should
* either sanitize the content on their own or activate automatic sanitizing through the
* {@link #setSanitizeContent sanitizeContent} property.
*
* Although this control inherits the tooltip
aggregation/property and the
* hasStyleClass
, addStyleClass
, removeStyleClass
and
* toggleStyleClass
methods from its base class, it doesn't support them.
* Instead, the defined HTML content can contain a tooltip (title attribute) or custom CSS classes.
*
* For further hints about usage restrictions for this control, see also the documentation of the
* content
property.
*/
export class HTML extends sap.ui.core.Control {
/**
* Constructor for a new HTML.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:afterRendering afterRendering} event of this sap.ui.core.HTML
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.HTML
itself.
*
* Fired after the HTML control has been rendered. Allows to manipulate the resulting DOM.
*
* When the control doesn't have string content and no preserved DOM existed for this control,
* then this event will fire, but there won't be a DOM node for this control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.HTML
itself
* @returns {sap.ui.core.HTML} Reference to this
in order to allow method chaining
*/
public attachAfterRendering(fnFunction: Function, oListener?: any): sap.ui.core.HTML;
/**
* Attaches event handler fnFunction
to the {@link #event:afterRendering afterRendering} event of this sap.ui.core.HTML
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.HTML
itself.
*
* Fired after the HTML control has been rendered. Allows to manipulate the resulting DOM.
*
* When the control doesn't have string content and no preserved DOM existed for this control,
* then this event will fire, but there won't be a DOM node for this control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.HTML
itself
* @returns {sap.ui.core.HTML} Reference to this
in order to allow method chaining
*/
public attachAfterRendering(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.HTML;
/**
* Detaches event handler fnFunction
from the {@link #event:afterRendering afterRendering} event of this sap.ui.core.HTML
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.core.HTML} Reference to this
in order to allow method chaining
*/
public detachAfterRendering(fnFunction: Function, oListener: any): sap.ui.core.HTML;
/**
* Creates a new subclass of class sap.ui.core.HTML with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:afterRendering afterRendering} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.core.HTML} Reference to this
in order to allow method chaining
*/
protected fireAfterRendering(mParameters?: any): sap.ui.core.HTML;
/**
* Gets current value of property {@link #getContent content}.
*
* HTML content to be displayed, defined as a string.
*
* The content is converted to DOM nodes with a call to new jQuery(content)
, so any
* restrictions for the jQuery constructor apply to the content of the HTML control as well.
*
* Some of these restrictions (there might be others!) are:
*
* - the content must be enclosed in tags, pure text is not supported.
* - if the content contains script tags, they will be executed but they will not appear in the
* resulting DOM tree. When the contained code tries to find the corresponding script tag,
* it will fail.
*
*
* Please consider to consult the jQuery documentation as well.
*
* The HTML control currently doesn't prevent the usage of multiple root nodes in its DOM content
* (e.g. setContent("<div/><div/>")
), but this is not a guaranteed feature.
* The accepted content might be restricted to single root nodes in future versions.
* To notify applications about this fact, a warning is written in the log when multiple root nodes are used.
*
* When changing the content dynamically, ensure that the ID of the root node remains the same as the HTML
* control's ID. Otherwise it cannot be guaranteed that certain lifecycle events take place.
* @returns {string} Value of property content
*/
public getContent(): string;
/**
* @param {string} sSuffix - Suffix of the Element to be retrieved or empty
* @returns {HTMLElement} The element's DOM reference or null
*/
public getDomRef(sSuffix?: string): HTMLElement;
/**
* Returns a metadata object for class sap.ui.core.HTML.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPreferDOM preferDOM}.
*
* Whether existing DOM content is preferred over the given content string.
*
* There are two scenarios where this flag is relevant (when set to true):
*
* - for the initial rendering: when an HTML control is added to a UIArea for the first time
* and if the root node of that UIArea contained DOM content with the same id as the HTML
* control, then that content will be used for rendering instead of any specified string
* content
* - any follow-up rendering: when an HTML control is rendered for the second or any later
* time and the preferDOM flag is set, then the DOM from the first rendering is preserved
* and not replaced by the string content
*
*
* As preserving the existing DOM is the most common use case of the HTML control, the default value is true.
*
* Default value is true
.
* @returns {boolean} Value of property preferDOM
*/
public getPreferDOM(): boolean;
/**
* Gets current value of property {@link #getSanitizeContent sanitizeContent}.
*
* Whether to run the HTML sanitizer once the content (HTML markup) is applied or not.
*
* To configure allowed URLs please use the whitelist API via jQuery.sap.addUrlWhitelist.
*
* Default value is false
.
* @returns {boolean} Value of property sanitizeContent
*/
public getSanitizeContent(): boolean;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Specifies whether the control is visible. Invisible controls are not rendered.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Sets a new value for property {@link #getContent content}.
*
* HTML content to be displayed, defined as a string.
*
* The content is converted to DOM nodes with a call to new jQuery(content)
, so any
* restrictions for the jQuery constructor apply to the content of the HTML control as well.
*
* Some of these restrictions (there might be others!) are:
*
* - the content must be enclosed in tags, pure text is not supported.
* - if the content contains script tags, they will be executed but they will not appear in the
* resulting DOM tree. When the contained code tries to find the corresponding script tag,
* it will fail.
*
*
* Please consider to consult the jQuery documentation as well.
*
* The HTML control currently doesn't prevent the usage of multiple root nodes in its DOM content
* (e.g. setContent("<div/><div/>")
), but this is not a guaranteed feature.
* The accepted content might be restricted to single root nodes in future versions.
* To notify applications about this fact, a warning is written in the log when multiple root nodes are used.
*
* When changing the content dynamically, ensure that the ID of the root node remains the same as the HTML
* control's ID. Otherwise it cannot be guaranteed that certain lifecycle events take place.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sContent - New value for property content
* @returns {sap.ui.core.HTML} Reference to this
in order to allow method chaining
*/
public setContent(sContent: string): sap.ui.core.HTML;
/**
* Sets some new DOM content for this HTML control. The content will replace the existing content
* after the next rendering. Properties are not modified, but preferDOM should be set to true.
* @param {Element} oDom - the new DOM content
* @returns {sap.ui.core.HTML} this
to facilitate method chaining
*/
public setDOMContent(oDom: Element): sap.ui.core.HTML;
/**
* Sets a new value for property {@link #getPreferDOM preferDOM}.
*
* Whether existing DOM content is preferred over the given content string.
*
* There are two scenarios where this flag is relevant (when set to true):
*
* - for the initial rendering: when an HTML control is added to a UIArea for the first time
* and if the root node of that UIArea contained DOM content with the same id as the HTML
* control, then that content will be used for rendering instead of any specified string
* content
* - any follow-up rendering: when an HTML control is rendered for the second or any later
* time and the preferDOM flag is set, then the DOM from the first rendering is preserved
* and not replaced by the string content
*
*
* As preserving the existing DOM is the most common use case of the HTML control, the default value is true.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bPreferDOM - New value for property preferDOM
* @returns {sap.ui.core.HTML} Reference to this
in order to allow method chaining
*/
public setPreferDOM(bPreferDOM: boolean): sap.ui.core.HTML;
/**
* Sets a new value for property {@link #getSanitizeContent sanitizeContent}.
*
* Whether to run the HTML sanitizer once the content (HTML markup) is applied or not.
*
* To configure allowed URLs please use the whitelist API via jQuery.sap.addUrlWhitelist.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSanitizeContent - New value for property sanitizeContent
* @returns {sap.ui.core.HTML} Reference to this
in order to allow method chaining
*/
public setSanitizeContent(bSanitizeContent: boolean): sap.ui.core.HTML;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Specifies whether the control is visible. Invisible controls are not rendered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.ui.core.HTML} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.core.HTML;
}
/**
* Icon uses embedded font instead of pixel image. Comparing to image, Icon is easily scalable, color can be altered live and various effects can be added using css.
*
* A set of built in Icons is available and they can be fetched by calling sap.ui.core.IconPool.getIconURI and set this value to the src property on the Icon.
*/
export class Icon extends sap.ui.core.Control {
/**
* Constructor for a new Icon.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.Icon;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.core.Icon
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.Icon
itself.
*
* This event is fired when icon is pressed/activated by the user. When a handler is attached to this event, the Icon gets tab stop. If you want to disable this behavior, set the noTabStop property to true.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.Icon
itself
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.ui.core.Icon;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.core.Icon
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.Icon
itself.
*
* This event is fired when icon is pressed/activated by the user. When a handler is attached to this event, the Icon gets tab stop. If you want to disable this behavior, set the noTabStop property to true.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.Icon
itself
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.Icon;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.ui.core.Icon
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.ui.core.Icon;
/**
* Creates a new subclass of class sap.ui.core.Icon with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.ui.core.Icon;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getActiveBackgroundColor activeBackgroundColor}.
*
* Background color for Icon in active state.
* @returns {string} Value of property activeBackgroundColor
*/
public getActiveBackgroundColor(): string;
/**
* Gets current value of property {@link #getActiveColor activeColor}.
*
* This color is shown when icon is pressed/activated by the user.
* @returns {string} Value of property activeColor
*/
public getActiveColor(): string;
/**
* Gets current value of property {@link #getAlt alt}.
*
* This defines the alternative text which is used for outputting the aria-label attribute on the DOM.
* @returns {string} Value of property alt
*/
public getAlt(): string;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getBackgroundColor backgroundColor}.
*
* Background color of the Icon in normal state.
* @returns {string} Value of property backgroundColor
*/
public getBackgroundColor(): string;
/**
* Gets current value of property {@link #getColor color}.
*
* The color of the Icon. If color is not defined here, the Icon inherits the color from its DOM parent.
* @returns {string} Value of property color
*/
public getColor(): string;
/**
* Gets current value of property {@link #getDecorative decorative}.
*
* A decorative icon is included for design reasons. Accessibility tools will ignore decorative icons. Tab stop isn't affected by this property anymore and it's now controlled by the existence of press event handler and the noTabStop property.
*
* Default value is true
.
* @returns {boolean} Value of property decorative
*/
public getDecorative(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* This is the height of the DOM element which contains the Icon. Setting this property doesn't affect the size of the font. If you want to make the font bigger, increase the size property.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getHoverBackgroundColor hoverBackgroundColor}.
*
* Background color for Icon in hover state. This property has no visual effect when run on mobile device.
* @returns {string} Value of property hoverBackgroundColor
*/
public getHoverBackgroundColor(): string;
/**
* Gets current value of property {@link #getHoverColor hoverColor}.
*
* This color is shown when icon is hovered. This property has no visual effect when run on mobile device.
* @returns {string} Value of property hoverColor
*/
public getHoverColor(): string;
/**
* Returns a metadata object for class sap.ui.core.Icon.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getNoTabStop noTabStop}.
*
* Defines whether the tab stop of icon is controlled by the existence of press event handler. When it's set to false, Icon control has tab stop when press event handler is attached.
* If it's set to true, Icon control never has tab stop no matter whether press event handler exists or not.
*
* Default value is false
.
* @returns {boolean} Value of property noTabStop
*/
public getNoTabStop(): boolean;
/**
* Gets current value of property {@link #getSize size}.
*
* Since Icon uses font, this property will be applied to the css font-size property on the rendered DOM element.
* @returns {sap.ui.core.CSSSize} Value of property size
*/
public getSize(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getSrc src}.
*
* This property should be set by the return value of calling sap.ui.core.IconPool.getIconURI with an Icon name parameter and an optional collection parameter which is required when using application extended Icons. A list of standard FontIcon is available here.
* @returns {sap.ui.core.URI} Value of property src
*/
public getSrc(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getUseIconTooltip useIconTooltip}.
*
* Decides whether a default Icon tooltip should be used if no tooltip is set.
*
* Default value is true
.
* @returns {boolean} Value of property useIconTooltip
*/
public getUseIconTooltip(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* This is the width of the DOM element which contains the Icon. Setting this property doesn't affect the size of the font. If you want to make the font bigger, increase the size property.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getActiveBackgroundColor activeBackgroundColor}.
*
* Background color for Icon in active state.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sActiveBackgroundColor - New value for property activeBackgroundColor
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public setActiveBackgroundColor(sActiveBackgroundColor: string): sap.ui.core.Icon;
/**
* Sets a new value for property {@link #getActiveColor activeColor}.
*
* This color is shown when icon is pressed/activated by the user.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sActiveColor - New value for property activeColor
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public setActiveColor(sActiveColor: string): sap.ui.core.Icon;
/**
* Sets a new value for property {@link #getAlt alt}.
*
* This defines the alternative text which is used for outputting the aria-label attribute on the DOM.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAlt - New value for property alt
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public setAlt(sAlt: string): sap.ui.core.Icon;
/**
* Sets a new value for property {@link #getBackgroundColor backgroundColor}.
*
* Background color of the Icon in normal state.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sBackgroundColor - New value for property backgroundColor
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public setBackgroundColor(sBackgroundColor: string): sap.ui.core.Icon;
/**
* Sets a new value for property {@link #getColor color}.
*
* The color of the Icon. If color is not defined here, the Icon inherits the color from its DOM parent.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sColor - New value for property color
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public setColor(sColor: string): sap.ui.core.Icon;
/**
* Sets a new value for property {@link #getDecorative decorative}.
*
* A decorative icon is included for design reasons. Accessibility tools will ignore decorative icons. Tab stop isn't affected by this property anymore and it's now controlled by the existence of press event handler and the noTabStop property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bDecorative - New value for property decorative
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public setDecorative(bDecorative: boolean): sap.ui.core.Icon;
/**
* Sets a new value for property {@link #getHeight height}.
*
* This is the height of the DOM element which contains the Icon. Setting this property doesn't affect the size of the font. If you want to make the font bigger, increase the size property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.core.Icon;
/**
* Sets a new value for property {@link #getHoverBackgroundColor hoverBackgroundColor}.
*
* Background color for Icon in hover state. This property has no visual effect when run on mobile device.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sHoverBackgroundColor - New value for property hoverBackgroundColor
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public setHoverBackgroundColor(sHoverBackgroundColor: string): sap.ui.core.Icon;
/**
* Sets a new value for property {@link #getHoverColor hoverColor}.
*
* This color is shown when icon is hovered. This property has no visual effect when run on mobile device.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sHoverColor - New value for property hoverColor
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public setHoverColor(sHoverColor: string): sap.ui.core.Icon;
/**
* Sets a new value for property {@link #getNoTabStop noTabStop}.
*
* Defines whether the tab stop of icon is controlled by the existence of press event handler. When it's set to false, Icon control has tab stop when press event handler is attached.
* If it's set to true, Icon control never has tab stop no matter whether press event handler exists or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bNoTabStop - New value for property noTabStop
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public setNoTabStop(bNoTabStop: boolean): sap.ui.core.Icon;
/**
* Sets a new value for property {@link #getSize size}.
*
* Since Icon uses font, this property will be applied to the css font-size property on the rendered DOM element.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sSize - New value for property size
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public setSize(sSize: sap.ui.core.CSSSize): sap.ui.core.Icon;
/**
* Sets a new value for property {@link #getSrc src}.
*
* This property should be set by the return value of calling sap.ui.core.IconPool.getIconURI with an Icon name parameter and an optional collection parameter which is required when using application extended Icons. A list of standard FontIcon is available here.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sSrc - New value for property src
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public setSrc(sSrc: sap.ui.core.URI): sap.ui.core.Icon;
/**
* Sets a new value for property {@link #getUseIconTooltip useIconTooltip}.
*
* Decides whether a default Icon tooltip should be used if no tooltip is set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bUseIconTooltip - New value for property useIconTooltip
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public setUseIconTooltip(bUseIconTooltip: boolean): sap.ui.core.Icon;
/**
* Sets a new value for property {@link #getWidth width}.
*
* This is the width of the DOM element which contains the Icon. Setting this property doesn't affect the size of the font. If you want to make the font bigger, increase the size property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.core.Icon} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.core.Icon;
}
/**
* Semantic Colors of an icon.
*/
export enum IconColor {
/**
* Critical color
*/
Critical = "Critical",
/**
* Default color (brand color)
*/
Default = "Default",
/**
* Negative color
*/
Negative = "Negative",
/**
* Neutral color.
*/
Neutral = "Neutral",
/**
* Positive color
*/
Positive = "Positive",
}
/**
* The IconPool is a static class for retrieving or registering icons.
* It also provides helping methods for easier consumption of icons.
* There are already icons registered in IconPool, please use the Demo App named
* "Icon Explorer" to find the name of the icon.
*
* In order to use the icon inside an existing control, please call
* {@link sap.ui.core.IconPool.getIconURI} and assign the URI to the control's property
* which supports icons.
* If you want to support both, icons and standard images in your own control, please use
* the static method {@link sap.ui.core.IconPool.createControlByURI} to either create an Icon in
* case the first argument is an icon-URL or another control which you define by
* providing it as the second argument.
*/
namespace IconPool {
/**
* Register an additional icon to the sap.ui.core.IconPool.
* @param {string} iconName - the name of the icon.
* @param {string} collectionName - the name of icon collection. The built in icons are with empty collectionName, so if additional icons need to be registered in IconPool, the collectionName can't be empty.
* @param {any} iconInfo - the icon info which contains the following properties:
* @returns {any} the info object of the registered icon which has the name, collection, uri, fontFamily, content and suppressMirroring properties.
*/
function addIcon(iconName: string, collectionName: string, iconInfo: any): any;
/**
* Creates an instance of {@link sap.ui.core.Icon} if the given URI is an icon URI, otherwise the given constructor is called.
* The given URI is set to the src property of the control.
* @param {string|any} setting - contains the properties which will be used to instantiate the returned control. It should contain at least a property named src. If it's given with a string type, it will be taken as the value of src property.
* @param {Function} constructor - the constructor function which is called when the given URI isn't an icon URI
* @returns {sap.ui.core.Control} either an instance of sap.ui.core.Icon or instance created by calling the given constructor
*/
function createControlByURI(setting: string|any, constructor: Function): sap.ui.core.Control;
/**
* Returns all names of registered collections in IconPool
* @returns {any[]} An array contains all of the registered collections' names.
*/
function getIconCollectionNames(): any[];
/**
* Returns the icon url based on the given mime type
* @param {string} sMimeType - the mime type of a file (e.g. "application/zip")
* @returns {string} the icon url (e.g. "sap-icon://attachment-zip-file")
*/
function getIconForMimeType(sMimeType: string): string;
/**
* Returns an info object for the icon with the given iconName
and collectionName
.
*
* Instead of giving name and collection, a complete icon-URI can be provided as iconName
.
* The method will determine name and collection from the URI, see {@link #.isIconURI IconPool.isIconURI}
* for details.
*
* The returned info object has the following properties:
*
* string: name
Name of the icon
* string: collection
Name of the collection that contains the icon or undefined
in case of the default collection
* string: uri
Icon URI that identifies the icon
* string: fontFamily
CSS font family to use for this icon
* string: content
Character sequence that represents the icon in the icon font
* string: text
Alternative text describing the icon (optional, might be empty)
* boolean: suppressMirroring
Whether the icon needs no mirroring in right-to-left mode
*
* @param {string} iconName - Name of the icon, must not be empty
* @param {string} collectionName - Name of the icon collection; to access built-in icons, omit the collection name
* @returns {any} Info object for the icon or undefined
when the icon can't be found.
*/
function getIconInfo(iconName: string, collectionName?: string): any;
/**
* Returns all name of icons that are registered under the given collection.
* @param {string} collectionName - the name of collection where icon names are retrieved.
* @returns {any[]} An array contains all of the registered icon names under the given collection.
*/
function getIconNames(collectionName: string): any[];
/**
* Returns the URI of the icon in the pool which has the given iconName
and collectionName
.
* @param {string} iconName - Name of the icon, must not be empty
* @param {string} collectionName - Name of the icon collection; to access built-in icons, omit the collection name
* @returns {string} URI of the icon or undefined
if the icon can't be found in the IconPool
*/
function getIconURI(iconName: string, collectionName?: string): string;
/**
* Returns whether the given uri
is an icon URI.
*
* A string is an icon URI when it can be parsed as a URI and when it has one of the two forms
*
* - sap-icon://collectionName/iconName
* - sap-icon://iconName
*
* where collectionName and iconName must be non-empty.
* @param {string} uri - The URI to check
* @returns {boolean} Whether the URI matches the icon URI format
*/
function isIconURI(uri: string): boolean;
}
/**
* Marker interface for controls that can serve as a context menu.
* Implementation of this interface should implement openAsContextMenu
method.
*/
export interface IContextMenu {
}
/**
* A string type representing an Id or a name.
*
* Allowed is a sequence of characters (capital/lowercase), digits, underscores, dashes, points and/or colons.
* It may start with a character or underscore only.
*/
export type ID = string;
/**
* Marker interface for controls that can be used as content of sap.ui.layout.form.Form
* or sap.ui.layout.form.SimpleForm
.
*
* If the control's width must not be adjusted by the Form
control to meet the cell's width, the
* control must implement the getFormDoNotAdjustWidth
function and return true
.
*/
export interface IFormContent {
/**
* In the Form
control all content controls are positioned on a grid cell base. By default
* the controls use the full width of the used grid cell. But for some controls (like image controls),
* this is not the desired behavior. In this case the control must keep its original width.
* @returns {boolean} true if the Form
is not allowed to adjust the width of the control to use the cell's width
*/
getFormDoNotAdjustWidth(): boolean;
}
/**
* State of the Input Method Editor (IME) for the control.
*
* Depending on its value, it allows users to enter and edit for example Chinese characters.
*/
export enum ImeMode {
/**
* IME is used for entering characters.
*/
Active = "Active",
/**
* The value is automatically computed by the user agent.
*/
Auto = "Auto",
/**
* IME is disabled.
*/
Disabled = "Disabled",
/**
* IME is not used for entering characters.
*/
Inactive = "Inactive",
}
/**
* Provides a trigger that triggers in a set interval and calls all
* registered listeners. If the interval is <= 0 the trigger is
* switched off and won't trigger at all.
*/
export class IntervalTrigger extends sap.ui.base.Object {
/**
* Creates an instance of EventBus.
* @param {number} iInterval - is the interval the trigger should be used. If the trigger is >0 triggering starts/runs and if the interval is set to <=0 triggering stops.
*/
public constructor(iInterval: number);
/**
* Adds a listener to the list that should be triggered.
* @param {Function} fnFunction - is the called function that should be called when the trigger want to trigger the listener.
* @param {any} oListener - that should be triggered.
*/
public addListener(fnFunction: Function, oListener?: any): void;
/**
* Destructor method for objects.
*/
public destroy(): void;
/**
* Creates a new subclass of class sap.ui.core.IntervalTrigger with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {sap.ui.base.Interface}
*/
public getInterface(): sap.ui.base.Interface;
/**
* Returns a metadata object for class sap.ui.core.IntervalTrigger.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Removes corresponding listener from list.
* @param {Function} fnFunction - is the previously registered function
* @param {any} oListener - that should be removed
*/
public removeListener(fnFunction: Function, oListener?: any): void;
/**
* Sets the trigger interval. If the value is >0 triggering will start if
* there are any registered listeners. If the interval is set to <=0
* triggering will stop.
* @param {number} iInterval - sets the interval in milliseconds when a new triggering should occur.
*/
public setInterval(iInterval: number): void;
}
/**
* An InvisibleText is used to bring hidden texts to the UI for screen reader support. The hidden text can e.g. be referenced
* in the ariaLabelledBy or ariaDescribedBy associations of other controls.
*
* The inherited properties busy, busyIndicatorDelay and visible and the aggregation tooltip is not supported by this control.
*/
export class InvisibleText extends sap.ui.core.Control {
/**
* Constructor for a new InvisibleText.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.InvisibleText with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.InvisibleText.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* The text of the InvisibleText.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* @returns {sap.ui.core.InvisibleText} Returns this
to allow method chaining
*/
public setBusy(): sap.ui.core.InvisibleText;
/**
* @returns {sap.ui.core.InvisibleText} Returns this
to allow method chaining
*/
public setBusyIndicatorDelay(): sap.ui.core.InvisibleText;
/**
* Sets a new value for property {@link #getText text}.
*
* The text of the InvisibleText.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sText - New value for property text
* @returns {sap.ui.core.InvisibleText} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.core.InvisibleText;
/**
*/
public setTooltip(): void;
/**
* @returns {sap.ui.core.InvisibleText} Returns this
to allow method chaining
*/
public setVisible(): sap.ui.core.InvisibleText;
/**
* Adds this
control into the static, hidden area UI area container.
* @returns {sap.ui.core.InvisibleText} Returns this
to allow method chaining
*/
public toStatic(): sap.ui.core.InvisibleText;
}
/**
* Interface for the controls which are suitable to shrink.
*
* This means the control should still look fine when it gets smaller than its normal size,
* e.g. Text controls which can show ellipsis in case of shrink.
*
* Note: This marker interface can be implemented by controls to give a hint to the container.
* The control itself does not need to implement anything. A parent control that respects this interface
* will apply the "flex-shrink" as a CSS property which determines how much the item will shrink relative
* to the rest of the items in the container when negative free space is distributed.
*/
export interface IShrinkable {
}
/**
* A control base type.
*/
export class Item extends sap.ui.core.Element {
/**
* Constructor for a new Item.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.Item with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Enabled items can be selected.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getKey key}.
*
* Can be used as input for subsequent actions.
* @returns {string} Value of property key
*/
public getKey(): string;
/**
* Returns a metadata object for class sap.ui.core.Item.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* The text to be displayed for the item.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTextDirection textDirection}.
*
* Options are RTL and LTR. Alternatively, an item can inherit its text direction from its parent control.
*
* Default value is Inherit
.
* @returns {sap.ui.core.TextDirection} Value of property textDirection
*/
public getTextDirection(): sap.ui.core.TextDirection;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Enabled items can be selected.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.core.Item} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.core.Item;
/**
* Sets a new value for property {@link #getKey key}.
*
* Can be used as input for subsequent actions.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sKey - New value for property key
* @returns {sap.ui.core.Item} Reference to this
in order to allow method chaining
*/
public setKey(sKey: string): sap.ui.core.Item;
/**
* Sets a new value for property {@link #getText text}.
*
* The text to be displayed for the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sText - New value for property text
* @returns {sap.ui.core.Item} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.core.Item;
/**
* Sets a new value for property {@link #getTextDirection textDirection}.
*
* Options are RTL and LTR. Alternatively, an item can inherit its text direction from its parent control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Inherit
.
* @param {sap.ui.core.TextDirection} sTextDirection - New value for property textDirection
* @returns {sap.ui.core.Item} Reference to this
in order to allow method chaining
*/
public setTextDirection(sTextDirection: sap.ui.core.TextDirection): sap.ui.core.Item;
}
/**
* Marker interface for controls which are suitable for use as label.
*/
export interface Label {
}
/**
* Helper functionality for enhancement of a Label with common label functionality.
*/
namespace LabelEnablement {
/**
* This function should be called on a label control to enrich it's functionality.
*
* Usage:
* The function can be called with a control prototype:
*
* sap.ui.core.LabelEnablement.enrich(my.Label.prototype);
*
* Or the function can be called on instance level in the init function of a label control:
*
* my.Label.prototype.init: function(){
* sap.ui.core.LabelEnablement.enrich(this);
* }
*
*
* Preconditions:
* The given control must implement the interface sap.ui.core.Label and have an association 'labelFor' with cardinality 0..1.
* This function extends existing API functions. Ensure not to override this extensions AFTER calling this function.
*
* What does this function do?
*
* A mechanismn is added that ensures that a bidirectional reference between the label and it's labeled control is established:
* The label references the labeled control via the html 'for' attribute (@see sap.ui.core.LabelEnablement#writeLabelForAttribute).
* If the labeled control supports the aria-labelledby attribute. A reference to the label is added automatically.
*
* In addition an alternative to apply a for reference without influencing the labelFor association of the API is applied (e.g. used by Form).
* For this purpose the functions setAlternativeLabelFor and getLabelForRendering are added.
* @param {sap.ui.core.Control} oControl - the label control which should be enriched with further label functionality.
*/
function enrich(oControl: sap.ui.core.Control): void;
/**
* Returns an array of ids of the labels referencing the given element
* @param {sap.ui.core.Element} oElement - The element whose referencing labels should be returned
* @returns {string[]} an array of ids of the labels referencing the given element
*/
function getReferencingLabels(oElement: sap.ui.core.Element): string[];
/**
* Returns true
when the given control is required (property 'required') or one of its referencing labels, false
otherwise.
* @param {sap.ui.core.Element} oElement - The element which should be checked for its required state
* @returns {boolean} true
when the given control is required (property 'required') or one of its referencing labels, false
otherwise
*/
function isRequired(oElement: sap.ui.core.Element): boolean;
/**
* Helper function for the label control to render the html 'for' attribute. This function should be called
* at the desired location in the renderer code of the label control.
* @param {sap.ui.core.RenderManager} oRenderManager - The RenderManager that can be used for writing to the render-output-buffer.
* @param {sap.ui.core.Label} oLabel - The label for which the 'for' html attribute should be written to the render-output-buffer.
*/
function writeLabelForAttribute(oRenderManager: sap.ui.core.RenderManager, oLabel: sap.ui.core.Label): void;
}
/**
* A layout data base type.
*/
export class LayoutData extends sap.ui.core.Element {
/**
* Constructor for a new LayoutData.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.LayoutData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.LayoutData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* An item that is used in lists or list-similar controls such as DropdownBox, for example.
* The element foresees the usage of additional texts displayed in a second column.
*/
export class ListItem extends sap.ui.core.Item {
/**
* Constructor for a new ListItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.ListItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAdditionalText additionalText}.
*
* Some additional text of type string, optionally to be displayed along with this item.
* @returns {string} Value of property additionalText
*/
public getAdditionalText(): string;
/**
* Gets current value of property {@link #getIcon icon}.
*
* The icon belonging to this list item instance.
* This can be a URI to an image or an icon font URI.
* @returns {string} Value of property icon
*/
public getIcon(): string;
/**
* Returns a metadata object for class sap.ui.core.ListItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets a new value for property {@link #getAdditionalText additionalText}.
*
* Some additional text of type string, optionally to be displayed along with this item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAdditionalText - New value for property additionalText
* @returns {sap.ui.core.ListItem} Reference to this
in order to allow method chaining
*/
public setAdditionalText(sAdditionalText: string): sap.ui.core.ListItem;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* The icon belonging to this list item instance.
* This can be a URI to an image or an icon font URI.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sIcon - New value for property icon
* @returns {sap.ui.core.ListItem} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: string): sap.ui.core.ListItem;
}
/**
* The LocalBusyIndicator is a special version of the
* BusyIndicator. This one doesn't block the whole screen - it just
* blocks the corresponding control and puts a local animation over the
* control. To use the functionality of this control the corresponding
* control needs to be enabled via the 'LocalBusyIndicatorSupport'
* accordingly to the ListBox control (see the init-function of the
* ListBox).
*/
export class LocalBusyIndicator extends sap.ui.core.Control {
/**
* Constructor for a new LocalBusyIndicator.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.LocalBusyIndicator with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getHeight height}.
*
* This property is the height of the control that has to
* be covered. With this height the position of the animation can be
* properly set.
*
* Default value is 100px
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.core.LocalBusyIndicator.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getWidth width}.
*
* This property is the width of the control that has to
* be covered. With this width the position of the animation can be
* properly set.
*
* Default value is 100px
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getHeight height}.
*
* This property is the height of the control that has to
* be covered. With this height the position of the animation can be
* properly set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100px
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.core.LocalBusyIndicator} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.core.LocalBusyIndicator;
/**
* Sets a new value for property {@link #getWidth width}.
*
* This property is the width of the control that has to
* be covered. With this width the position of the animation can be
* properly set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100px
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.core.LocalBusyIndicator} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.core.LocalBusyIndicator;
}
/**
* Locale represents a locale setting, consisting of a language, script, region, variants, extensions and private use section.
*/
export class Locale extends sap.ui.base.Object {
/**
* Creates an instance of the Locale.
* @param {string} sLocaleId - the locale identifier, in format en-US or en_US.
*/
public constructor(sLocaleId: string);
/**
* Creates a new subclass of class sap.ui.core.Locale with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Get the locale extension as a single string or null
.
*
* The extension always consists of a singleton character (not 'x'),
* a dash '-' and one or more extension token, each separated
* again with a dash.
*
* Use {@link #getExtensions} to get the individual extension tokens as an array.
* @returns {string} the extension
*/
public getExtension(): string;
/**
* Get the locale extensions as an array of tokens.
*
* The leading singleton and the separating dashes are not part of the result.
* If there is no extensions section in the locale tag, an empty array is returned.
* @returns {string[]} the individual extension sections
*/
public getExtensionSubtags(): string[];
/**
* Get the locale language.
*
* Note that the case might differ from the original script tag
* (Lower case is enforced as recommended by BCP47/ISO639).
* @returns {string} the language code
*/
public getLanguage(): string;
/**
* Returns a metadata object for class sap.ui.core.Locale.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Get the locale private use section or null
.
* @returns {string} the private use section
*/
public getPrivateUse(): string;
/**
* Get the locale private use section as an array of tokens.
*
* The leading singleton and the separating dashes are not part of the result.
* If there is no private use section in the locale tag, an empty array is returned.
* @returns {string[]} the tokens of the private use section
*/
public getPrivateUseSubtags(): string[];
/**
* Get the locale region or null
if none was specified.
*
* Note that the case might differ from the original script tag
* (Upper case is enforced as recommended by BCP47/ISO3166-1).
* @returns {string} the ISO3166-1 region code (2-letter or 3-digits)
*/
public getRegion(): string;
/**
* Best guess to get a proper SAP Logon Language for this locale.
*
* Conversions taken into account:
*
* - use the language part only
* - convert old ISO639 codes to newer ones (e.g. 'iw' to 'he')
* - for Chinese, map 'Traditional Chinese' to SAP proprietary code 'zf'
* - map private extensions x-sap1q and x-sap2q to SAP pseudo languages '1Q' and '2Q'
* - remove ext. language sub tags
* - convert to uppercase
*
*
* Note that the conversion also returns a result for languages that are not
* supported by the default set of SAP languages. This method has no knowledge
* about the concrete languages of any given backend system.
* @returns {string} a language code that should
*/
public getSAPLogonLanguage(): string;
/**
* Get the locale script or null
if none was specified.
*
* Note that the case might differ from the original language tag
* (Upper case first letter and lower case reminder enforced as
* recommended by BCP47/ISO15924)
* @returns {string} the script code or null
*/
public getScript(): string;
/**
* Get the locale variants as a single string or null
.
*
* Multiple variants are separated by a dash '-'.
* @returns {string} the variant or null
*/
public getVariant(): string;
/**
* Get the locale variants as an array of individual variants.
*
* The separating dashes are not part of the result.
* If there is no variant section in the locale tag, an empty array is returned.
* @returns {string[]} the individual variant sections
*/
public getVariantSubtags(): string[];
}
/**
* Provides access to locale-specific data, like date formats, number formats, currencies, etc.
*/
export class LocaleData extends sap.ui.base.Object {
/**
* Creates an instance of LocaleData for the given locale.
* @param {sap.ui.core.Locale} oLocale - the locale
*/
public constructor(oLocale: sap.ui.core.Locale);
/**
* Creates a new subclass of class sap.ui.core.LocaleData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the defined pattern for representing the calendar week number.
* @param {string} sStyle - the style of the pattern. It can only be either "wide" or "narrow".
* @param {number} iWeekNumber - the week number
* @returns {string} the week number string
*/
public getCalendarWeek(sStyle: string, iWeekNumber: number): string;
/**
* Get combined datetime pattern with given date and and time style.
* @param {string} sDateStyle - the required style for the date part
* @param {string} sTimeStyle - the required style for the time part
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {string} the combined datetime pattern
*/
public getCombinedDateTimePattern(sDateStyle: string, sTimeStyle: string, sCalendarType?: sap.ui.core.CalendarType): string;
/**
* Get combined interval pattern using a given pattern and the fallback interval pattern.
*
* If a skeleton based pattern is not available or not wanted, this method can be used to create an interval
* pattern based on a given pattern, using the fallback interval pattern.
* @param {string} sPattern - the single date pattern to use within the interval pattern
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {string} the calculated interval pattern
*/
public getCombinedIntervalPattern(sPattern: string, sCalendarType?: sap.ui.core.CalendarType): string;
/**
* Returns the currency code which is corresponded with the given currency symbol.
* @param {string} sCurrencySymbol - The currency symbol which needs to be converted to currency code
* @returns {string} The corresponded currency code defined for the given currency symbol. The given currency symbol is returned if no currency code can be found by using the given currency symbol.
*/
public getCurrencyCodeBySymbol(sCurrencySymbol: string): string;
/**
* Returns the number of digits of the specified currency.
* @param {string} sCurrency - ISO 4217 currency code
* @returns {number} digits of the currency
*/
public getCurrencyDigits(sCurrency: string): number;
/**
* Get currency format pattern.
* @param {string} sContext - the context of the currency pattern (standard or accounting)
* @returns {string} The pattern
*/
public getCurrencyPattern(sContext: string): string;
/**
* Returns the currency symbol for the specified currency, if no symbol is found the ISO 4217 currency code is returned.
* @param {string} sCurrency - ISO 4217 currency code
* @returns {string} the currency symbol
*/
public getCurrencySymbol(sCurrency: string): string;
/**
* Get custom datetime pattern for a given skeleton format.
*
* The format string does contain pattern symbols (e.g. "yMMMd" or "Hms") and will be converted into the pattern in the used
* locale, which matches the wanted symbols best. The symbols must be in canonical order, that is:
* Era (G), Year (y/Y), Quarter (q/Q), Month (M/L), Week (w/W), Day-Of-Week (E/e/c), Day (d/D),
* Hour (h/H/k/K/), Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x)
*
* See http://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems
* @param {string} sSkeleton - the wanted skeleton format for the datetime pattern
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {string} the best matching datetime pattern
*/
public getCustomDateTimePattern(sSkeleton: string, sCalendarType?: sap.ui.core.CalendarType): string;
/**
* Get interval pattern for a given skeleton format.
*
* The format string does contain pattern symbols (e.g. "yMMMd" or "Hms") and will be converted into the pattern in the used
* locale, which matches the wanted symbols best. The symbols must be in canonical order, that is:
* Era (G), Year (y/Y), Quarter (q/Q), Month (M/L), Week (w/W), Day-Of-Week (E/e/c), Day (d/D),
* Hour (h/H/k/K/), Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x)
*
* See http://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems
* @param {string} sSkeleton - the wanted skeleton format for the datetime pattern
* @param {string} sGreatestDiff - the symbol matching the greatest difference in the two dates to format
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {string} the best matching interval pattern
*/
public getCustomIntervalPattern(sSkeleton: string, sGreatestDiff: string, sCalendarType?: sap.ui.core.CalendarType): string;
/**
* Get date pattern in format "short", "medium", "long" or "full".
* @param {string} sStyle - the required style for the date pattern
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {string} the selected date pattern
*/
public getDatePattern(sStyle: string, sCalendarType?: sap.ui.core.CalendarType): string;
/**
* Get datetime pattern in style "short", "medium", "long" or "full".
* @param {string} sStyle - the required style for the datetime pattern
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {string} the selected datetime pattern
*/
public getDateTimePattern(sStyle: string, sCalendarType?: sap.ui.core.CalendarType): string;
/**
* Get day periods in width "narrow", "abbreviated" or "wide".
* @param {string} sWidth - the required width for the day period names
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {any[]} array of day periods (AM, PM)
*/
public getDayPeriods(sWidth: string, sCalendarType?: sap.ui.core.CalendarType): any[];
/**
* Get standalone day periods in width "narrow", "abbreviated" or "wide".
* @param {string} sWidth - the required width for the day period names
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {any[]} array of day periods (AM, PM)
*/
public getDayPeriodsStandAlone(sWidth: string, sCalendarType?: sap.ui.core.CalendarType): any[];
/**
* Get day names in width "narrow", "abbreviated" or "wide".
* @param {string} sWidth - the required width for the day names
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {any[]} array of day names (starting with Sunday)
*/
public getDays(sWidth: string, sCalendarType?: sap.ui.core.CalendarType): any[];
/**
* Get stand alone day names in width "narrow", "abbreviated" or "wide".
* @param {string} sWidth - the required width for the day names
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {any[]} array of day names (starting with Sunday)
*/
public getDaysStandAlone(sWidth: string, sCalendarType?: sap.ui.core.CalendarType): any[];
/**
* Returns the short decimal formats (like 1K, 1M....).
* @param {string} sStyle - short or long
* @param {string} sNumber - 1000, 10000 ...
* @param {string} sPlural - one or other (if not exists other is used)
* @returns {string} decimal format
*/
public getDecimalFormat(sStyle: string, sNumber: string, sPlural: string): string;
/**
* Get decimal format pattern.
* @returns {string} The pattern
*/
public getDecimalPattern(): string;
/**
* Returns the display name for a time unit (second, minute, hour, day, week, month, year).
* @param {string} sType - Type (second, minute, hour, day, week, month, year)
* @param {string} sStyle - @since 1.32.10, 1.34.4 the style of the pattern. The valid values are "wide", "short" and "narrow" returns {string} display name
* @returns {any}
*/
public getDisplayName(sType: string, sStyle?: string): any;
/**
* Returns the map of era IDs to era dates.
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar
* @returns {any[]} the array of eras containing objects with either an _end or _start property with a date
*/
public getEraDates(sCalendarType?: sap.ui.core.CalendarType): any[];
/**
* Returns array of eras.
* @param {string} sWidth - the style of the era name. It can be 'wide', 'abbreviated' or 'narrow'
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar
* @returns {any[]} the array of eras
*/
public getEras(sWidth: string, sCalendarType?: sap.ui.core.CalendarType): any[];
/**
* Returns the day that usually is regarded as the first day
* of a week in the current locale.
*
* Days are encoded as integer where Sunday=0, Monday=1 etc.
*
* All week data information in the CLDR is provided for territories (countries).
* If the locale of this LocaleData doesn't contain country information (e.g. if it
* contains only a language), then the "likelySubtag" information of the CLDR
* is taken into account to guess the "most likely" territory for the locale.
* @returns {number} first day of week
*/
public getFirstDayOfWeek(): number;
/**
* Returns the interval format with the given Id (see CLDR documentation for valid Ids)
* or the fallback format if no interval format with that Id is known.
*
* The empty Id ("") might be used to retrieve the interval format fallback.
* @param {string} sId - Id of the interval format, e.g. "d-d"
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {string} interval format string with placeholders {0} and {1}
*/
public getIntervalPattern(sId: string, sCalendarType?: sap.ui.core.CalendarType): string;
/**
* Get locale specific language names.
* @returns {any} map of locale specific language names
*/
public getLanguages(): any;
/**
* Returns a metadata object for class sap.ui.core.LocaleData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the required minimal number of days for the first week of a year.
*
* This is the minimal number of days of the week which must be contained in the new year
* for the week to become the first week of the year. Depending on the country, this
* is just a single day (in the US) or at least 4 days (in most of Europe).
*
* All week data information in the CLDR is provided for territories (countries).
* If the locale of this LocaleData doesn't contain country information (e.g. if it
* contains only a language), then the "likelySubtag" information of the CLDR
* is taken into account to guess the "most likely" territory for the locale.
* @returns {number} minimal number of days
*/
public getMinimalDaysInFirstWeek(): number;
/**
* Get month names in width "narrow", "abbreviated" or "wide".
* @param {string} sWidth - the required width for the month names
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {any[]} array of month names (starting with January)
*/
public getMonths(sWidth: string, sCalendarType?: sap.ui.core.CalendarType): any[];
/**
* Get stand alone month names in width "narrow", "abbreviated" or "wide".
* @param {string} sWidth - the required width for the month names
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {any[]} array of month names (starting with January)
*/
public getMonthsStandAlone(sWidth: string, sCalendarType?: sap.ui.core.CalendarType): any[];
/**
* Get number symbol "decimal", "group", "plusSign", "minusSign", "percentSign".
* @param {string} sType - the required type of symbol
* @returns {string} the selected number symbol
*/
public getNumberSymbol(sType: string): string;
/**
* Get orientation (left-to-right or right-to-left).
* @returns {string} character orientation for this locale
*/
public getOrientation(): string;
/**
* Get percent format pattern.
* @returns {string} The pattern
*/
public getPercentPattern(): string;
/**
* Returns the preferred calendar type for the current locale which exists in {@link sap.ui.core.CalendarType}
* @returns {sap.ui.core.CalendarType} the preferred calendar type
*/
public getPreferredCalendarType(): sap.ui.core.CalendarType;
/**
* Returns the preferred hour pattern symbol (h for 12, H for 24 hours) for the current locale.
*
* returns {string} the preferred hour symbol
* @returns {any}
*/
public getPreferredHourSymbol(): any;
/**
* Get quarter names in width "narrow", "abbreviated" or "wide".
* @param {string} sWidth - the required width for the quarter names
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {any[]} array of quarters
*/
public getQuarters(sWidth: string, sCalendarType?: sap.ui.core.CalendarType): any[];
/**
* Get stand alone quarter names in width "narrow", "abbreviated" or "wide".
* @param {string} sWidth - the required width for the quarter names
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {any[]} array of quarters
*/
public getQuartersStandAlone(sWidth: string, sCalendarType?: sap.ui.core.CalendarType): any[];
/**
* Returns the relative day resource pattern (like "Today", "Yesterday", "{0} days ago") based on the given
* difference of days (0 means today, 1 means tommorrow, -1 means yesterday, ...).
* @param {number} iDiff - the difference in days
* @param {string} sStyle - @since 1.32.10, 1.34.4 the style of the pattern. The valid values are "wide", "short" and "narrow"
* @returns {string} the relative day resource pattern
*/
public getRelativeDay(iDiff: number, sStyle?: string): string;
/**
* Returns the relative resource pattern with unit 'hour' (like "in {0} hour(s)", "{0} hour(s) ago" under locale 'en') based on the given
* difference value (positive value means in the future and negative value means in the past).
*
* There's no pattern defined for 0 difference and the function returns null if 0 is given. In the 0 difference case, you can use the getRelativeMinute or getRelativeSecond
* function to format the difference using unit 'minute' or 'second'.
* @param {number} iDiff - the difference in hours
* @param {string} sStyle - @since 1.32.10, 1.34.4 the style of the pattern. The valid values are "wide", "short" and "narrow"
* @returns {string|null} the relative resource pattern in unit 'hour'. The method returns null if 0 is given as parameter.
*/
public getRelativeHour(iDiff: number, sStyle?: string): string|null;
/**
* Returns the relative resource pattern with unit 'minute' (like "in {0} minute(s)", "{0} minute(s) ago" under locale 'en') based on the given
* difference value (positive value means in the future and negative value means in the past).
*
* There's no pattern defined for 0 difference and the function returns null if 0 is given. In the 0 difference case, you can use the getRelativeSecond
* function to format the difference using unit 'second'.
* @param {number} iDiff - the difference in minutes
* @param {string} sStyle - @since 1.32.10, 1.34.4 the style of the pattern. The valid values are "wide", "short" and "narrow"
* @returns {string|null} the relative resource pattern in unit 'minute'. The method returns null if 0 is given as parameter.
*/
public getRelativeMinute(iDiff: number, sStyle?: string): string|null;
/**
* Returns the relative month resource pattern (like "This month", "Last month", "{0} months ago") based on the given
* difference of months (0 means this month, 1 means next month, -1 means last month, ...).
* @param {number} iDiff - the difference in months
* @param {string} sStyle - @since 1.32.10, 1.34.4 the style of the pattern. The valid values are "wide", "short" and "narrow"
* @returns {string} the relative month resource pattern
*/
public getRelativeMonth(iDiff: number, sStyle?: string): string;
/**
* Returns the relative format pattern with given scale (year, month, week, ...) and difference value.
* @param {string} sScale - the scale the relative pattern is needed for
* @param {number} iDiff - the difference in the given scale unit
* @param {boolean} bFuture - whether a future or past pattern should be used
* @param {string} sStyle - @since 1.32.10, 1.34.4 the style of the pattern. The valid values are "wide", "short" and "narrow"
* @returns {string} the relative format pattern
*/
public getRelativePattern(sScale: string, iDiff: number, bFuture?: boolean, sStyle?: string): string;
/**
* Returns relative time patterns for the given scales as an array of objects containing scale, value and pattern.
*
* The array may contain the following values: "year", "month", "week", "day", "hour", "minute" and "second". If
* no scales are given, patterns for all available scales will be returned.
*
* The return array will contain objects looking like:
*
* {
* scale: "minute",
* sign: 1,
* pattern: "in {0} minutes"
* }
*
* @param {string[]} aScales - The scales for which the available patterns should be returned
* @param {string} sStyle - @since 1.32.10, 1.34.4 The style of the scale patterns. The valid values are "wide", "short" and "narrow".
* @returns {any[]} An array of all relative time patterns
*/
public getRelativePatterns(aScales: string[], sStyle?: string): any[];
/**
* Returns the relative resource pattern with unit 'second' (like now, "in {0} seconds", "{0} seconds ago" under locale 'en') based on the given
* difference value (0 means now, positive value means in the future and negative value means in the past).
* @param {number} iDiff - the difference in seconds
* @param {string} sStyle - @since 1.32.10, 1.34.4 the style of the pattern. The valid values are "wide", "short" and "narrow"
* @returns {string} the relative resource pattern in unit 'second'
*/
public getRelativeSecond(iDiff: number, sStyle?: string): string;
/**
* Returns the relative week resource pattern (like "This week", "Last week", "{0} weeks ago") based on the given
* difference of weeks (0 means this week, 1 means next week, -1 means last week, ...).
* @param {number} iDiff - the difference in weeks
* @param {string} sStyle - @since 1.32.10, 1.34.4 the style of the pattern. The valid values are "wide", "short" and "narrow"
* @returns {string} the relative week resource pattern
*/
public getRelativeWeek(iDiff: number, sStyle?: string): string;
/**
* Returns the relative year resource pattern (like "This year", "Last year", "{0} year ago") based on the given
* difference of years (0 means this year, 1 means next year, -1 means last year, ...).
* @param {number} iDiff - the difference in years
* @param {string} sStyle - @since 1.32.10, 1.34.4 the style of the pattern. The valid values are "wide", "short" and "narrow"
* @returns {string} the relative year resource pattern
*/
public getRelativeYear(iDiff: number, sStyle?: string): string;
/**
* Get locale specific script names.
* @returns {any} map of locale specific script names
*/
public getScripts(): any;
/**
* Get locale specific territory names.
* @returns {any} map of locale specific territory names
*/
public getTerritories(): any;
/**
* Get time pattern in style "short", "medium", "long" or "full".
* @param {string} sStyle - the required style for the date pattern
* @param {sap.ui.core.CalendarType} sCalendarType - the type of calendar. If it's not set, it falls back to the calendar type either set in configuration or calculated from locale.
* @returns {string} the selected time pattern
*/
public getTimePattern(sStyle: string, sCalendarType?: sap.ui.core.CalendarType): string;
/**
* Returns the last day of a weekend for the given locale.
*
* Days are encoded in the same way as for {@link #getFirstDayOfWeek}.
*
* All week data information in the CLDR is provided for territories (countries).
* If the locale of this LocaleData doesn't contain country information (e.g. if it
* contains only a language), then the "likelySubtag" information of the CLDR
* is taken into account to guess the "most likely" territory for the locale.
* @returns {number} last day of weekend
*/
public getWeekendEnd(): number;
/**
* Returns the first day of a weekend for the given locale.
*
* Days are encoded in the same way as for {@link #getFirstDayOfWeek}.
*
* All week data information in the CLDR is provided for territories (countries).
* If the locale of this LocaleData doesn't contain country information (e.g. if it
* contains only a language), then the "likelySubtag" information of the CLDR
* is taken into account to guess the "most likely" territory for the locale.
* @returns {number} first day of weekend
*/
public getWeekendStart(): number;
}
/**
* The Manifest class.
*/
export class Manifest extends sap.ui.base.Object {
/**
* Creates and initializes a manifest wrapper which provides API access to
* the content of the manifest.
* @param {any} oManifest - the manifest object
* @param {any} mOptions - (optional) the configuration options
*/
public constructor(oManifest: any, mOptions?: any);
/**
* Creates a new subclass of class sap.ui.core.Manifest with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the Component name which is defined in the manifest as
* sap.ui5/componentName
or sap.app/id
* @returns {string} the component name
*/
public getComponentName(): string;
/**
* Returns the configuration of a manifest section or the value for a
* specific path. If no key is specified, the return value is null.
*
* Example:
*
* {
* "sap.ui5": {
* "dependencies": {
* "libs": {
* "sap.m": {}
* },
* "components": {
* "my.component.a": {}
* }
* }
* });
*
*
* The configuration above can be accessed in the following ways:
*
* - By section/namespace:
oManifest.getEntry("sap.ui5")
* - By path:
oManifest.getEntry("/sap.ui5/dependencies/libs")
*
*
* By section/namespace returns the configuration for the specified manifest
* section and by path allows to specify a concrete path to a dedicated entry
* inside the manifest. The path syntax always starts with a slash (/).
* @param {string} sKey - Either the manifest section name (namespace) or a concrete path
* @returns {any|null} Value of the key (could be any kind of value)
*/
public getEntry(sKey: string): any|null;
/**
* Returns the manifest defined in the metadata of the component.
* If not specified, the return value is null.
* @returns {Object} manifest.
*/
public getJson(): Object;
/**
* Returns a metadata object for class sap.ui.core.Manifest.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the raw manifest defined in the metadata of the component.
* If not specified, the return value is null.
* @returns {Object} manifest
*/
public getRawJson(): Object;
/**
* Function to load the manifest by URL
* @param {any} mOptions - the configuration options
* @returns {sap.ui.core.Manifest|Promise} Manifest object or for asynchronous calls an ECMA Script 6 Promise object will be returned.
*/
protected static load(mOptions: any): sap.ui.core.Manifest|Promise;
}
/**
*/
namespace message {
/**
* The ControlMessageProcessor implementation.
* This MessageProcessor is able to handle Messages with the following target syntax:
* 'ControlID/PropertyName'
* Creating an instance of this class using the "new" keyword always results in the same instance (Singleton).
*/
export class ControlMessageProcessor extends sap.ui.core.message.MessageProcessor {
/**
* Constructor for a new ControlMessageProcessor
*/
public constructor();
/**
* Check Messages and update controls with messages
*/
protected checkMessages(): void;
/**
* Creates a new subclass of class sap.ui.core.message.ControlMessageProcessor with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.message.MessageProcessor.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.message.ControlMessageProcessor.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Set Messages to check
* @param {{ [key: string]: any }} vMessages - map of messages: {'target': [array of messages],...}
*/
public setMessages(vMessages: { [key: string]: any }): void;
}
/**
*/
export class Message extends sap.ui.base.Object {
/**
* Constructor for a new Message.
* @param {any} mParameters - (optional) a map which contains the following parameter properties:
*/
public constructor(mParameters?: any);
/**
* Creates a new subclass of class sap.ui.core.message.Message with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.message.Message.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
*/
export class MessageManager extends sap.ui.base.EventProvider {
/**
* Constructor for a new MessageManager.
*/
public constructor();
/**
* Add messages to MessageManager
* @param {sap.ui.core.message.Message|sap.ui.core.message.Message[]} vMessages - Array of sap.ui.core.message.Message or single sap.ui.core.message.Message
*/
public addMessages(vMessages: sap.ui.core.message.Message|sap.ui.core.message.Message[]): void;
/**
* destroy MessageManager
*/
public destroy(): void;
/**
* Creates a new subclass of class sap.ui.core.message.MessageManager with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Get the MessageModel
* @returns {sap.ui.model.message.MessageModel} oMessageModel The Message Model
*/
public getMessageModel(): sap.ui.model.message.MessageModel;
/**
* Returns a metadata object for class sap.ui.core.message.MessageManager.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Register MessageProcessor
* @param {sap.ui.core.message.MessageProcessor} oProcessor - The MessageProcessor
*/
public registerMessageProcessor(oProcessor: sap.ui.core.message.MessageProcessor): void;
/**
* Register ManagedObject: Validation and Parse errors are handled by the MessageManager for this object
* @param {sap.ui.base.ManagedObject} oObject - The sap.ui.base.ManagedObject
* @param {boolean} bHandleValidation - Handle validation for this object. If set to true validation/parse events creates Messages and cancel event. If set to false only the event will be canceled, but no messages will be created
*/
public registerObject(oObject: sap.ui.base.ManagedObject, bHandleValidation: boolean): void;
/**
* Remove all messages
*/
public removeAllMessages(): void;
/**
* Remove given Messages
* @param {sap.ui.core.message.Message|sap.ui.core.message.Message[]} vMessages - The message(s) to be removed.
*/
public removeMessages(vMessages: sap.ui.core.message.Message|sap.ui.core.message.Message[]): void;
/**
* Deregister MessageProcessor
* @param {sap.ui.core.message.MessageProcessor} oProcessor - The MessageProcessor
*/
public unregisterMessageProcessor(oProcessor: sap.ui.core.message.MessageProcessor): void;
/**
* Unregister ManagedObject
* @param {sap.ui.base.ManagedObject} oObject - The sap.ui.base.ManagedObject
*/
public unregisterObject(oObject: sap.ui.base.ManagedObject): void;
}
/**
* This is an abstract base class for MessageParser objects.
*/
export class MessageParser extends sap.ui.base.Object {
/**
* Abstract MessageParser class to be inherited in back-end specific implementations.
*/
public constructor();
/**
* Creates a new subclass of class sap.ui.core.message.MessageParser with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.message.MessageParser.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the registered processor on which the events for message handling can be fired
* @returns {sap.ui.core.message.MessageProcessor} The currently set MessageProcessor or null if none is set
*/
protected getProcessor(): sap.ui.core.message.MessageProcessor;
/**
* Abstract parse method must be implemented in the inheriting class.
*/
public parse(): void;
/**
* This method is used by the model to register itself as MessageProcessor for this parser
* @param {sap.ui.core.message.MessageProcessor} oProcessor - The MessageProcessor that can be used to fire events
* @returns {sap.ui.core.message.MessageParser} Instance reference for method chaining
*/
protected setProcessor(oProcessor: sap.ui.core.message.MessageProcessor): sap.ui.core.message.MessageParser;
}
/**
* This is an abstract base class for MessageProcessor objects.
*/
export class MessageProcessor extends sap.ui.base.EventProvider {
/**
* Constructor for a new MessageProcessor
*/
public constructor();
/**
* Attach event-handler fnFunction
to the 'messageChange' event of this sap.ui.core.message.MessageProcessor
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this MessageProcessor is used.
* @returns {sap.ui.core.message.MessageProcessor} this
to allow method chaining
*/
public attachMessageChange(fnFunction: Function, oListener?: any): sap.ui.core.message.MessageProcessor;
/**
* Attach event-handler fnFunction
to the 'messageChange' event of this sap.ui.core.message.MessageProcessor
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this MessageProcessor is used.
* @returns {sap.ui.core.message.MessageProcessor} this
to allow method chaining
*/
public attachMessageChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.message.MessageProcessor;
/**
* Implement in inheriting classes
* @returns {sap.ui.model.ListBinding}
*/
public checkMessage(): sap.ui.model.ListBinding;
/**
* Destroys the MessageProcessor Instance
*/
public destroy(): void;
/**
* Detach event-handler fnFunction
from the 'sap.ui.core.message.MessageProcessor' event of this sap.ui.core.message.MessageProcessor
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.message.MessageProcessor} this
to allow method chaining
*/
public detachMessageChange(fnFunction: Function, oListener: any): sap.ui.core.message.MessageProcessor;
/**
* Creates a new subclass of class sap.ui.core.message.MessageProcessor with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event messageChange to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.message.MessageProcessor} this
to allow method chaining
*/
protected fireMessageChange(mArguments?: any): sap.ui.core.message.MessageProcessor;
/**
* Returns the ID of the MessageProcessor instance
* @returns {string} sId The MessageProcessor ID
*/
public getId(): string;
/**
* Returns a metadata object for class sap.ui.core.message.MessageProcessor.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Implement in inheriting classes
* @param {{ [key: string]: any }} vMessages - map of messages: {'target': [array of messages],...}
*/
public setMessages(vMessages: { [key: string]: any }): void;
}
}
/**
* This element used to provide messages. Rendering must be done within the control that uses this kind of element.
*
* Its default level is none.
*/
export class Message extends sap.ui.core.Element {
/**
* Constructor for a new Message.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Compares the given message with this
message. The types of
* {@link sap.ui.core.MessageType} are ordered from "Error" > "Warning" > "Success" >
* "Information" > "None".
*
* See {@link sap.ui.core.Message.compareByType}
* @param {sap.ui.core.Message} oOther - message to compare with this one
* @returns {number} returns 0
if both messages are at the same level. -1
if this
message has a lower level. 1
if this
message has a higher level.
*/
public compareByType(oOther: sap.ui.core.Message): number;
/**
* Compares two given messages with each other.
*
* The types of {@link sap.ui.core.MessageType} are ordered from "Error" > "Warning" > "Success" >
* "Information" > "None".
* @param {sap.ui.core.Message} oMessage1 - first message to compare
* @param {sap.ui.core.Message} oMessage2 - second message to compare
* @returns {number} returns 0
if both messages are at the same level. -1
if this
message has a lower level. 1
if this
message has a higher level.
*/
public static compareByType(oMessage1: sap.ui.core.Message, oMessage2: sap.ui.core.Message): number;
/**
* Creates a new subclass of class sap.ui.core.Message with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the icon's default URI depending on given size.
*
* There are default icons for messages available that can be used this way. If no
* parameter is given, the size will be 16x16 per default. If larger icons are needed,
* the parameter "32x32" might be given.
* @param {string} sSize - If parameter is not set the default icon's size will be 16x16. If parameter is set to "32x32" the icon size will be 32x32.
* @returns {sap.ui.core.URI} URI of the default icon.
*/
public getDefaultIcon(sSize: string): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIcon icon}.
*
* A possible icon URI of the message
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getLevel level}.
*
* Setting the message's level.
*
* Default value is None
.
* @returns {sap.ui.core.MessageType} Value of property level
*/
public getLevel(): sap.ui.core.MessageType;
/**
* Returns a metadata object for class sap.ui.core.Message.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getReadOnly readOnly}.
*
* Determines whether the message should be read only. This helps the application to handle a message a different way if the application differentiates between read-only and common messages.
*
* Default value is false
.
* @returns {boolean} Value of property readOnly
*/
public getReadOnly(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* Message text
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTimestamp timestamp}.
*
* Message's timestamp. It is just a simple String that will be used without any transformation. So the application that uses messages needs to format the timestamp to its own needs.
* @returns {string} Value of property timestamp
*/
public getTimestamp(): string;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* A possible icon URI of the message
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.core.Message} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.core.Message;
/**
* Sets a new value for property {@link #getLevel level}.
*
* Setting the message's level.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.MessageType} sLevel - New value for property level
* @returns {sap.ui.core.Message} Reference to this
in order to allow method chaining
*/
public setLevel(sLevel: sap.ui.core.MessageType): sap.ui.core.Message;
/**
* Sets a new value for property {@link #getReadOnly readOnly}.
*
* Determines whether the message should be read only. This helps the application to handle a message a different way if the application differentiates between read-only and common messages.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bReadOnly - New value for property readOnly
* @returns {sap.ui.core.Message} Reference to this
in order to allow method chaining
*/
public setReadOnly(bReadOnly: boolean): sap.ui.core.Message;
/**
* Sets a new value for property {@link #getText text}.
*
* Message text
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.core.Message} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.core.Message;
/**
* Sets a new value for property {@link #getTimestamp timestamp}.
*
* Message's timestamp. It is just a simple String that will be used without any transformation. So the application that uses messages needs to format the timestamp to its own needs.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTimestamp - New value for property timestamp
* @returns {sap.ui.core.Message} Reference to this
in order to allow method chaining
*/
public setTimestamp(sTimestamp: string): sap.ui.core.Message;
}
/**
* Defines the different message types of a message
*/
export enum MessageType {
/**
* Message is an error
*/
Error = "Error",
/**
* Message should be just an information
*/
Information = "Information",
/**
* Message has no specific level
*/
None = "None",
/**
* Message is a success message
*/
Success = "Success",
/**
* Message is a warning
*/
Warning = "Warning",
}
/**
*/
namespace mvc {
/**
* A generic controller implementation for the UI5 Model-View-Controller concept.
*
* Can either be used as a generic controller which is enriched on the fly with methods
* and properties (see {@link sap.ui.controller}) or as a base class for typed controllers.
*/
export class Controller extends sap.ui.base.EventProvider {
/**
* Instantiates a (MVC-style) controller. Consumers should call the constructor only in the
* typed controller scenario. In the generic controller use case, they should use
* {@link sap.ui.controller} instead.
* @param {string|any[]} sName - The name of the controller to instantiate. If a controller is defined as real sub-class, the "arguments" of the sub-class constructor should be given instead.
*/
public constructor(sName: string|any[]);
/**
* Returns an Element of the connected view with the given local ID.
*
* Views automatically prepend their own ID as a prefix to created Elements
* to make the IDs unique even in the case of multiple view instances.
* This method helps to find an element by its local ID only.
*
* If no view is connected or if the view doesn't contain an element with
* the given local ID, undefined is returned.
* @param {string} sId - View-local ID
* @returns {sap.ui.core.Element} Element by its (view local) ID
*/
public byId(sId: string): sap.ui.core.Element;
/**
* Converts a view local ID to a globally unique one by prepending
* the view ID.
*
* If no view is connected, undefined is returned.
* @param {string} sId - View-local ID
* @returns {string} Prefixed ID
*/
public createId(sId: string): string;
/**
* Creates a new subclass of class sap.ui.core.mvc.Controller with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.mvc.Controller.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets the component of the controller's view
*
* If there is no Component connected to the view or the view is not connected to the controller,
* undefined is returned.
* @returns {sap.ui.core.Component} Component instance
*/
public getOwnerComponent(): sap.ui.core.Component;
/**
* Returns the view associated with this controller or undefined.
* @returns {sap.ui.core.mvc.View} View connected to this controller.
*/
public getView(): sap.ui.core.mvc.View;
/**
* This method is called every time the View is rendered, after the HTML is placed in the DOM-Tree. It can be
* used to apply additional changes to the DOM after the Renderer has finished.
* (Even though this method is declared as "abstract", it does not need to be defined in controllers, if the
* method does not exist, it will simply not be called.)
*/
protected onAfterRendering(): void;
/**
* This method is called every time the View is rendered, before the Renderer is called and the HTML is placed in
* the DOM-Tree. It can be used to perform clean-up-tasks before re-rendering.
* (Even though this method is declared as "abstract", it does not need to be defined in controllers, if the
* method does not exist, it will simply not be called.)
*/
protected onBeforeRendering(): void;
/**
* This method is called upon desctuction of the View. The controller should perform its internal destruction in
* this hook. It is only called once per View instance, unlike the onBeforeRendering and onAfterRendering
* hooks.
* (Even though this method is declared as "abstract", it does not need to be defined in controllers, if the
* method does not exist, it will simply not be called.)
*/
protected onExit(): void;
/**
* This method is called upon initialization of the View. The controller can perform its internal setup in
* this hook. It is only called once per View instance, unlike the onBeforeRendering and onAfterRendering
* hooks.
* (Even though this method is declared as "abstract", it does not need to be defined in controllers, if the
* method does not exist, it will simply not be called.)
*/
protected onInit(): void;
/**
* Registers a callback module, which provides code enhancements for the
* lifecycle and event handler functions of a specific controller. The code
* enhancements are returned either in sync or async mode.
*
* The extension provider module provides the getControllerExtensions
function
* which returns either directly an array of objects or a Promise that returns an array
* of objects when it resolves. These objects are object literals defining the
* methods and properties of the controller in a similar way as {@link sap.ui.controller}.
*
*
* Example for a callback module definition (sync):
*
* sap.ui.define("my/custom/sync/ExtensionProvider", ['jquery.sap.global'], function(jQuery) {
* var ExtensionProvider = function() {};
* ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
* if (!bAsync && sControllerName == "my.own.Controller") {
* // IMPORTANT: only return extensions for a specific controller
* return [{
* onInit: function() {
* // Do something here...
* },
* onAfterRendering: function() {
* // Do something here...
* },
* onButtonClick: function(oEvent) {
* // Handle the button click event
* }
* }
* }];
* };
* return ExtensionProvider;
* }, true);
*
*
*
* Example for a callback module definition (async):
*
* sap.ui.define("my/custom/async/ExtensionProvider", ['jquery.sap.global'], function(jQuery) {
* var ExtensionProvider = function() {};
* ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
* if (bAsync && sControllerName == "my.own.Controller") {
* // IMPORTANT:
* // only return a Promise for a specific controller since it
* // requires the View/Controller and its parents to run in async
* // mode!
* return new Promise(function(fnResolve, fnReject) {
* fnResolve([{
* onInit: function() {
* // Do something here...
* },
* onAfterRendering: function() {
* // Do something here...
* },
* onButtonClick: function(oEvent) {
* // Handle the button click event
* }
* }]);
* }
* };
* };
* return ExtensionProvider;
* }, true);
*
*
*
* The lifecycle functions onInit
, onExit
,
* onBeforeRendering
and onAfterRendering
* are added before or after the lifecycle functions of the original
* controller. The event handler functions, such as onButtonClick
,
* are replacing the original controller's function.
*
* When using an async extension provider you need to ensure that the
* view is loaded in async mode.
*
* In both cases, return undefined
if no controller extension shall be applied.
* @param {string} sExtensionProvider - the module name of the extension provider See {@link sap.ui.controller} for an overview of the available functions for controllers.
*/
public static registerExtensionProvider(sExtensionProvider: string): void;
}
/**
* A view defined/constructed by declarative HTML.
*/
export class HTMLView extends sap.ui.core.mvc.View {
/**
* Flag for feature detection of asynchronous loading/rendering
*/
public static asyncSupport: any;
/**
* Constructor for a new mvc/HTMLView.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.mvc.HTMLView with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.mvc.View.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.mvc.HTMLView.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A View defined using JSON.
*/
export class JSONView extends sap.ui.core.mvc.View {
/**
* Flag for feature detection of asynchronous loading/rendering
*/
public static asyncSupport: any;
/**
* Constructor for a new mvc/JSONView.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.mvc.JSONView with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.mvc.View.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.mvc.JSONView.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A View defined/constructed by JavaScript code.
*/
export class JSView extends sap.ui.core.mvc.View {
/**
* Flag for feature detection of asynchronous loading/rendering
*/
public static asyncSupport: any;
/**
* Constructor for a new mvc/JSView.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* A method to be implemented by JSViews, returning the View UI.
* While for declarative View types like XMLView or JSONView the user interface definition is declared in a separate file,
* JSViews programmatically construct the UI. This happens in the createContent method which every JSView needs to implement.
* The View implementation can construct the complete UI in this method - or only return the root control and create the rest of the UI lazily later on.
* @returns {sap.ui.core.Control} a control or (typically) tree of controls representing the View user interface
*/
public createContent(): sap.ui.core.Control;
/**
* Creates a new subclass of class sap.ui.core.mvc.JSView with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.mvc.View.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* A method to be implemented by JSViews, returning the flag whether to prefix
* the IDs of controls automatically or not if the controls are created inside
* the {@link sap.ui.core.mvc.JSView#createContent} function. By default this
* feature is not activated.
*
* You can overwrite this function and return true to activate the automatic
* prefixing.
* @returns {boolean} true, if the controls IDs should be prefixed automatically
*/
protected getAutoPrefixId(): boolean;
/**
* Returns a metadata object for class sap.ui.core.mvc.JSView.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A view defined in a template.
*/
export class TemplateView extends sap.ui.core.mvc.View {
/**
* Constructor for a new mvc/TemplateView.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.mvc.TemplateView with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.mvc.View.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.mvc.TemplateView.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A base class for Views.
*
* Introduces the relationship to a Controller, some basic visual appearance settings like width and height
* and provides lifecycle events.
*/
export class View extends sap.ui.core.Control {
/**
* Constructor for a new View.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.core.mvc.View;
/**
* Attaches event handler fnFunction
to the {@link #event:afterInit afterInit} event of this sap.ui.core.mvc.View
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.mvc.View
itself.
*
* Fired when the View has parsed the UI description and instantiated the contained controls (/control tree).
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.mvc.View
itself
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public attachAfterInit(fnFunction: Function, oListener?: any): sap.ui.core.mvc.View;
/**
* Attaches event handler fnFunction
to the {@link #event:afterInit afterInit} event of this sap.ui.core.mvc.View
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.mvc.View
itself.
*
* Fired when the View has parsed the UI description and instantiated the contained controls (/control tree).
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.mvc.View
itself
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public attachAfterInit(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.mvc.View;
/**
* Attaches event handler fnFunction
to the {@link #event:afterRendering afterRendering} event of this sap.ui.core.mvc.View
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.mvc.View
itself.
*
* Fired when the View has been (re-)rendered and its HTML is present in the DOM.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.mvc.View
itself
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public attachAfterRendering(fnFunction: Function, oListener?: any): sap.ui.core.mvc.View;
/**
* Attaches event handler fnFunction
to the {@link #event:afterRendering afterRendering} event of this sap.ui.core.mvc.View
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.mvc.View
itself.
*
* Fired when the View has been (re-)rendered and its HTML is present in the DOM.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.mvc.View
itself
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public attachAfterRendering(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.mvc.View;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeExit beforeExit} event of this sap.ui.core.mvc.View
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.mvc.View
itself.
*
* Fired when the view has received the request to destroy itself, but before it has destroyed anything.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.mvc.View
itself
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public attachBeforeExit(fnFunction: Function, oListener?: any): sap.ui.core.mvc.View;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeExit beforeExit} event of this sap.ui.core.mvc.View
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.mvc.View
itself.
*
* Fired when the view has received the request to destroy itself, but before it has destroyed anything.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.mvc.View
itself
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public attachBeforeExit(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.mvc.View;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeRendering beforeRendering} event of this sap.ui.core.mvc.View
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.mvc.View
itself.
*
* Fired before this View is re-rendered. Use to unbind event handlers from HTML elements etc.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.mvc.View
itself
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public attachBeforeRendering(fnFunction: Function, oListener?: any): sap.ui.core.mvc.View;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeRendering beforeRendering} event of this sap.ui.core.mvc.View
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.mvc.View
itself.
*
* Fired before this View is re-rendered. Use to unbind event handlers from HTML elements etc.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.mvc.View
itself
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public attachBeforeRendering(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.mvc.View;
/**
* Returns an element by its ID in the context of the view.
* @param {string} sId - View local ID of the element
* @returns {sap.ui.core.Element} element by its ID or undefined
*/
public byId(sId: string): sap.ui.core.Element;
/**
* Override clone method to avoid conflict between generic cloning of content
* and content creation as defined by the UI5 Model View Controller lifecycle.
*
* For more details see the development guide section about Model View Controller in UI5.
* @param {string} sIdSuffix - a suffix to be appended to the cloned element id
* @param {string[]} aLocalIds - an array of local IDs within the cloned hierarchy (internally used)
* @returns {sap.ui.core.Element} reference to the newly created clone
*/
protected clone(sIdSuffix?: string, aLocalIds?: string[]): sap.ui.core.Element;
/**
* Convert the given view local element ID to a globally unique ID
* by prefixing it with the view ID.
* @param {string} sId - View local ID of the element
* @returns {string} prefixed id
*/
public createId(sId: string): string;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.core.mvc.View;
/**
* Detaches event handler fnFunction
from the {@link #event:afterInit afterInit} event of this sap.ui.core.mvc.View
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public detachAfterInit(fnFunction: Function, oListener: any): sap.ui.core.mvc.View;
/**
* Detaches event handler fnFunction
from the {@link #event:afterRendering afterRendering} event of this sap.ui.core.mvc.View
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public detachAfterRendering(fnFunction: Function, oListener: any): sap.ui.core.mvc.View;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeExit beforeExit} event of this sap.ui.core.mvc.View
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public detachBeforeExit(fnFunction: Function, oListener: any): sap.ui.core.mvc.View;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeRendering beforeRendering} event of this sap.ui.core.mvc.View
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public detachBeforeRendering(fnFunction: Function, oListener: any): sap.ui.core.mvc.View;
/**
* Creates a new subclass of class sap.ui.core.mvc.View with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:afterInit afterInit} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
protected fireAfterInit(mParameters?: any): sap.ui.core.mvc.View;
/**
* Fires event {@link #event:afterRendering afterRendering} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
protected fireAfterRendering(mParameters?: any): sap.ui.core.mvc.View;
/**
* Fires event {@link #event:beforeExit beforeExit} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
protected fireBeforeExit(mParameters?: any): sap.ui.core.mvc.View;
/**
* Fires event {@link #event:beforeRendering beforeRendering} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
protected fireBeforeRendering(mParameters?: any): sap.ui.core.mvc.View;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Child Controls of the view
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Returns the view's Controller instance or null for a controller-less View.
* @returns {any} Controller of this view.
*/
public getController(): any;
/**
* An (optional) method to be implemented by Views. When no controller instance is given at View instantiation time
* AND this method exists and returns the (package and class) name of a controller, the View tries to load and
* instantiate the controller and to connect it to itself.
* @returns {string} the name of the controller
*/
public getControllerName(): string;
/**
* Gets current value of property {@link #getDisplayBlock displayBlock}.
*
* Whether the CSS display should be set to "block".
* Set this to "true" if the default display "inline-block" causes a vertical scrollbar with Views that are set to 100% height.
* Do not set this to "true" if you want to display other content in the same HTML parent on either side of the View (setting to "true" may push that other content to the next/previous line).
*
* Default value is false
.
* @returns {boolean} Value of property displayBlock
*/
public getDisplayBlock(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* The height
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns the local ID of an element by removing the view ID prefix or
* null
if the ID does not contain a prefix.
* @param {string} sId - Prefixed ID
* @returns {string} ID without prefix or null
*/
public getLocalId(sId: string): string;
/**
* Returns a metadata object for class sap.ui.core.mvc.View.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the info object which is also passed to the preprocessors
* @param {boolean} bSync - Describes the view execution, true if sync
* @returns {any} Info object for the view
*/
protected getPreprocessorInfo(bSync: boolean): any;
/**
* Returns user specific data object
* @returns {any} viewData
*/
public getViewData(): any;
/**
* Gets current value of property {@link #getViewName viewName}.
*
* Name of the View
* @returns {string} Value of property viewName
*/
public getViewName(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* The width
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks if any preprocessors are active for the specified type
* @param {string} sType - Type of the preprocessor, e.g. "raw", "xml" or "controls"
* @returns {boolean} true
if a preprocessor is active
*/
protected hasPreprocessor(sType: string): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.core.mvc.View;
/**
* Creates a Promise representing the state of the view initialization.
*
* For views that are loading asynchronously (by setting async=true) this Promise is created by view
* initialization. Synchronously loading views get wrapped in an immediately resolving Promise.
* @returns {Promise} resolves with the complete view instance, reject with any thrown error
*/
public loaded(): Promise;
/**
* Register a preprocessor for all views of a specific type.
*
* The preprocessor can be registered for several stages of view initialization, which are
* dependent on the view type, e.g. "raw", "xml" or already initialized "controls". If there is a preprocessor
* passed to or activated at the view instance already, that one is used. When several preprocessors are registered
* for one hook, it has to be made sure that they do not conflict when being processed serially.
*
* It can be either a module name as string of an implementation of {@link sap.ui.core.mvc.View.Preprocessor} or a
* function with a signature according to {@link sap.ui.core.mvc.View.Preprocessor.process}.
*
* Note: Preprocessors only work in async views and will be ignored when the view is instantiated
* in sync mode by default, as this could have unexpected side effects. You may override this behaviour by setting the
* bSyncSupport
flag to true
.
* @param {string} sType - the type of content to be processed
* @param {string|Function} vPreprocessor - module path of the preprocessor implementation or a preprocessor function
* @param {string} sViewType - type of the calling view, e.g. XML
* @param {boolean} bSyncSupport - declares if the vPreprocessor ensures safe sync processing. This means the preprocessor will be executed also for sync views. Please be aware that any kind of async processing (like Promises, XHR, etc) may break the view initialization and lead to unexpected results.
* @param {boolean} bOnDemand - on-demand preprocessor which enables developers to quickly activate the preprocessor for a view, by setting preprocessors : { xml }
, for example. This should be false except for very special cases. There can only be one on-demand preprocessor per content type.
* @param {any} mSettings - optional configuration for preprocessor
*/
protected static registerPreprocessor(sType: string, vPreprocessor: string|Function, sViewType: string, bSyncSupport: boolean, bOnDemand?: boolean, mSettings?: any): void;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Executes preprocessors for a type of source
* @param {string} sType - the type of preprocessor, e.g. "raw", "xml" or "controls"
* @param {any|string|Element} vSource - the view source as a JSON object, a raw text, an XML document element or a Promise resolving with those
* @param {boolean} bSync - describes the view execution, true if sync
* @returns {Promise|any|string|Element} a promise resolving with the processed source or an error | the source when bSync=true
*/
protected runPreprocessor(sType: string, vSource: any|string|Element, bSync?: boolean): Promise|any|string|Element;
/**
* Sets a new value for property {@link #getDisplayBlock displayBlock}.
*
* Whether the CSS display should be set to "block".
* Set this to "true" if the default display "inline-block" causes a vertical scrollbar with Views that are set to 100% height.
* Do not set this to "true" if you want to display other content in the same HTML parent on either side of the View (setting to "true" may push that other content to the next/previous line).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bDisplayBlock - New value for property displayBlock
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public setDisplayBlock(bDisplayBlock: boolean): sap.ui.core.mvc.View;
/**
* Sets a new value for property {@link #getHeight height}.
*
* The height
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.core.mvc.View;
/**
* Sets a new value for property {@link #getViewName viewName}.
*
* Name of the View
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sViewName - New value for property viewName
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public setViewName(sViewName: string): sap.ui.core.mvc.View;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The width
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.core.mvc.View} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.core.mvc.View;
}
namespace View {
/**
* Interface for Preprocessor implementations that can be hooked in the view life cycle.
*
* There are two possibilities to use the preprocessor. It can be either passed to the view via the mSettings.preprocessors object
* where it is the executed only for this instance, or by the registerPreprocessor method of the view type. Currently this is
* available only for XMLViews (as of version 1.30).
*/
export interface Preprocessor {
/**
* Processing method that must be implemented by a Preprocessor.
* @param {any} vSource - the source to be processed
* @param {any} oViewInfo - identification information about the calling instance
* @param {any} mSettings - settings object containing the settings provided with the preprocessor
* @returns {any|Promise} the processed resource or a promise which resolves with the processed resource or an error according to the declared preprocessor sync capability
*/
process(vSource: any, oViewInfo: any, mSettings?: any): any|Promise;
}
}
/**
* Specifies possible view types
*/
export enum ViewType {
/**
* HTML view
*/
HTML = "HTML",
/**
* JS View
*/
JS = "JS",
/**
* JSON View
*/
JSON = "JSON",
/**
* Template View
*/
Template = "Template",
/**
* XML view
*/
XML = "XML",
}
/**
* A View defined using (P)XML and HTML markup.
*
* Note:
* Be aware that modifications of the content aggregation of this control are not supported due to technical reasons.
* This includes calls to all content modifying methods like addContent>
etc., but also the implicit
* removal of controls contained by the content aggregation. For example the destruction of a Control via the
* destroy
method. All functions can be called but may not work properly or lead to unexpected side effects.
*
* Note:
* On root level, you can only define content for the default aggregation, e.g. without adding the <content>
tag. If
* you want to specify content for another aggregation of a view like dependents
, place it in a child
* control's dependents aggregation or add it by using {@link sap.ui.core.mvc.XMLView#addDependent}.
*/
export class XMLView extends sap.ui.core.mvc.View {
/**
* Flag for feature detection of asynchronous loading/rendering
*/
public static asyncSupport: any;
/**
* Constructor for a new mvc/XMLView.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
*
* This class does not have its own settings, but all settings applicable to the base type
* {@link sap.ui.core.mvc.View#constructor sap.ui.core.mvc.View} can be used.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.mvc.XMLView with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.mvc.View.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.mvc.XMLView.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Register a preprocessor for all views of a specific type.
*
* The preprocessor can be registered for several stages of view initialization, for xml views these are
* either the plain "xml" or the already initialized "controls" , see {@link sap.ui.core.mvc.XMLView.PreprocessorType}.
* For each type one preprocessor is executed. If there is a preprocessor passed to or activated at the
* view instance already, that one is used. When several preprocessors are registered for one hook, it has to be made
* sure, that they do not conflict when beeing processed serially.
*
* It can be either a module name as string of an implementation of {@link sap.ui.core.mvc.View.Preprocessor} or a
* function with a signature according to {@link sap.ui.core.mvc.View.Preprocessor.process}.
*
* Note: Preprocessors work only in async views and will be ignored when the view is instantiated
* in sync mode by default, as this could have unexpected side effects. You may override this behaviour by setting the
* bSyncSupport flag to true.
* @param {string|sap.ui.core.mvc.XMLView.PreprocessorType} sType - the type of content to be processed
* @param {string|Function} vPreprocessor - module path of the preprocessor implementation or a preprocessor function
* @param {boolean} bSyncSupport - declares if the vPreprocessor ensures safe sync processing. This means the preprocessor will be executed also for sync views. Please be aware that any kind of async processing (like Promises, XHR, etc) may break the view initialization and lead to unexpected results.
* @param {boolean} bOnDemand - ondemand preprocessor which enables developers to quickly activate the preprocessor for a view, by setting preprocessors : { xml }
, for example.
* @param {any} mSettings - optional configuration for preprocessor
*/
public static registerPreprocessor(sType: string|sap.ui.core.mvc.XMLView.PreprocessorType, vPreprocessor: string|Function, bSyncSupport: boolean, bOnDemand?: boolean, mSettings?: any): void;
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public static registerPreprocessor(...args: any[]): any;
}
namespace XMLView {
/**
* Specifies the available preprocessor types for XMLViews
*/
export enum PreprocessorType {
/**
* This preprocessor receives the control tree produced through the view source
*/
CONTROLS = "CONTROLS",
/**
* This preprocessor receives a valid xml source for View creation without any template tags but with control
* declarations. These include their full IDs by which they can also be queried during runtime.
*/
VIEWXML = "VIEWXML",
/**
* This preprocessor receives the plain xml source of the view and should also return a valid
* xml ready for view creation
*/
XML = "XML",
}
}
}
/**
* Defines the different possible states of an element that can be open or closed and does not only
* toggle between these states, but also spends some time in between (e.g. because of an animation).
*/
export enum OpenState {
/**
* Closed and currently not changing states.
*/
CLOSED = "CLOSED",
/**
* Still open, but in the process of going to the CLOSED state.
*/
CLOSING = "CLOSING",
/**
* Open and currently not changing states.
*/
OPEN = "OPEN",
/**
* Already left the CLOSED state, is not OPEN yet, but in the process of getting OPEN.
*/
OPENING = "OPENING",
}
/**
* Orientation of a UI element
*/
export enum Orientation {
/**
* Arrange Horizontally
*/
Horizontal = "Horizontal",
/**
* Arrange Vertically
*/
Vertical = "Vertical",
}
/**
* A string type that represents a percentage value.
*/
export type Percentage = string;
/**
* Popup Class is a helper class for controls that want themselves or
* parts of themselves or even other aggregated or composed controls
* or plain HTML content to popup on the screen like menues, dialogs, drop down boxes.
*
* It allows the controls to be aligned to other dom elements
* using the {@link sap.ui.core.Popup.Dock} method. With it you can define where
* the popup should be docked. One can dock the popup to the top bottom left or right side
* of a dom ref.
*
* In the case that the popup has no space to show itself in the view port
* of the current window it tries to open itself to
* the inverted direction.
*
* Since 1.12.3 it is possible to add further DOM-element-ids that can get the focus
* when 'autoclose' is enabled. E.g. the RichTextEditor with running TinyMCE uses this method to
* be able to focus the Popups of the TinyMCE if the RichTextEditor runs within a Popup/Dialog etc.
*
* To provide an additional DOM-element that can get the focus the following should be done:
* // create an object with the corresponding DOM-id
* var oObject = {
* id : "this_is_the_most_valuable_id_of_the_DOM_element"
* };
*
* // add the event prefix for adding an element to the ID of the corresponding Popup
* var sEventId = "sap.ui.core.Popup.addFocusableContent-" + oPopup.getId();
*
* // fire the event with the created event-id and the object with the DOM-id
* sap.ui.getCore().getEventBus().publish("sap.ui", sEventId, oObject);
*/
export class Popup extends sap.ui.base.ManagedObject {
/**
* Creates an instance of sap.ui.core.Popup
that can be used to open controls as a Popup,
* visually appearing in front of other controls.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {sap.ui.core.Control|sap.ui.core.Element|HTMLElement} oContent - the content to render in the popup. In case of sap.ui.core.Element or DOMNode, the content must be present in the page (i.e. rendered). In case of sap.ui.core.Control, the Popup ensures rendering before opening.
* @param {boolean} bModal - whether the popup should be opened in a modal way (i.e. with blocking background). Setting this to "true" effectively blocks all attempts to focus content outside the modal popup. A modal popup also automatically sets the focus back to whatever was focused when the popup opened.
* @param {boolean} bShadow - whether the popup should be have a visual shadow underneath (shadow appearance depends on active theme and browser support)
* @param {boolean} bAutoClose - whether the popup should automatically close when the focus moves out of the popup
*/
public constructor(oContent: sap.ui.core.Control|sap.ui.core.Element|HTMLElement, bModal?: boolean, bShadow?: boolean, bAutoClose?: boolean);
/**
* Attaches event handler fnFunction
to the {@link #event:closed closed} event of this sap.ui.core.Popup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.Popup
itself.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.Popup
itself
* @returns {sap.ui.core.Popup} Reference to this
in order to allow method chaining
*/
public attachClosed(fnFunction: Function, oListener?: any): sap.ui.core.Popup;
/**
* Attaches event handler fnFunction
to the {@link #event:closed closed} event of this sap.ui.core.Popup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.Popup
itself.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.Popup
itself
* @returns {sap.ui.core.Popup} Reference to this
in order to allow method chaining
*/
public attachClosed(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.Popup;
/**
* Attaches event handler fnFunction
to the {@link #event:opened opened} event of this sap.ui.core.Popup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.Popup
itself.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.Popup
itself
* @returns {sap.ui.core.Popup} Reference to this
in order to allow method chaining
*/
public attachOpened(fnFunction: Function, oListener?: any): sap.ui.core.Popup;
/**
* Attaches event handler fnFunction
to the {@link #event:opened opened} event of this sap.ui.core.Popup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.Popup
itself.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.Popup
itself
* @returns {sap.ui.core.Popup} Reference to this
in order to allow method chaining
*/
public attachOpened(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.Popup;
/**
* Closes the popup.
*
* If the Popup is already closed or in the process of closing, calling this method does nothing.
* If the Popup is in the process of being opened and closed with a duration of 0, calling this method does nothing.
* If the Popup is in the process of being opened and closed with an animation duration, the animation will be chained, but this functionality is dangerous,
* may lead to inconsistent behavior and is thus not recommended and may even be removed.
* @param {number} iDuration - animation duration in milliseconds; default is the jQuery preset "fast". For iDuration == 0 the closing happens synchronously without animation.
*/
public close(iDuration?: number): void;
/**
* Closes and destroys this instance of Popup.
* Does not destroy the hosted content.
*/
public destroy(): void;
/**
* Detaches event handler fnFunction
from the {@link #event:closed closed} event of this sap.ui.core.Popup
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.core.Popup} Reference to this
in order to allow method chaining
*/
public detachClosed(fnFunction: Function, oListener: any): sap.ui.core.Popup;
/**
* Detaches event handler fnFunction
from the {@link #event:opened opened} event of this sap.ui.core.Popup
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.core.Popup} Reference to this
in order to allow method chaining
*/
public detachOpened(fnFunction: Function, oListener: any): sap.ui.core.Popup;
/**
* When the Popup is being destroyed all corresponding references should be
* deleted as well to prevent any memory leaks.
*/
public exit(): void;
/**
* Creates a new subclass of class sap.ui.core.Popup with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:closed closed} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.core.Popup} Reference to this
in order to allow method chaining
*/
protected fireClosed(mParameters?: any): sap.ui.core.Popup;
/**
* Fires event {@link #event:opened opened} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.core.Popup} Reference to this
in order to allow method chaining
*/
protected fireOpened(mParameters?: any): sap.ui.core.Popup;
/**
* Determines whether the pop-up should auto closes or not.
* @returns {boolean}
*/
public getAutoClose(): boolean;
/**
* Returns this Popup's content.
* @returns {sap.ui.core.Control|HTMLElement} the content that has been set previously (if any)
*/
public getContent(): sap.ui.core.Control|HTMLElement;
/**
* This returns true/false if the default followOf method should be used. If a separate followOf-handler was previously added
* the correspodning function is returned.
* @returns {boolean|Function} if a function was set it is returned otherwise a boolean value whether the follow of is activated
*/
public getFollowOf(): boolean|Function;
/**
* Returns the last z-index that has been handed out. does not increase the internal z-index counter.
* @returns {number}
*/
public getLastZIndex(): number;
/**
* Returns the last z-index that has been handed out. does not increase the internal z-index counter.
* @returns {number}
*/
public static getLastZIndex(): number;
/**
* Returns a metadata object for class sap.ui.core.Popup.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the value if a Popup is of modal type
* @returns {any} {boolean] bModal whether the Popup is of modal type
*/
public getModal(): any;
/**
* Returns the next available z-index on top of the existing/previous popups. Each call increases the internal z-index counter and the returned z-index.
* @returns {number} the next z-index on top of the Popup stack
*/
public getNextZIndex(): number;
/**
* Returns the next available z-index on top of the existing/previous popups. Each call increases the internal z-index counter and the returned z-index.
* @returns {number} the next z-index on top of the Popup stack
*/
public static getNextZIndex(): number;
/**
* Returns whether the Popup is currently open, closed, or transitioning between these states.
* @returns {sap.ui.core.OpenState} whether the Popup is opened
*/
public getOpenState(): sap.ui.core.OpenState;
/**
* Returns whether the Popup is currently open (this includes opening and
* closing animations).
* @returns {boolean} whether the Popup is opened (or currently being opened or closed)
*/
public isOpen(): boolean;
/**
* Opens the popup's content at the position either specified here or beforehand via {@link #setPosition}.
* Content must be capable of being positioned via "position:absolute;"
* All parameters are optional (open() may be called without any parameters). iDuration may just be omitted, but if any of "at", "of", "offset", "collision" is given, also the preceding positioning parameters ("my", at",...) must be given.
*
* If the Popup's OpenState is different from "CLOSED" (i.e. if the Popup is already open, opening or closing), the call is ignored.
* @param {number} iDuration - animation duration in milliseconds; default is the jQuery preset "fast". For iDuration == 0 the opening happens synchronously without animation.
* @param {sap.ui.core.Popup.Dock} my - the popup content's reference position for docking
* @param {sap.ui.core.Popup.Dock} at - the "of" element's reference point for docking to
* @param {string|sap.ui.core.Element|HTMLElement|JQuery|JQueryEventObject} of - specifies the reference element to which the given content should dock to
* @param {string} offset - the offset relative to the docking point, specified as a string with space-separated pixel values (e.g. "0 10" to move the popup 10 pixels to the right). If the docking of both "my" and "at" are both RTL-sensitive ("begin" or "end"), this offset is automatically mirrored in the RTL case as well.
* @param {string} collision - defines how the position of an element should be adjusted in case it overflows the window in some direction.
* @param {boolean} followOf - defines whether the popup should follow the dock reference when the reference changes its position.
*/
public open(iDuration?: number, my?: sap.ui.core.Popup.Dock, at?: sap.ui.core.Popup.Dock, of?: string|sap.ui.core.Element|HTMLElement|JQuery|JQueryEventObject, offset?: string, collision?: string, followOf?: boolean): void;
/**
* Sets the animation functions to use for opening and closing the Popup. Any null value will be ignored and not change the respective animation function.
* When called, the animation functions receive three parameters:
* - the jQuery object wrapping the DomRef of the popup
* - the requested animation duration
* - a function that MUST be called once the animation has completed
* @param {Function} fnOpen
* @param {Function} fnClose
* @returns {sap.ui.core.Popup} this
to allow method chaining
*/
public setAnimations(fnOpen: Function, fnClose: Function): sap.ui.core.Popup;
/**
* Used to specify whether the Popup should close as soon as
* - for non-touch environment: the focus leaves
* - for touch environment: user clicks the area which is outside the popup itself, the dom elemnt which popup aligns to (except document),
* and one of the autoCloseAreas set by calling setAutoCloseAreas.
* @param {boolean} bAutoClose - whether the Popup should close as soon as the focus leaves
* @returns {sap.ui.core.Popup} this
to allow method chaining
*/
public setAutoClose(bAutoClose: boolean): sap.ui.core.Popup;
/**
* Sets the additional areas in the page that are considered part of the Popup when autoclose is enabled.
* - non-touch environment: if the focus leaves the Popup but immediately enters one of these areas, the Popup does NOT close.
* - touch environment: if user clicks one of these areas, the Popup does NOT close.
* @param {HTMLElement[]|sap.ui.core.Element[]|string[]} aAutoCloseAreas - an array containing DOM elements, sap.ui.core.Element or an ID which are considered part of the Popup; a value of null removes all previous areas
* @returns {sap.ui.core.Popup} this
to allow method chaining
*/
public setAutoCloseAreas(aAutoCloseAreas: HTMLElement[]|sap.ui.core.Element[]|string[]): sap.ui.core.Popup;
/**
* Sets the content this instance of the Popup should render.
* Content must be capable of being positioned via position:absolute;
* @param {sap.ui.core.Control|HTMLElement} oContent
* @returns {sap.ui.core.Popup} this
to allow method chaining
*/
public setContent(oContent: sap.ui.core.Control|HTMLElement): sap.ui.core.Popup;
/**
* Sets the durations for opening and closing animations.
* Null values and values < 0 are ignored.
* A duration of 0 means no animation.
* Default value is "fast" which is the jQuery constant for "200 ms".
* @param {number} iOpenDuration - in milliseconds
* @param {number} iCloseDuration - in milliseconds
* @returns {sap.ui.core.Popup} this
to allow method chaining
*/
public setDurations(iOpenDuration: number, iCloseDuration: number): sap.ui.core.Popup;
/**
* This enabled/disables the Popup to follow its opening reference. If the Popup is open and a followOf should
* be set the corresponding listener will be attached.
* @param {boolean|Function|null} followOf - a boolean value enabled/disables the default followOf-Handler. Or an individual handler can be given. null deletes all followOf settings.
*/
public setFollowOf(followOf: boolean|Function|null): void;
/**
* Sets the ID of the element that should be focused once the popup opens.
* If the given ID is the ID of an existing Control, this Control's focusDomRef will be focused instead, which may be an HTML element with a different ID (usually a sub-element inside the Control).
* If no existing element ID is supplied and the Popup is modal or auto-close, the Popup will instead focus the first focusable element.
* @param {string} sId - the ID of the DOM element to focus
*/
public setInitialFocusId(sId: string): void;
/**
* Set an initial z-index that should be used by all Popup so all Popups start at least
* with the set z-index.
* If the given z-index is lower than any current available z-index the highest z-index will be used.
* @param {number} iInitialZIndex - is the initial z-index
*/
public static setInitialZIndex(iInitialZIndex: number): void;
/**
* Used to specify whether the Popup should be modal. A modal popup will put some fading "block layer" over the background and
* prevent attempts to put the focus outside/below the popup.
* Setting this while the popup is open will change "block layer" immediately.
* @param {boolean} bModal - whether the Popup is of modal type
* @param {string} sModalCSSClass - a CSS class (or space-separated list of classes) that should be added to the block layer
* @returns {sap.ui.core.Popup} this
to allow method chaining
*/
public setModal(bModal: boolean, sModalCSSClass?: string): sap.ui.core.Popup;
/**
* Sets the position of the Popup (if you refer to a Control as anchor then do not
* use the DOMRef of the control which might change after re-renderings).
* Optional parameters can only be omitted when all subsequent parameters are omitted as well.
* @param {sap.ui.core.Popup.Dock} my - specifies which point of the given Content should be aligned
* @param {sap.ui.core.Popup.Dock|Object} at - specifies the point of the reference element to which the given Content should be aligned
* @param {string|sap.ui.core.Element|HTMLElement|JQuery|JQueryEventObject} of - specifies the reference element to which the given content should be aligned as specified in the other parameters
* @param {string} offset - the offset relative to the docking point, specified as a string with space-separated pixel values (e.g. "0 10" to move the popup 10 pixels to the right). If the docking of both "my" and "at" are both RTL-sensitive ("begin" or "end"), this offset is automatically mirrored in the RTL case as well.
* @param {string} collision - defines how the position of an element should be adjusted in case it overflows the window in some direction. The valid values that refer to jQuery-UI's position parameters are "flip", "fit" and "none".
* @returns {sap.ui.core.Popup} this
to allow method chaining
*/
public setPosition(my: sap.ui.core.Popup.Dock, at: sap.ui.core.Popup.Dock|Object, of?: string|sap.ui.core.Element|HTMLElement|JQuery|JQueryEventObject, offset?: string, collision?: string): sap.ui.core.Popup;
/**
* Determines whether the Popup should have a shadow (in supporting browsers).
* This also affects a currently open popup.
* @param {boolean} bShowShadow - whether to show a shadow
* @returns {sap.ui.core.Popup} this
to allow method chaining
*/
public setShadow(bShowShadow: boolean): sap.ui.core.Popup;
}
namespace Popup {
/**
* Enumeration providing options for docking of some element to another.
* "Right" and "Left" will stay the same in RTL mode, but "Begin" and "End" will flip to the other side ("Begin" is "Right" in RTL).
*/
export enum Dock {
BeginTop = "begin top",
BeginCenter = "begin center",
BeginBottom = "begin bottom",
LeftTop = "left top",
LeftCenter = "left center",
LeftBottom = "left bottom",
CenterTop = "center top",
CenterCenter = "center center",
CenterBottom = "center bottom",
RightTop = "right top",
RightCenter = "right center",
RightBottom = "right bottom",
EndTop = "end top",
EndCenter = "end center",
EndBottom = "end bottom",
}
}
/**
* Marker interface for controls that are not rendered "embedded" into other controls but need to be opened/closed.
*
* Such controls are handled differently during rendering.
*/
export interface PopupInterface {
}
/**
* Priorities for general use.
*/
export enum Priority {
/**
* High priority
*/
High = "High",
/**
* Low priority
*/
Low = "Low",
/**
* Medium priority
*/
Medium = "Medium",
/**
* Default, none priority
*/
None = "None",
}
/**
* Base Class for a Renderer.
*/
namespace Renderer {
/**
* Creates a new static renderer class that extends a given renderer.
*
* This method can be used with two signatures that are explained below.
* In both variants, the returned renderer class inherits all properties (methods, fields)
* from the given parent renderer class. Both variants also add an 'extend' method to the
* created renderer class that behaves like the new signature of this Renderer.extend
* method, but creates subclasses of the new class, not of sap.ui.core.Renderer
.
*
* New Signature
* In the new signature variant, two parameters must be given: a qualified name
* for the new renderer (its class name), and an optional object literal that contains
* methods or fields to be added to the new renderer class.
*
* This signature has been designed to resemble the class extension mechanism as
* provided by {@link sap.ui.base.Object.extend Object.extend}.
*
*
* sap.ui.define(['sap/ui/core/Renderer'],
* function(Renderer) {
* "use strict";
*
* var LabelRenderer = Renderer.extend('sap.m.LabelRenderer', {
* render: function(oRM, oControl) {
*
* renderPreamble(oRM, oControl);
*
* // implementation core renderer logic here
*
* renderPostamble(oRM, oControl);
*
* },
*
* renderPreamble : function(oRM, oControl) {
* ...
* },
*
* renderPostamble : function(oRM, oControl) {
* ...
* }
*
* });
*
* return LabelRenderer;
* });
*
*
* The extension of Renderers works across multiple levels. A FancyLabelRenderer can
* extend the above LabelRenderer:
*
*
* sap.ui.define(['sap/m/LabelRenderer'],
* function(LabelRenderer) {
* "use strict";
*
* var FancyLabelRenderer = LabelRenderer.extend('sap.mylib.FancyLabelRenderer', {
* render: function(oRM, oControl) {
*
* // call base renderer
* LabelRenderer.renderPreamble(oRM, oControl);
*
* // ... do your own fancy rendering here
*
* // call base renderer again
* LabelRenderer.renderPostamble(oRM, oControl);
* }
* });
*
* return FancyLabelRenderer;
* });
*
*
* Note: the new signature no longer requires the bExport
flag to be set for
* the enclosing {@link sap.ui.define} call. The Renderer base class takes care of the necessary
* global export of the renderer. This allows Non-SAP developers to write a renderer that complies with
* the documented restriction for sap.ui.define
(no use of bExport = true outside
* sap.ui.core projects).
*
* Deprecated Signature
* The deprecated old signature expects just one parameter: a renderer that should be extended.
* With that signature the renderer can't be exported globally as the name of the renderer class
* is not known.
*
* For compatibility reasons, the class created by the deprecated signature contains a property
* _super
that references the parent class. It shouldn't be used by applications / control
* developers as it doesn't work reliably for deeper inheritance chains: if the old variant of
* Renderer.extend
is used on two or more levels of the inheritance hierarchy, the
* _super
property of the resulting renderer class will always point to the implementation
* of the base renderer of the last call to extend. Instead of using this._super
, renderer
* implementations should use the new signature variant and access the base implementation of a method
* via the AMD reference to the base renderer (as shown in the FancyLabelRenderer example above).
* @param {string|any} vName - either the name of the new renderer class (new signature) or the base renderer to extend (deprecated signature)
* @param {any} oRendererInfo - methods and/or properties that should be added to the new renderer class
* @returns {any} a new static renderer class that can be enriched further
*/
function extend(vName: string|any, oRendererInfo?: any): any;
/**
* Returns the TextAlignment for the provided configuration.
* @param {sap.ui.core.TextAlign} oTextAlign - the text alignment of the Control
* @param {sap.ui.core.TextDirection} oTextDirection - the text direction of the Control
* @returns {string} the actual text alignment that must be set for this environment
*/
function getTextAlign(oTextAlign: sap.ui.core.TextAlign, oTextDirection: sap.ui.core.TextDirection): string;
}
/**
* RenderManager that will take care for rendering Controls.
*
* For the default rendering task of UI5, a shared RenderManager is created and owned by sap.ui.core.Core
.
* Controls or other code that want to render controls outside the default rendering task
* can create a private instance of RenderManager by calling the
* {@link sap.ui.core.Core#createRenderManager sap.ui.getCore().createRenderManager()} method.
* When such a private instance is no longer needed, it should be {@link #destroy destroyed}.
*
* Control renderers only have access to a subset of the public and protected instance methods of
* this class. The instance methods {@link #flush}, {@link #render} and {@link #destroy} are not part
* of that subset and are reserved to the owner of the corresponding RenderManager instance.
* Renderers will use the provided methods to create their HTML output. The RenderManager will
* collect the HTML output and inject the final HTML DOM at the desired location.
*
*
* Renderers
* When the {@link #renderControl} method of the RenderManager is invoked, it will retrieve
* the default renderer for that control. By convention, the default renderer is implemented in its
* own namespace (static class) which matches the name of the control's class with the additional
* suffix 'Renderer'. So for a control sap.m.Input
the default renderer will be searched
* for under the global name sap.m.InputRenderer
.
*/
export class RenderManager extends Object {
/**
* Creates an instance of the RenderManager.
*
* Applications or controls must not call the RenderManager
constructor on their own
* but should use the {@link sap.ui.core.Core#createRenderManager sap.ui.getCore().createRenderManager()}
* method to create an instance for their exclusive use.
*/
public constructor();
/**
* Adds a class to the class collection if the name is not empty or null.
* The class collection is flushed if it is written to the buffer using {@link #writeClasses}
* @param {string} sName - name of the class to be added; null values are ignored
* @returns {sap.ui.core.RenderManager} this render manager instance to allow chaining
*/
public addClass(sName: string): sap.ui.core.RenderManager;
/**
* Adds a style property to the style collection if the value is not empty or null
* The style collection is flushed if it is written to the buffer using {@link #writeStyle}
* @param {string} sName - Name of the CSS property to write
* @param {string|number|number} value - Value to write
* @returns {sap.ui.core.RenderManager} This render manager instance to allow chaining
*/
public addStyle(sName: string, value: string|number|number): sap.ui.core.RenderManager;
/**
* Cleans up the rendering state of the given control without rendering it.
*
* A control is responsible for the rendering of all its child controls.
* But in some cases it makes sense that a control only renders a subset of its children
* based on some criterion. For example, a typical carousel control might, for performance
* reasons, only render the currently visible children (and maybe some child before and
* after the visible area to facilitate slide-in / slide-out animations), but not all children.
* This leads to situations where a child had been rendered before, but shouldn't be rendered
* anymore after an update of the carousel's position. The DOM related state of that child then
* must be cleaned up correctly, e.g. by de-registering resize handlers or native event handlers.
* cleanupControlWithoutRendering
helps with that task by triggering the same
* activities that the normal rendering triggers before the rendering of a control
* (e.g. it fire the BeforeRendering
event). It just doesn't call the renderer
* and the control will not receive an AfterRendering
event.
*
* The following example shows how renderControl
and cleanupControlWithoutRendering
* should be used:
*
*
* CarouselRenderer.render = function(rm, oCarousel){
*
* ...
*
* oCarousel.getPages().forEach( oPage ) {
* if ( oCarousel.isPageToBeRendered( oPage ) ) {
* rm.renderControl( oPage ); // onBeforeRendering, render, later onAfterRendering
* } else {
* rm.cleanupControlWithoutRendering( oPage ); // onBeforeRendering
* }
* }
*
* ...
*
* };
*
*
* DOM Removal
* The method does not remove the DOM of the given control. The caller of this method has
* to take care to remove it at some later point in time. It should indeed be later,
* not before as the onBeforeRendering
hook of the control might need
* access to the old DOM for a proper cleanup.
*
* For parents which are rendered with the normal mechanism as shown in the example above,
* the removal of the old child DOM is guaranteed. The whole DOM of the parent control
* (including the DOM of the no longer rendered child) will be replaced with new DOM (no
* longer containing the child) when the rendering cycle finishes.
*
* Note:: the functionality of this method is different from the default handling for
* invisible controls (controls with visible == false
). The standard rendering
* for invisible controls still renders a placeholder DOM. This allows re-rendering of the
* invisible control once it becomes visible again without a need to render its parent, too.
* Children that are cleaned up with this method here, are supposed to have no more DOM at all.
* Rendering them later on therefore requires an involvement (typically: a rendering) of
* their parent.
* @param {sap.ui.core.Control} oControl - Control that should be cleaned up
*/
public cleanupControlWithoutRendering(oControl: sap.ui.core.Control): void;
/**
* Creates the ID to be used for the invisible Placeholder DOM element.
* This method can be used to get direct access to the placeholder DOM element.
* Also statically available as RenderManager.createInvisiblePlaceholderId()
* @param {sap.ui.core.Element} oElement - The Element instance for which to create the placeholder ID
* @returns {string} The ID used for the invisible Placeholder of this element
*/
protected static createInvisiblePlaceholderId(oElement: sap.ui.core.Element): string;
/**
* Cleans up the resources associated with this instance.
*
* After the instance has been destroyed, it must not be used anymore.
* Applications should call this function if they don't need the instance any longer.
*/
public destroy(): void;
/**
* Searches "to-be-preserved" nodes for the given control id.
* @param {string} sId - control id to search content for.
* @returns {JQuery} a jQuery collection representing the found content
*/
public static findPreservedContent(sId: string): JQuery;
/**
* Renders the content of the rendering buffer into the provided DOM node.
*
* This function must not be called within control renderers.
*
* Usage:
*
*
* // Create a new instance of the RenderManager
* var rm = sap.ui.getCore().createRenderManager();
*
* // Use the writer API to fill the buffers
* rm.write(...);
* rm.renderControl(oControl);
* rm.write(...);
* ...
*
* // Finally flush the buffer into the provided DOM node (The current content is removed)
* rm.flush(oDomNode);
*
* // If the instance is not needed anymore, destroy it
* rm.destroy();
*
*
* @param {Element} oTargetDomNode - Node in the DOM where the buffer should be flushed into
* @param {boolean} bDoNotPreserve - Determines whether the content is preserved (false
) or not (true
)
* @param {boolean|number} vInsert - Determines whether the buffer of the target DOM node is expanded (true
) or replaced (false
), or the new entry is inserted at a specific position (value of type int
)
*/
public flush(oTargetDomNode: Element, bDoNotPreserve: boolean, vInsert: boolean|number): void;
/**
* Returns the configuration object
* Shortcut for sap.ui.getCore().getConfiguration()
* @returns {sap.ui.core.Configuration} the configuration object
*/
public getConfiguration(): sap.ui.core.Configuration;
/**
* Renders the given {@link sap.ui.core.Control} and finally returns
* the content of the rendering buffer.
* Ensures the buffer is restored to the state before calling this method.
* @param {sap.ui.core.Control} oControl - the Control whose HTML should be returned.
* @returns {string} the resulting HTML of the provided control
*/
public getHTML(oControl: sap.ui.core.Control): string;
/**
* Returns the hidden area reference belonging to this window instance.
* @returns {Element} the hidden area reference belonging to this core instance.
*/
public static getPreserveAreaRef(): Element;
/**
* Returns the renderer class for a given control instance
* @param {sap.ui.core.Control} oControl - the control that should be rendered
* @returns {any} the renderer class for a given control instance
*/
public getRenderer(oControl: sap.ui.core.Control): any;
/**
* Returns the renderer class for a given control instance
* @param {sap.ui.core.Control} oControl - the control that should be rendered
* @returns {Function} the renderer class for a given control instance
*/
public static getRenderer(oControl: sap.ui.core.Control): Function;
/**
* Collects descendants of the given root node that need to be preserved before the root node
* is wiped out. The "to-be-preserved" nodes are moved to a special, hidden 'preserve' area.
*
* A node is declared "to-be-preserved" when it has the data-sap-ui-preserve
* attribute set. When the optional parameter bPreserveNodesWithId
is set to true,
* then nodes with an id are preserved as well and their data-sap-ui-preserve
attribute
* is set automatically. This option is used by UIAreas when they render for the first time and
* simplifies the handling of predefined HTML content in a web page.
*
* The "to-be-preserved" nodes are searched with a depth first search and moved to the 'preserve'
* area in the order that they are found. So for direct siblings the order should be stable.
* @param {Element} oRootNode - to search for "to-be-preserved" nodes
* @param {boolean} bPreserveRoot - whether to preserve the root itself
* @param {boolean} bPreserveNodesWithId - whether to preserve nodes with an id as well
*/
public static preserveContent(oRootNode: Element, bPreserveRoot?: boolean, bPreserveNodesWithId?: boolean): void;
/**
* Renders the given control to the provided DOMNode.
*
* If the control is already rendered in the provided DOMNode the DOM of the control is replaced. If the control
* is already rendered somewhere else the current DOM of the control is removed and the new DOM is appended
* to the provided DOMNode.
*
* This function must not be called within control renderers.
* @param {sap.ui.core.Control} oControl - the Control that should be rendered.
* @param {Element} oTargetDomNode - The node in the DOM where the result of the rendering should be inserted.
*/
public render(oControl: sap.ui.core.Control, oTargetDomNode: Element): void;
/**
* Turns the given control into its HTML representation and appends it to the
* rendering buffer.
*
* If the given control is undefined or null, then nothing is rendered.
* @param {sap.ui.core.Control} oControl - the control that should be rendered
* @returns {sap.ui.core.RenderManager} this render manager instance to allow chaining
*/
public renderControl(oControl: sap.ui.core.Control): sap.ui.core.RenderManager;
/**
* @param {string} sKey
*/
public translate(sKey: string): void;
/**
* Write the given texts to the buffer
* @param {string|number} sText - (can be a number too)
* @returns {sap.ui.core.RenderManager} this render manager instance to allow chaining
*/
public write(sText: string|number): sap.ui.core.RenderManager;
/**
* @returns {sap.ui.core.RenderManager} this render manager instance to allow chaining
*/
public writeAcceleratorKey(): sap.ui.core.RenderManager;
/**
* Writes the accessibility state (see WAI-ARIA specification) of the provided element into the HTML
* based on the element's properties and associations.
*
* The ARIA properties are only written when the accessibility feature is activated in the UI5 configuration.
*
* The following properties/values to ARIA attribute mappings are done (if the element does have such properties):
*
* editable===false
=> aria-readonly="true"
* enabled===false
=> aria-disabled="true"
* visible===false
=> aria-hidden="true"
* required===true
=> aria-required="true"
* selected===true
=> aria-selected="true"
* checked===true
=> aria-checked="true"
*
*
* In case of the required attribute also the Label controls which referencing the given element in their 'for' relation
* are taken into account to compute the aria-required
attribute.
*
* Additionally, the association ariaDescribedBy
and ariaLabelledBy
are used to write
* the ID lists of the ARIA attributes aria-describedby
and aria-labelledby
.
*
* Label controls that reference the given element in their 'for' relation are automatically added to the
* aria-labelledby
attributes.
*
* Note: This function is only a heuristic of a control property to ARIA attribute mapping. Control developers
* have to check whether it fulfills their requirements. In case of problems (for example the RadioButton has a
* selected
property but must provide an aria-checked
attribute) the auto-generated
* result of this function can be influenced via the parameter mProps
as described below.
*
* The parameter mProps
can be used to either provide additional attributes which should be added and/or
* to avoid the automatic generation of single ARIA attributes. The 'aria-' prefix will be prepended automatically to the keys
* (Exception: Attribute 'role' does not get the prefix 'aria-').
*
* Examples:
* {hidden : true}
results in aria-hidden="true"
independent of the presence or absence of
* the visibility property.
* {hidden : null}
ensures that no aria-hidden
attribute is written independent of the presence
* or absence of the visibility property.
* The function behaves in the same way for the associations ariaDescribedBy
and ariaLabelledBy
.
* To append additional values to the auto-generated aria-describedby
and aria-labelledby
attributes
* the following format can be used:
* {describedby : {value: "id1 id2", append: true}}
=> aria-describedby="ida idb id1 id2"
(assuming that "ida idb"
* is the auto-generated part based on the association ariaDescribedBy
).
* @param {sap.ui.core.Element} oElement - the element whose accessibility state should be rendered
* @param {Object} mProps - a map of properties that should be added additionally or changed.
* @returns {sap.ui.core.RenderManager} this render manager instance to allow chaining
*/
public writeAccessibilityState(oElement?: sap.ui.core.Element, mProps?: Object): sap.ui.core.RenderManager;
/**
* Writes the attribute and its value into the HTML.
*
* For details about the escaping refer to {@link jQuery.sap.encodeHTML}
* @param {string} sName - Name of the attribute
* @param {string|number|boolean} vValue - Value of the attribute
* @returns {sap.ui.core.RenderManager} This render manager instance to allow chaining
*/
public writeAttribute(sName: string, vValue: string|number|boolean): sap.ui.core.RenderManager;
/**
* Writes the attribute and a value into the HTML, the value will be encoded.
*
* The value is properly encoded to avoid XSS attacks.
* @param {string} sName - Name of the attribute
* @param {any} vValue - Value of the attribute
* @returns {sap.ui.core.RenderManager} This render manager instance to allow chaining
*/
public writeAttributeEscaped(sName: string, vValue: any): sap.ui.core.RenderManager;
/**
* Writes and flushes the class collection (all CSS classes added by "addClass()" since the last flush).
* Also writes the custom style classes added by the application with "addStyleClass(...)". Custom classes are
* added by default from the currently rendered control. If an oElement is given, this Element's custom style
* classes are added instead. If oElement === false, no custom style classes are added.
* @param {sap.ui.core.Element|boolean} oElement - an Element from which to add custom style classes (instead of adding from the control itself)
* @returns {sap.ui.core.RenderManager} this render manager instance to allow chaining
*/
public writeClasses(oElement?: sap.ui.core.Element|boolean): sap.ui.core.RenderManager;
/**
* Writes the controls data into the HTML.
* Control Data consists at least of the id of a control
* @param {sap.ui.core.Control} oControl - the control whose identifying information should be written to the buffer
* @returns {sap.ui.core.RenderManager} this render manager instance to allow chaining
*/
public writeControlData(oControl: sap.ui.core.Control): sap.ui.core.RenderManager;
/**
* Writes the elements data into the HTML.
* Element Data consists at least of the id of an element
* @param {sap.ui.core.Element} oElement - the element whose identifying information should be written to the buffer
* @returns {sap.ui.core.RenderManager} this render manager instance to allow chaining
*/
public writeElementData(oElement: sap.ui.core.Element): sap.ui.core.RenderManager;
/**
* Escape text for HTML and write it to the buffer.
*
* For details about the escaping refer to {@link jQuery.sap.encodeHTML}
* @param {any} sText
* @param {boolean} bLineBreaks - Whether to convert line breaks into
tags
* @returns {sap.ui.core.RenderManager} this render manager instance to allow chaining
*/
public writeEscaped(sText: any, bLineBreaks: boolean): sap.ui.core.RenderManager;
/**
* Writes either an <img> tag for normal URI or a <span> tag with needed properties for an icon URI.
*
* Additional classes and attributes can be added to the tag with the second and third parameter.
* All of the given attributes are escaped for security consideration.
*
* When an <img> tag is rendered, the following two attributes are added by default
* and can be overwritten with corresponding values in the mAttributes
parameter:
*
* role: "presentation"
* alt: ""
*
* @param {sap.ui.core.URI} sURI - URI of an image or of an icon registered in {@link sap.ui.core.IconPool}
* @param {any[]|string} aClasses - Additional classes that are added to the rendered tag
* @param {any} mAttributes - Additional attributes that will be added to the rendered tag
* @returns {sap.ui.core.RenderManager} this render manager instance to allow chaining
*/
public writeIcon(sURI: sap.ui.core.URI, aClasses?: any[]|string, mAttributes?: any): sap.ui.core.RenderManager;
/**
* Writes necessary invisible control/element placeholder data into the HTML.
*
* Controls should use this method only if the standard implementation of the RenderManager doesn't fit their needs.
* That standard implementation renders an invisible <span> element for controls with visible:false
to improve
* re-rendering performance. Due to the fault tolerance of the HTML5 standard, such <span> elements are accepted in many
* scenarios and won't appear in the render tree of the browser, However, in some cases, controls may need to write a different
* element when the <span> is not an allowed element (e.g. within the <tr> or <li> group).
*
* The caller needs to start an opening HTML tag, then call this method, then complete the opening and closing tag.
*
*
*
* oRenderManager.write("<tr");
* oRenderManager.writeInvisiblePlaceholderData(oControl);
* oRenderManager.write("></tr");
*
*
* @param {sap.ui.core.Element} oElement - An instance of sap.ui.core.Element
* @returns {sap.ui.core.RenderManager} This render manager instance to allow chaining
*/
protected writeInvisiblePlaceholderData(oElement: sap.ui.core.Element): sap.ui.core.RenderManager;
/**
* Writes and flushes the style collection
* @returns {sap.ui.core.RenderManager} this render manager instance to allow chaining
*/
public writeStyles(): sap.ui.core.RenderManager;
}
/**
* The resize handling API provides firing of resize events on all browsers by regularly
* checking the width and height of registered DOM elements or controls and firing events accordingly.
*/
namespace ResizeHandler {
/**
* Deregisters a previously registered handler for resize events with the given registration ID.
* @param {string} sId - The registration ID of the handler to deregister. The ID was provided by function {@link sap.ui.core.ResizeHandler.register} when the handler was registered.
*/
function deregister(sId: string): void;
/**
* Creates a new subclass of class sap.ui.core.ResizeHandler with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
function extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.ResizeHandler.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
function getMetadata(): sap.ui.base.Metadata;
/**
* Registers the given event handler for resize events on the given DOM element or control.
*
* Note: This function must not be used before the UI5 framework is initialized.
* Please use the {@link sap.ui.core.Core#attachInit init event} of UI5 if you are not sure whether this is the case.
*
* The resize handler periodically checks the dimensions of the registered reference. Whenever it detects changes, an event is fired.
* Be careful when changing dimensions within the event handler which might cause another resize event and so on.
*
* The available parameters of the resize event are:
*
* oEvent.target
: The DOM element of which the dimensions were checked
* oEvent.size.width
: The current width of the DOM element in pixels
* oEvent.size.height
: The current height of the DOM element in pixels
* oEvent.oldSize.width
: The previous width of the DOM element in pixels
* oEvent.oldSize.height
: The previous height of the DOM element in pixels
* oEvent.control
: The control which was given during registration of the event handler (if present)
*
* @param {HTMLElement|sap.ui.core.Control} oRef - The control or the DOM reference for which the given event handler should be registered (beside the window)
* @param {Function} fHandler - The event handler which should be called whenever the size of the given reference is changed. The event object is passed as first argument to the event handler. See the description of this function for more details about the available parameters of this event.
* @returns {string} A registration ID which can be used for deregistering the event handler, see {@link sap.ui.core.ResizeHandler.deregister}. If the UI5 framework is not yet initialized null
is returned.
*/
function register(oRef: HTMLElement|sap.ui.core.Control, fHandler: Function): string;
}
/**
*/
namespace routing {
/**
* Class for manipulating and receiving changes of the browserhash with the hasher framework.
* Fires a "hashChanged" event if the browser hash changes.
*/
export class HashChanger extends sap.ui.base.EventProvider {
/**
*/
public constructor();
/**
* Cleans the event registration
*/
public destroy(): void;
/**
* Creates a new subclass of class sap.ui.core.routing.HashChanger with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires the hashchanged event, may be extended to modify the hash before fireing the event
* @param {string} newHash - the new hash of the browser
* @param {string} oldHash - the previous hash
*/
protected fireHashChanged(newHash: string, oldHash: string): void;
/**
* Gets the current hash
* @returns {string} the current hash
*/
public getHash(): string;
/**
* Gets a global singleton of the HashChanger. The singleton will get created when this function is invoked for the first time.
* @returns {any}
*/
public static getInstance(): any;
/**
* Returns a metadata object for class sap.ui.core.routing.HashChanger.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Will start listening to hashChanges with the parseHash function.
* This will also fire a hashchanged event with the initial hash.
* @returns {any} false if it was initialized before, true if it was initialized the first time
*/
public init(): any;
/**
* Replaces the hash to a certain value. When using the replace function no browser history is written.
* If you want to have an entry in the browser history, please use set setHash function.
* @param {string} sHash - the hash
*/
public replaceHash(sHash: string): void;
/**
* Sets the hashChanger to a new instance, destroys the old one and copies all its event listeners to the new one
* @param {sap.ui.core.routing.HashChanger} oHashChanger - the new instance for the global singleton
*/
protected static replaceHashChanger(oHashChanger: sap.ui.core.routing.HashChanger): void;
/**
* Sets the hash to a certain value. When using the set function a browser history entry is written.
* If you do not want to have an entry in the browser history, please use set replaceHash function.
* @param {string} sHash - the hash
*/
public setHash(sHash: string): void;
}
/**
*/
export class History {
/**
* Used to determine the {@link sap.ui.core.routing.HistoryDirection} of the current or a future navigation,
* done with a {@link sap.ui.core.routing.Router} or {@link sap.ui.core.routing.HashChanger}.
*
* ATTENTION: this class will not be accurate if someone does hash-replacement without the named classes above
* If you are manipulating the hash directly this class is not supported anymore.
* @param {sap.ui.core.routing.HashChanger} oHashChanger - required, without a HashChanger this class cannot work. The class needs to be aware of the hash-changes.
*/
public constructor(oHashChanger: sap.ui.core.routing.HashChanger);
/**
* Determines what the navigation direction for a newly given hash would be
* It will say Unknown if there is a history foo - bar (current history) - foo
* If you now ask for the direction of the hash "foo" you get Unknown because it might be backwards or forwards.
* For hash replacements, the history stack will be replaced at this position for the history.
* @param {string} sNewHash - optional, if this parameter is not passed the last hashChange is taken.
* @returns {sap.ui.core.routing.HistoryDirection} or undefined, if no navigation has taken place yet.
*/
public getDirection(sNewHash?: string): sap.ui.core.routing.HistoryDirection;
/**
* @returns {sap.ui.core.routing.History} a global singleton that gets created as soon as the sap.ui.core.routing.History is required
*/
public static getInstance(): sap.ui.core.routing.History;
/**
* gets the previous hash in the history - if the last direction was Unknown or there was no navigation yet, undefined will be returned
* @returns {string} or undefined
*/
public getPreviousHash(): string;
}
/**
* Enumaration for different HistoryDirections
*/
export enum HistoryDirection {
/**
* The page has already been navigated to and it was the precessor of the previous page
*/
Backwards = "Backwards",
/**
* The page has already been navigated to and it was the successor of the previous page
*/
Forwards = "Forwards",
/**
* A new Entry is added to the history
*/
NewEntry = "NewEntry",
/**
* A Navigation took place, but it could be any of the other three states
*/
Unknown = "Unknown",
}
/**
*/
export class Route extends sap.ui.base.EventProvider {
/**
* Instantiates an SAPUI5 Route
* @param {sap.ui.core.routing.Router} The - router instance, the route will be added to.
* @param {any} oConfig - configuration object for the route
* @param {sap.ui.core.routing.Route} oParent - The parent route - if a parent route is given, the routeMatched event of this route will also trigger the route matched of the parent and it will also create the view of the parent(if provided).
*/
public constructor(The: sap.ui.core.routing.Router, oConfig: any, oParent?: sap.ui.core.routing.Route);
/**
* Attach event-handler fnFunction
to the 'beforeMatched' event of this sap.ui.core.routing.Route
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Route} this
to allow method chaining
*/
public attachBeforeMatched(fnFunction: Function, oListener?: any): sap.ui.core.routing.Route;
/**
* Attach event-handler fnFunction
to the 'beforeMatched' event of this sap.ui.core.routing.Route
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Route} this
to allow method chaining
*/
public attachBeforeMatched(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.routing.Route;
/**
* Attach event-handler fnFunction
to the 'matched' event of this sap.ui.core.routing.Route
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Route} this
to allow method chaining
*/
public attachMatched(fnFunction: Function, oListener?: any): sap.ui.core.routing.Route;
/**
* Attach event-handler fnFunction
to the 'matched' event of this sap.ui.core.routing.Route
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Route} this
to allow method chaining
*/
public attachMatched(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.routing.Route;
/**
* Attach event-handler fnFunction
to the 'patternMatched' event of this sap.ui.core.routing.Route
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Route} this
to allow method chaining
*/
public attachPatternMatched(fnFunction: Function, oListener?: any): sap.ui.core.routing.Route;
/**
* Attach event-handler fnFunction
to the 'patternMatched' event of this sap.ui.core.routing.Route
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Route} this
to allow method chaining
*/
public attachPatternMatched(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.routing.Route;
/**
* Destroys a route
*/
public destroy(): void;
/**
* Detach event-handler fnFunction
from the 'beforeMatched' event of this sap.ui.core.routing.Route
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.routing.Route} this
to allow method chaining
*/
public detachBeforeMatched(fnFunction: Function, oListener: any): sap.ui.core.routing.Route;
/**
* Detach event-handler fnFunction
from the 'matched' event of this sap.ui.core.routing.Route
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.routing.Route} this
to allow method chaining
*/
public detachMatched(fnFunction: Function, oListener: any): sap.ui.core.routing.Route;
/**
* Detach event-handler fnFunction
from the 'patternMatched' event of this sap.ui.core.routing.Route
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.routing.Route} this
to allow method chaining
*/
public detachPatternMatched(fnFunction: Function, oListener: any): sap.ui.core.routing.Route;
/**
* Creates a new subclass of class sap.ui.core.routing.Route with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event beforeMatched to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
protected fireBeforeMatched(mArguments?: any): sap.ui.core.routing.Router;
/**
* Returns a metadata object for class sap.ui.core.routing.Route.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Return the pattern of the route. If there are multiple patterns, the first pattern is returned
* @returns {string} the routes pattern
*/
public getPattern(): string;
/**
* Returns the URL for the route and replaces the placeholders with the values in oParameters
* @param {any} oParameters - Parameters for the route
* @returns {string} the unencoded pattern with interpolated arguments
*/
public getURL(oParameters: any): string;
}
/**
*/
export class Router extends sap.ui.base.EventProvider {
/**
* Instantiates an SAPUI5 Router
* @param {any|any[]} oRoutes - may contain many Route configurations as {@link sap.ui.core.routing.Route#constructor}.
Each of the routes contained in the array/object will be added to the router.
One way of defining routes is an array: [ //Will create a route called 'firstRouter' you can later use this name in navTo to navigate to this route { name: "firstRoute" pattern : "usefulPattern" }, //Will create a route called 'anotherRoute' { name: "anotherRoute" pattern : "anotherPattern" } ]
The alternative way of defining routes is an Object. If you choose this way, the name attribute is the name of the property. { //Will create a route called 'firstRouter' you can later use this name in navTo to navigate to this route firstRoute : { pattern : "usefulPattern" }, //Will create a route called 'anotherRoute' anotherRoute : { pattern : "anotherPattern" } }
The values that may be provided are the same as in {@link sap.ui.core.routing.Route#constructor}
* @param {any} oConfig - Default values for route configuration - also takes the same parameters as {@link sap.ui.core.routing.Target#constructor}.
This config will be used for routes and for targets, used in the router
Eg: if the config object specifies : { viewType : "XML" }
The targets look like this: { xmlTarget : { ... }, jsTarget : { viewType : "JS" ... } }
Then the effective config will look like this: { xmlTarget : { viewType : "XML" ... }, jsTarget : { viewType : "JS" ... } }
Since the xmlTarget does not specify its viewType, XML is taken from the config object. The jsTarget is specifying it, so the viewType will be JS.
* @param {sap.ui.core.UIComponent} oOwner - the Component of all the views that will be created by this Router,
will get forwarded to the {@link sap.ui.core.routing.Views#constructor}.
If you are using the componentMetadata to define your routes you should skip this parameter.
* @param {any} oTargetsConfig - available @since 1.28 the target configuration, see {@link sap.ui.core.routing.Targets#constructor} documentation (the options object).
You should use Targets to create and display views. Since 1.28 the route should only contain routing relevant properties.
Example: new Router( // Routes [ { // no view creation related properties are in the route name: "startRoute", //no hash pattern: "", // you can find this target in the targetConfig target: "welcome" } ], // Default values shared by routes and Targets { viewNamespace: "my.application.namespace", viewType: "XML" }, // You should only use this constructor when you are not using a router with a component. // Please use the metadata of a component to define your routes and targets. // The documentation can be found here: {@link sap.ui.core.UIComponent.extend}. null, // Target config { //same name as in the route called 'startRoute' welcome: { // All properties for creating and placing a view go here or in the config viewName: "Welcome", controlId: "app", controlAggregation: "pages" } })
*/
public constructor(oRoutes?: any|any[], oConfig?: any, oOwner?: sap.ui.core.UIComponent, oTargetsConfig?: any);
/**
* Adds a route to the router
* @param {any} oConfig - configuration object for the route @see sap.ui.core.routing.Route#constructor
* @param {sap.ui.core.routing.Route} oParent - The parent route - if a parent route is given, the routeMatched event of this route will also trigger the route matched of the parent and it will also create the view of the parent (if provided).
*/
public addRoute(oConfig: any, oParent: sap.ui.core.routing.Route): void;
/**
* Attach event-handler fnFunction
to the 'beforeRouteMatched' event of this sap.ui.core.routing.Router
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public attachBeforeRouteMatched(fnFunction: Function, oListener?: any): sap.ui.core.routing.Router;
/**
* Attach event-handler fnFunction
to the 'beforeRouteMatched' event of this sap.ui.core.routing.Router
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public attachBeforeRouteMatched(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.routing.Router;
/**
* Attach event-handler fnFunction
to the 'bypassed' event of this sap.ui.core.routing.Router
.
* The event will get fired, if none of the routes of the routes is matching.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public attachBypassed(fnFunction: Function, oListener?: any): sap.ui.core.routing.Router;
/**
* Attach event-handler fnFunction
to the 'bypassed' event of this sap.ui.core.routing.Router
.
* The event will get fired, if none of the routes of the routes is matching.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public attachBypassed(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.routing.Router;
/**
* Attach event-handler fnFunction
to the 'routeMatched' event of this sap.ui.core.routing.Router
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public attachRouteMatched(fnFunction: Function, oListener?: any): sap.ui.core.routing.Router;
/**
* Attach event-handler fnFunction
to the 'routeMatched' event of this sap.ui.core.routing.Router
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public attachRouteMatched(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.routing.Router;
/**
* Attach event-handler fnFunction
to the 'routePatternMatched' event of this sap.ui.core.routing.Router
.
* This event is similar to route matched. But it will only fire for the route that has a matching pattern, not for its parent Routes
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public attachRoutePatternMatched(fnFunction: Function, oListener?: any): sap.ui.core.routing.Router;
/**
* Attach event-handler fnFunction
to the 'routePatternMatched' event of this sap.ui.core.routing.Router
.
* This event is similar to route matched. But it will only fire for the route that has a matching pattern, not for its parent Routes
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public attachRoutePatternMatched(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.routing.Router;
/**
* Attach event-handler fnFunction
to the 'titleChanged' event of this sap.ui.core.routing.Router
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public attachTitleChanged(fnFunction: Function, oListener?: any): sap.ui.core.routing.Router;
/**
* Attach event-handler fnFunction
to the 'titleChanged' event of this sap.ui.core.routing.Router
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public attachTitleChanged(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.routing.Router;
/**
* Attach event-handler fnFunction
to the 'viewCreated' event of this sap.ui.core.routing.Router
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public attachViewCreated(fnFunction: Function, oListener?: any): sap.ui.core.routing.Router;
/**
* Attach event-handler fnFunction
to the 'viewCreated' event of this sap.ui.core.routing.Router
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public attachViewCreated(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.routing.Router;
/**
* Removes the router from the hash changer @see sap.ui.core.routing.HashChanger
*/
public destroy(): void;
/**
* Detach event-handler fnFunction
from the 'beforeRouteMatched' event of this sap.ui.core.routing.Router
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public detachBeforeRouteMatched(fnFunction: Function, oListener: any): sap.ui.core.routing.Router;
/**
* Detach event-handler fnFunction
from the 'bypassed' event of this sap.ui.core.routing.Router
.
* The event will get fired, if none of the routes of the routes is matching.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public detachBypassed(fnFunction: Function, oListener: any): sap.ui.core.routing.Router;
/**
* Detach event-handler fnFunction
from the 'routeMatched' event of this sap.ui.core.routing.Router
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public detachRouteMatched(fnFunction: Function, oListener: any): sap.ui.core.routing.Router;
/**
* Detach event-handler fnFunction
from the 'routePatternMatched' event of this sap.ui.core.routing.Router
.
* This event is similar to route matched. But it will only fire for the route that has a matching pattern, not for its parent Routes
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public detachRoutePatternMatched(fnFunction: Function, oListener: any): sap.ui.core.routing.Router;
/**
* Detach event-handler fnFunction
from the 'titleChanged' event of this sap.ui.core.routing.Router
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public detachTitleChanged(fnFunction: Function, oListener: any): sap.ui.core.routing.Router;
/**
* Detach event-handler fnFunction
from the 'viewCreated' event of this sap.ui.core.routing.Router
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
public detachViewCreated(fnFunction: Function, oListener: any): sap.ui.core.routing.Router;
/**
* Creates a new subclass of class sap.ui.core.routing.Router with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event beforeRouteMatched to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
protected fireBeforeRouteMatched(mArguments?: any): sap.ui.core.routing.Router;
/**
* Fire event bypassed to attached listeners.
* The event will get fired, if none of the routes of the routes is matching.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
protected fireBypassed(mArguments?: any): sap.ui.core.routing.Router;
/**
* Fire event routeMatched to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
protected fireRouteMatched(mArguments?: any): sap.ui.core.routing.Router;
/**
* Fire event routePatternMatched to attached listeners.
* This event is similar to route matched. But it will only fire for the route that has a matching pattern, not for its parent Routes
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
protected fireRoutePatternMatched(mArguments?: any): sap.ui.core.routing.Router;
/**
* Fire event viewCreated to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.routing.Router} this
to allow method chaining
*/
protected fireViewCreated(mArguments?: any): sap.ui.core.routing.Router;
/**
* Returns a metadata object for class sap.ui.core.routing.Router.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the Route with a name, if no route is found undefined is returned
* @param {string} sName - Name of the route
* @returns {sap.ui.core.routing.Route} the route with the provided name or undefined.
*/
public getRoute(sName: string): sap.ui.core.routing.Route;
/**
* Get a registered router
* @param {string} sName - Name of the router
* @returns {sap.ui.core.routing.Router} The router with the specified name, else undefined
*/
public static getRouter(sName: string): sap.ui.core.routing.Router;
/**
* Returns the instance of Targets, if you pass a targets config to the router
* @returns {sap.ui.core.routing.Targets|any} The instance of targets, the router uses to place views or undefined if you did not specify the targets parameter in the router's constructor.
*/
public getTargets(): sap.ui.core.routing.Targets|any;
/**
* Returns the title history.
*
* History entry example:
*
* {
* title: "TITLE", // The displayed title
* hash: "HASH" // The url hash
* isHome: "true/false" // The app home indicator
* }
*
* @returns {any[]} An array which contains the history entries.
*/
public getTitleHistory(): any[];
/**
* Returns the URL for the route and replaces the placeholders with the values in oParameters
* @param {string} sName - Name of the route
* @param {any} oParameters - Parameters for the route
* @returns {string} the unencoded pattern with interpolated arguments
*/
public getURL(sName: string, oParameters?: any): string;
/**
* Returns a cached view for a given name or creates it if it does not yet exists
* @param {string} sViewName - Name of the view
* @param {string} sViewType - Type of the view
* @param {string} sViewId - Optional view id
* @returns {sap.ui.core.mvc.View} the view instance
*/
public getView(sViewName: string, sViewType: string, sViewId: string): sap.ui.core.mvc.View;
/**
* Returns the views instance created by the router
* @returns {sap.ui.core.routing.Views} the Views instance
*/
public getViews(): sap.ui.core.routing.Views;
/**
* Attaches the router to the hash changer @see sap.ui.core.routing.HashChanger
* @param {boolean} bIgnoreInitialHash - @since 1.48.0 whether the current url hash shouldn't be parsed after the router is initialized
* @returns {sap.ui.core.routing.Router} this for chaining.
*/
public initialize(bIgnoreInitialHash?: boolean): sap.ui.core.routing.Router;
/**
* Navigates to a specific route defining a set of parameters. The Parameters will be URI encoded - the characters ; , / ? : @ & = + $ are reserved and will not be encoded.
* If you want to use special characters in your oParameters, you have to encode them (encodeURIComponent).
*
* IF the given route name can't be found, an error message is logged to the console and the hash will be changed to empty string.
* @param {string} sName - Name of the route
* @param {any} oParameters - Parameters for the route
* @param {boolean} bReplace - If set to true
, the hash is replaced, and there will be no entry in the browser history, if set to false
, the hash is set and the entry is stored in the browser history.
* @returns {sap.ui.core.routing.Router} this for chaining.
*/
public navTo(sName: string, oParameters?: any, bReplace?: boolean): sap.ui.core.routing.Router;
/**
* Will trigger routing events + place targets for routes matching the string
* @param {string} sNewHash - a new hash
*/
protected parse(sNewHash: string): void;
/**
* Registers the router to access it from another context. Use sap.ui.routing.Router.getRouter() to receive the instance
* @param {string} sName - Name of the router
*/
public register(sName: string): void;
/**
* Adds or overwrites a view in the viewcache of the router, the viewname serves as a key
* @param {string} sViewName - Name of the view
* @param {sap.ui.core.mvc.View} oView - the view instance
* @returns {sap.ui.core.routing.Router} @since 1.28 the this pointer for chaining
*/
public setView(sViewName: string, oView: sap.ui.core.mvc.View): sap.ui.core.routing.Router;
/**
* Stops to listen to the hashChange of the browser.
* If you want the router to start again, call initialize again.
* @returns {sap.ui.core.routing.Router} this for chaining.
*/
public stop(): sap.ui.core.routing.Router;
}
/**
*/
export class Target extends sap.ui.base.EventProvider {
/**
* Provides a convenient way for placing views into the correct containers of your application.
* The main benefit of Targets is lazy loading: you do not have to create the views until you really need them.
* Don't call this constructor directly, use {@link sap.ui.core.routing.Targets} instead, it will create instances of a Target.
* If you are using the mobile library, please use the {@link sap.m.routing.Targets} constructor, please read the documentation there.
* @param {any} oOptions - all of the parameters defined in {@link sap.m.routing.Targets#constructor} are accepted here, except for children you need to specify the parent.
* @param {sap.ui.core.routing.Views} oViews - All views required by this target will get created by the views instance using {@link sap.ui.core.routing.Views#getView}
* @param {sap.ui.core.routing.Target} oParent - the parent of this target. Will also get displayed, if you display this target. In the config you have the fill the children property {@link sap.m.routing.Targets#constructor}
*/
public constructor(oOptions: any, oViews: sap.ui.core.routing.Views, oParent?: sap.ui.core.routing.Target);
/**
* This function is called between the target view is loaded and the view is added to the container.
*
* This function can be used for applying modification on the view or the container to make the rerendering occur
* together with the later aggregation change.
* @param {any} mArguments
*/
protected _beforePlacingViewIntoContainer(mArguments: any): void;
/**
* Attach event-handler fnFunction
to the 'display' event of this sap.ui.core.routing.Target
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function.
* @returns {sap.ui.core.routing.Target} this
to allow method chaining
*/
public attachDisplay(fnFunction: Function, oListener?: any): sap.ui.core.routing.Target;
/**
* Attach event-handler fnFunction
to the 'display' event of this sap.ui.core.routing.Target
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function.
* @returns {sap.ui.core.routing.Target} this
to allow method chaining
*/
public attachDisplay(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.routing.Target;
/**
* Destroys the target, will be called by {@link sap.m.routing.Targets} don't call this directly.
*/
public destroy(): void;
/**
* Detach event-handler fnFunction
from the 'display' event of this sap.ui.core.routing.Target
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.routing.Target} this
to allow method chaining
*/
public detachDisplay(fnFunction: Function, oListener: any): sap.ui.core.routing.Target;
/**
* Creates a view and puts it in an aggregation of a control that has been defined in the {@link sap.ui.core.routing.Target#constructor}.
* @param {any} vData - an object that will be passed to the display event in the data property. If the target has parents, the data will also be passed to them.
* @returns {Promise} resolves with {name: *, view: *, control: *} if the target can be successfully displayed otherwise it resolves with {name: *, error: *}
*/
public display(vData?: any): Promise;
/**
* Creates a new subclass of class sap.ui.core.routing.Target with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event created to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.routing.Target} this
to allow method chaining
*/
protected fireDisplay(mArguments?: any): sap.ui.core.routing.Target;
/**
* Returns a metadata object for class sap.ui.core.routing.Target.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
*/
export class Targets extends sap.ui.base.EventProvider {
/**
* Provides a convenient way for placing views into the correct containers of your application.
* The main benefit of Targets is lazy loading: you do not have to create the views until you really need them.
* If you are using the mobile library, please use {@link sap.m.routing.Targets} instead of this class.
* @param {any} oOptions
*/
public constructor(oOptions: any);
/**
* Creates a target by using the given name and options. If there's already a target with the same name exists, the existing target is kept from being overwritten and an error log will be written to the development console.
* @param {string} sName - the name of a target
* @param {any} oTarget - the options of a target. The option names are the same as the ones in "oOptions.targets.anyName" of {@link #constructor}.
* @returns {sap.ui.core.routing.Targets} Targets itself for method chaining
*/
public addTarget(sName: string, oTarget: any): sap.ui.core.routing.Targets;
/**
* Attach event-handler fnFunction
to the 'display' event of this sap.ui.core.routing.Targets
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function.
* @returns {sap.ui.core.routing.Targets} this
to allow method chaining
*/
public attachDisplay(fnFunction: Function, oListener?: any): sap.ui.core.routing.Targets;
/**
* Attach event-handler fnFunction
to the 'display' event of this sap.ui.core.routing.Targets
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function.
* @returns {sap.ui.core.routing.Targets} this
to allow method chaining
*/
public attachDisplay(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.routing.Targets;
/**
* Attach event-handler fnFunction
to the 'titleChanged' event of this sap.ui.core.routing.Targets
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function.
* @returns {sap.ui.core.routing.Targets} this
to allow method chaining
*/
public attachTitleChanged(fnFunction: Function, oListener?: any): sap.ui.core.routing.Targets;
/**
* Attach event-handler fnFunction
to the 'titleChanged' event of this sap.ui.core.routing.Targets
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function.
* @returns {sap.ui.core.routing.Targets} this
to allow method chaining
*/
public attachTitleChanged(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.routing.Targets;
/**
* Destroys the targets instance and all created targets. Does not destroy the views instance passed to the constructor. It has to be destroyed separately.
*/
public destroy(): void;
/**
* Detach event-handler fnFunction
from the 'display' event of this sap.ui.core.routing.Targets
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.routing.Targets} this
to allow method chaining
*/
public detachDisplay(fnFunction: Function, oListener: any): sap.ui.core.routing.Targets;
/**
* Detach event-handler fnFunction
from the 'titleChanged' event of this sap.ui.core.routing.Targets
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.routing.Targets} this
to allow method chaining
*/
public detachTitleChanged(fnFunction: Function, oListener: any): sap.ui.core.routing.Targets;
/**
* Creates a view and puts it in an aggregation of the specified control.
* @param {string|string[]} vTargets - the key of the target as specified in the {@link #constructor}. To display multiple targets you may also pass an array of keys.
* @param {any} oData - an object that will be passed to the display event in the data property. If the target has parents, the data will also be passed to them.
* @param {string} sTitleTarget - the name of the target from which the title option is taken for firing the {@link sap.ui.core.routing.Targets#event:titleChanged|titleChanged} event
* @returns {sap.ui.core.routing.Targets|Promise} this pointer for chaining or a Promise
*/
public display(vTargets: string|string[], oData?: any, sTitleTarget?: string): sap.ui.core.routing.Targets|Promise;
/**
* Creates a new subclass of class sap.ui.core.routing.Targets with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event created to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.routing.Targets} this
to allow method chaining
*/
public fireDisplay(mArguments?: any): sap.ui.core.routing.Targets;
/**
* Returns a metadata object for class sap.ui.core.routing.Targets.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns a target by its name (if you pass myTarget: { view: "myView" }) in the config myTarget is the name.
* @param {string|string[]} vName - the name of a single target or the name of multiple targets
* @returns {sap.ui.core.routing.Target|any|sap.ui.core.routing.Target[]} The target with the coresponding name or undefined. If an array way passed as name this will return an array with all found targets. Non existing targets will not be returned but will log an error.
*/
public getTarget(vName: string|string[]): sap.ui.core.routing.Target|any|sap.ui.core.routing.Target[];
/**
* Returns the views instance passed to the constructor
* @returns {sap.ui.core.routing.Views} the views instance
*/
public getViews(): sap.ui.core.routing.Views;
}
/**
*/
export class Views extends sap.ui.base.EventProvider {
/**
* Instantiates a view repository that creates and caches views. If it is destroyed, all the Views it created are destroyed.
* Usually you do not have to create instances of this class, it is used by the {@link sap.ui.core.routing.Router}.
* If you are using {@link sap.ui.core.routing.Targets} without using a {@link sap.ui.core.UIComponent} you have to create an instance of this class.
* They will create an instance on their own, or if they are used with a {@link sap.ui.core.UIComponent} they will share the same instance of Views.
* @param {any} oOptions
*/
public constructor(oOptions: any);
/**
* Attach event-handler fnFunction
to the 'created' event of this sap.ui.core.routing.Views
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function.
* @returns {sap.ui.core.routing.Views} this
to allow method chaining
*/
public attachCreated(fnFunction: Function, oListener?: any): sap.ui.core.routing.Views;
/**
* Attach event-handler fnFunction
to the 'created' event of this sap.ui.core.routing.Views
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function.
* @returns {sap.ui.core.routing.Views} this
to allow method chaining
*/
public attachCreated(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.routing.Views;
/**
* Detach event-handler fnFunction
from the 'created' event of this sap.ui.core.routing.Views
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.routing.Views} this
to allow method chaining
*/
public detachCreated(fnFunction: Function, oListener: any): sap.ui.core.routing.Views;
/**
* Creates a new subclass of class sap.ui.core.routing.Views with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event created to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.routing.Views} this
to allow method chaining
*/
protected fireCreated(mArguments?: any): sap.ui.core.routing.Views;
/**
* Returns a metadata object for class sap.ui.core.routing.Views.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns a cached view, for a given name. If it does not exist yet, it will create the view with the provided options.
* If you provide a viewId, it will be prefixed with the viewId of the component.
* @param {any} oOptions - see {@link sap.ui.view} for the documentation. The viewId you pass into the options will be prefixed with the id of the component you pass into the constructor. So you can retrieve the view later by calling the {@link sap.ui.core.UIComponent#byId} function of the UIComponent.
* @returns {Promise} A promise that is resolved when the view is loaded {@link sap.ui.core.mvc.View#loaded}. The view instance will be passed to the promise.
*/
public getView(oOptions: any): Promise;
/**
* Adds or overwrites a view in the cache of the Views instance. The viewName serves as a key for caching.
*
* If the second parameter is set to null or undefined, the previous cache view under the same name isn't managed by the Views instance.
* The lifecycle (for example the destroy of the view) of the view instance should be maintained by additional code.
* @param {string} sViewName - Name of the view, may differ from the actual viewName of the oView parameter provided, since you can retrieve this view per {@link #.getView}.
* @param {sap.ui.core.mvc.View|null|any} oView - the view instance
* @returns {sap.ui.core.routing.Views} this for chaining.
*/
public setView(sViewName: string, oView: sap.ui.core.mvc.View|null|any): sap.ui.core.routing.Views;
}
}
/**
* The ScrollBar control can be used for virtual scrolling of a certain area.
* This means: to simulate a very large scrollable area when technically the area is small and the control takes care of displaying the respective part only. E.g. a Table control can take care of only rendering the currently visible rows and use this ScrollBar control to make the user think he actually scrolls through a long list.
*/
export class ScrollBar extends sap.ui.core.Control {
/**
* Constructor for a new ScrollBar.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:scroll scroll} event of this sap.ui.core.ScrollBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.ScrollBar
itself.
*
* Scroll event.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.ScrollBar
itself
* @returns {sap.ui.core.ScrollBar} Reference to this
in order to allow method chaining
*/
public attachScroll(fnFunction: Function, oListener?: any): sap.ui.core.ScrollBar;
/**
* Attaches event handler fnFunction
to the {@link #event:scroll scroll} event of this sap.ui.core.ScrollBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.ScrollBar
itself.
*
* Scroll event.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.ScrollBar
itself
* @returns {sap.ui.core.ScrollBar} Reference to this
in order to allow method chaining
*/
public attachScroll(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.ScrollBar;
/**
* Binds the mouse wheel scroll event of the control that has the scrollbar to the scrollbar itself.
* @param {string} oOwnerDomRef - Dom ref of the control that uses the scrollbar
*/
public bind(oOwnerDomRef: string): void;
/**
* Detaches event handler fnFunction
from the {@link #event:scroll scroll} event of this sap.ui.core.ScrollBar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.core.ScrollBar} Reference to this
in order to allow method chaining
*/
public detachScroll(fnFunction: Function, oListener: any): sap.ui.core.ScrollBar;
/**
* Creates a new subclass of class sap.ui.core.ScrollBar with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:scroll scroll} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.core.ScrollBar} Reference to this
in order to allow method chaining
*/
protected fireScroll(mParameters?: any): sap.ui.core.ScrollBar;
/**
* Gets current value of property {@link #getContentSize contentSize}.
*
* Size of the scrollable content (in pixels).
* @returns {sap.ui.core.CSSSize} Value of property contentSize
*/
public getContentSize(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.core.ScrollBar.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getScrollPosition scrollPosition}.
*
* Scroll position in steps or pixels.
* @returns {number} Value of property scrollPosition
*/
public getScrollPosition(): number;
/**
* Gets current value of property {@link #getSize size}.
*
* Size of the Scrollbar (in pixels).
* @returns {sap.ui.core.CSSSize} Value of property size
*/
public getSize(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getSteps steps}.
*
* Number of steps to scroll. Used if the size of the content is not known as the data is loaded dynamically.
* @returns {number} Value of property steps
*/
public getSteps(): number;
/**
* Gets current value of property {@link #getVertical vertical}.
*
* Orientation. Defines if the Scrollbar is vertical or horizontal.
*
* Default value is true
.
* @returns {boolean} Value of property vertical
*/
public getVertical(): boolean;
/**
* Page Down is used to scroll one page forward.
*/
public pageDown(): void;
/**
* Page Up is used to scroll one page back.
*/
public pageUp(): void;
/**
* Sets a new value for property {@link #getContentSize contentSize}.
*
* Size of the scrollable content (in pixels).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sContentSize - New value for property contentSize
* @returns {sap.ui.core.ScrollBar} Reference to this
in order to allow method chaining
*/
public setContentSize(sContentSize: sap.ui.core.CSSSize): sap.ui.core.ScrollBar;
/**
* Sets a new value for property {@link #getScrollPosition scrollPosition}.
*
* Scroll position in steps or pixels.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iScrollPosition - New value for property scrollPosition
* @returns {sap.ui.core.ScrollBar} Reference to this
in order to allow method chaining
*/
public setScrollPosition(iScrollPosition: number): sap.ui.core.ScrollBar;
/**
* Sets a new value for property {@link #getSize size}.
*
* Size of the Scrollbar (in pixels).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sSize - New value for property size
* @returns {sap.ui.core.ScrollBar} Reference to this
in order to allow method chaining
*/
public setSize(sSize: sap.ui.core.CSSSize): sap.ui.core.ScrollBar;
/**
* Sets a new value for property {@link #getSteps steps}.
*
* Number of steps to scroll. Used if the size of the content is not known as the data is loaded dynamically.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iSteps - New value for property steps
* @returns {sap.ui.core.ScrollBar} Reference to this
in order to allow method chaining
*/
public setSteps(iSteps: number): sap.ui.core.ScrollBar;
/**
* Sets a new value for property {@link #getVertical vertical}.
*
* Orientation. Defines if the Scrollbar is vertical or horizontal.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVertical - New value for property vertical
* @returns {sap.ui.core.ScrollBar} Reference to this
in order to allow method chaining
*/
public setVertical(bVertical: boolean): sap.ui.core.ScrollBar;
/**
* Unbinds the mouse wheel scroll event of the control that has the scrollbar
* @param {string} oOwnerDomRef - Dom ref of the Control that uses the scrollbar
*/
public unbind(oOwnerDomRef: string): void;
}
/**
* Actions are: Click on track, button, drag of thumb, or mouse wheel click
*/
export enum ScrollBarAction {
/**
* Scrolling done by dragging the scroll bar's paint thumb
*/
Drag = "Drag",
/**
* Scrolling done by mouse wheel
*/
MouseWheel = "MouseWheel",
/**
* Range scrolling caused by clicking track area or using page up or page down key.
*/
Page = "Page",
/**
* Single step scrolling caused by clicking an arrow button or arrow key.
*/
Step = "Step",
}
/**
* Defines the possible values for horizontal and vertical scrolling behavior.
*/
export enum Scrolling {
/**
* A scroll bar is shown if the content requires more space than the given space (rectangle) provides.
*/
Auto = "Auto",
/**
* No scroll bar is shown, and the content stays in the given rectangle.
*/
Hidden = "Hidden",
/**
* No scroll bar provided even if the content is larger than the available space.
*/
None = "None",
/**
* A scroll bar is always shown even if the space is large enough for the current content.
*/
Scroll = "Scroll",
}
/**
*/
namespace search {
/**
* A SearchProvider which uses the OpenSearch protocol (either JSON or XML).
*/
export class OpenSearchProvider extends sap.ui.core.search.SearchProvider {
/**
* Constructor for a new search/OpenSearchProvider.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.search.OpenSearchProvider with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.search.SearchProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.search.OpenSearchProvider.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSuggestType suggestType}.
*
* The type of data which is provided by the given suggestUrl: either 'json' or 'xml'.
*
* Default value is json
.
* @returns {string} Value of property suggestType
*/
public getSuggestType(): string;
/**
* Gets current value of property {@link #getSuggestUrl suggestUrl}.
*
* The URL for suggestions of the search provider. As placeholder for the concrete search queries '{searchTerms}' must be used. For cross domain requests maybe a proxy must be used.
* @returns {sap.ui.core.URI} Value of property suggestUrl
*/
public getSuggestUrl(): sap.ui.core.URI;
/**
* Sets a new value for property {@link #getSuggestType suggestType}.
*
* The type of data which is provided by the given suggestUrl: either 'json' or 'xml'.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is json
.
* @param {string} sSuggestType - New value for property suggestType
* @returns {sap.ui.core.search.OpenSearchProvider} Reference to this
in order to allow method chaining
*/
public setSuggestType(sSuggestType: string): sap.ui.core.search.OpenSearchProvider;
/**
* Sets a new value for property {@link #getSuggestUrl suggestUrl}.
*
* The URL for suggestions of the search provider. As placeholder for the concrete search queries '{searchTerms}' must be used. For cross domain requests maybe a proxy must be used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sSuggestUrl - New value for property suggestUrl
* @returns {sap.ui.core.search.OpenSearchProvider} Reference to this
in order to allow method chaining
*/
public setSuggestUrl(sSuggestUrl: sap.ui.core.URI): sap.ui.core.search.OpenSearchProvider;
/**
* Call this function to get suggest values from the search provider.
* The given callback function is called with the suggest value (type 'string', 1st parameter)
* and an array of the suggestions (type '[string]', 2nd parameter).
* @param {string} sValue - The value for which suggestions are requested.
* @param {Function} fCallback - The callback function which is called when the suggestions are available.
*/
public suggest(sValue: string, fCallback: Function): void;
}
/**
* Abstract base class for all SearchProviders which can be e.g. attached to a SearchField. Do not create instances of this class, but use a concrete sub class instead.
*/
export class SearchProvider extends sap.ui.core.Element {
/**
* Constructor for a new search/SearchProvider.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.search.SearchProvider with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Icon of the Search Provider
* @returns {string} Value of property icon
*/
public getIcon(): string;
/**
* Returns a metadata object for class sap.ui.core.search.SearchProvider.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Icon of the Search Provider
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sIcon - New value for property icon
* @returns {sap.ui.core.search.SearchProvider} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: string): sap.ui.core.search.SearchProvider;
/**
* Call this function to get suggest values from the search provider.
* The given callback function is called with the suggest value (type 'string', 1st parameter)
* and an array of the suggestions (type '[string]', 2nd parameter).
* @param {string} sValue - The value for which suggestions are requested.
* @param {Function} fnCallback - The callback function which is called when the suggestions are available.
*/
public suggest(sValue: string, fnCallback: Function): void;
}
}
/**
* An item that provides a visual separation. It borrows all its methods from the classes sap.ui.core.Item, sap.ui.core.Element,
* sap.ui.base.EventProvider, and sap.ui.base.Object.
*/
export class SeparatorItem extends sap.ui.core.Item {
/**
* Constructor for a new SeparatorItem.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.SeparatorItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.SeparatorItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
*/
namespace service {
/**
* A service provides a specific functionality. A service instance can be obtained
* by a {@link sap.ui.core.service.ServiceFactory ServiceFactory} or at a Component
* via {@link sap.ui.core.Component#getService getService} function.
*
* This class is the abstract base class for services and needs to be extended:
*
* sap.ui.define("my/Service", [
* "sap/ui/core/service/Service"
* ], function(Service) {
*
* return Service.extend("my.Service", {
*
* init: function() {
* // handle init lifecycle
* },
*
* exit: function() {
* // handle exit lifecycle
* },
*
* doSomething: function() {
* // some functionality
* }
*
* });
*
* });
*
*
* A service instance will have a service context:
*
* {
* "scopeObject": oComponent, // the Component instance
* "scopeType": "component" // the stereotype of the scopeObject
* }
*
*
* The service context can be retrieved with the function getContext
.
* This function is private to the service instance and will not be exposed via
* the service interface.
*
* For consumers of the service it is recommended to provide the service instance
* only - as e.g. the {@link sap.ui.core.Component#getService getService} function
* of the Component does. The service interface can be accessed via the
* getInterface
function.
*
* Other private functions of the service instance are the lifecycle functions.
* Currently there are two lifecycle functions: init
and exit
.
* In addition the destroy
function will also by hidden to avoid
* the control of the service lifecycle for service interface consumers.
*/
export class Service extends sap.ui.base.Object {
/**
* Creates a service for the given context.
* @param {any} oServiceContext - Context for which the service is created
*/
public constructor(oServiceContext: any);
/**
* Lifecycle method to destroy the service instance.
*
* This function is not available on the service interface.
*/
public destroy(): void;
/**
* Cleans up the service instance before destruction.
*
* Applications must not call this hook method directly, it is called by the
* framework when the service is {@link #destroy destroyed}.
*
* Subclasses of service should override this hook to implement any necessary
* clean-up.
*/
protected exit(): void;
/**
* Creates a new subclass of class sap.ui.core.service.Service with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the context of the service:
*
* {
* "scopeObject": oComponent, // the Component instance
* "scopeType": "component", // the stereotype of the scopeObject
* "settings": {} // the provided service settings
* }
*
*
* This function is not available on the service interface.
* @returns {any} the context of the service
*/
protected getContext(): any;
/**
* Returns the public interface of the service. By default, this filters the
* internal functions like getInterface
, getContext
* and all other functions starting with "_". Additionally the lifecycle
* functions init
, exit
and destroy
* will be filtered for the service interface. This function can be
* overridden in order to self-create a service interface.
*
* This function is not available on the service interface.
* @returns {sap.ui.base.Interface} the public interface of the service
*/
public getInterface(): sap.ui.base.Interface;
/**
* Returns a metadata object for class sap.ui.core.service.Service.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Initializes the service instance after creation.
*
* Applications must not call this hook method directly, it is called by the
* framework while the constructor of a service is executed.
*
* Subclasses of service should override this hook to implement any necessary
* initialization.
*/
protected init(): void;
}
/**
* A service factory is used to create service instances for a specific context.
* The service factory needs to be registered in a central
* {@link sap.ui.core.service.ServiceFactoryRegistry service factory registry}.
* Consumers of services require the service factory to create service instances.
*
* The service factory base class can be used in a generic way to act as a
* factory for any service:
*
* sap.ui.require([
* "sap/ui/core/service/ServiceFactoryRegistry",
* "sap/ui/core/service/ServiceFactory",
* "my/Service"
* ], function(ServiceFactoryRegistry, ServiceFactory, MyService) {
*
* ServiceFactoryRegistry.register(new ServiceFactory(MService));
*
* });
*
*
* Additionally a concrete service factory can be implemented by extending the
* service factory base class if additional functionality is needed when
* creating new instances for a specific context:
*
* sap.ui.define("my/ServiceFactory", [
* "sap/ui/core/service/ServiceFactoryRegistry",
* "sap/ui/core/service/ServiceFactory",
* "my/Service"
* ], function(ServiceFactoryRegistry, ServiceFactory, MyService) {
*
* return ServiceFactory.extend("my.ServiceFactory", {
* createInstance: function(oServiceContext) {
* return Promise.resolve(new MyService(oServiceContext));
* }
* });
*
* });
*
*
* Another option for the usage of the service factory is to provide a
* structured object with information about the service which will
* create an anonymous service internally:
*
* sap.ui.define("my/ServiceFactory", [
* "sap/ui/core/service/ServiceFactoryRegistry",
* "sap/ui/core/service/ServiceFactory",
* "my/Service"
* ], function(ServiceFactoryRegistry, ServiceFactory, MyService) {
*
* return new ServiceFactory({
*
* init: function() { ... },
* exit: function() { ... },
*
* doSomething: function() { ... }
*
* });
*
* });
*
*
* As createInstance
returns a Promise
e.g. the
* service module can also be loaded asynchronously and resolve once the
* module has been loaded and instantiated.
*/
export class ServiceFactory extends sap.ui.base.Object {
/**
* Creates a service factory.
* @param {Function|any} vService - A constructor function of a service or a structured object with information about the service which creates an anonymous service.
*/
public constructor(vService?: Function|any);
/**
* Creates a new instance of a service. When used as a generic service factory
* by providing a service constructor function it will create a new service
* instance otherwise the function will fail. For custom service factories
* this function has to be overridden and should return a Promise
.
* @param {any} oServiceContext - Context for which the service is created
* @returns {Promise} Promise which resolves with the new Service instance.
*/
protected createInstance(oServiceContext: any): Promise;
/**
* Lifecycle method to destroy the service factory instance.
*/
public destroy(): void;
/**
* Creates a new subclass of class sap.ui.core.service.ServiceFactory with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.service.ServiceFactory.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
}
/**
*/
namespace support {
/**
* This class represents a plugin for the support tool functionality of UI5. This class is internal and all its functions must not be used by an application.
*/
export class Plugin extends sap.ui.base.Object {
/**
* Creates an instance of sap.ui.core.support.Plugin.
*/
public constructor();
/**
* Returns the DOM node that represents this plugin wrapped as jQuery object.
*
* If an ID suffix is given, the ID of this Element is concatenated with the suffix
* (separated by a single dash) and the DOM node with that compound ID will be wrapped by jQuery.
* This matches the naming convention for named inner DOM nodes of a plugin.
*
* If no suffix is given and if no DOM exists, a DIV with the ID of this plugin will be created
* and appended to the support popup content section (identified by class .sapUiSupportCntnt).
* @param {string} sSuffix - ID suffix to get a jQuery object for
* @returns {JQuery} The jQuery wrapped plugin's DOM reference
*/
protected $(sSuffix?: string): JQuery;
/**
* Adds the given stylesheet to the Support Tool's HTML page.
*
* A <link> tag will be added to the head of the HTML page, referring to the given
* CSS resource. The URL of the resource is determined from the given resource name
* by calling {@link jQuery.sap.getResourcePath}.
*
* A plugin should call this method only when it is {@link #runsAsToolPlugin running inside the tool window}.
* @param {string} sCssResourcePath - Resource name of a CSS file, but without the '.css' extension
*/
protected addStylesheet(sCssResourcePath: string): void;
/**
* Finalization function called each time the support mode is ended
* (support popup is closed).
* @param {any} oSupportStub - the support stub
*/
protected exit(oSupportStub: any): void;
/**
* Creates a new subclass of class sap.ui.core.support.Plugin with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the id of this plugin instance.
* @returns {string} the id
*/
protected getId(): string;
/**
* Returns a metadata object for class sap.ui.core.support.Plugin.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the title of this plugin instance.
* @returns {string} the title
*/
protected getTitle(): string;
/**
* Initialization function called each time the support mode is started
* (diagnostics popup is opened).
* For Plugins that are for diagnostics tool window and application window,
* the init method is called twice, with the oSupportStub
* @param {any} oSupportStub - the support stub
*/
protected init(oSupportStub: any): void;
/**
* Returns whether the plugin is currently active or not.
* @returns {boolean} whether the plugin is currently active or not
*/
protected isActive(): boolean;
/**
* Returns whether this plugin instance can run in the application window, default is true
.
* Plugins that are only available on the diagnostics tool window should return false
and overwrite
* the method for this matter.
*
* The method is also used in a static manner (called on the prototype) and therefore must not rely on
* any instance specific members.
* @returns {boolean} whether this plugin instance can run in the application window
*/
protected isAppPlugin(): boolean;
/**
* Returns whether a plugin instance can run in the diagnostics tool window, default is true
.
* Plugins that are only available on the application window should return false
and overwrite
* the method for this matter.
*
* The method is also used in a static manner (called on the prototype) and therefore must not rely on
* any instance specific members.
* @returns {boolean} whether this plugin instance can run in the tool window
*/
protected isToolPlugin(): boolean;
/**
* Returns true if the plugin instance currently runs in tool window, otherwise false
* @returns {boolean} true if the plugin instance runs in the tool window, otherwise false
*/
protected runsAsToolPlugin(): boolean;
}
}
/**
* Configuration options for text alignments.
*/
export enum TextAlign {
/**
* Locale-specific positioning at the beginning of the line.
*/
Begin = "Begin",
/**
* Centered text alignment.
*/
Center = "Center",
/**
* Locale-specific positioning at the end of the line.
*/
End = "End",
/**
* Sets no text align, so the browser default is used.
*/
Initial = "Initial",
/**
* Hard option for left alignment.
*/
Left = "Left",
/**
* Hard option for right alignment.
*/
Right = "Right",
}
/**
* Configuration options for the direction of texts.
*/
export enum TextDirection {
/**
* Inherits the direction from its parent control/container.
*/
Inherit = "Inherit",
/**
* Specifies left-to-right text direction.
*/
LTR = "LTR",
/**
* Specifies right-to-left text direction.
*/
RTL = "RTL",
}
/**
*/
namespace theming {
/**
* A helper used for (read-only) access to CSS parameters at runtime
*/
namespace Parameters {
/**
* Returns the scopes from current theming parameters.
* @param {boolean} bAvoidLoading - Whether loading of parameters should be avoided
* @returns {any[]} Scope names
*/
function _getScopes(bAvoidLoading?: boolean): any[];
/**
* Returns the current value for one or more theming parameters, depending on the given arguments.
*
* - If no parameter is given a key-value map containing all parameters is returned
* - If a
string
is given as first parameter the value is returned as a string
* - If an
array
is given as first parameter a key-value map containing all parameters from the array
is returned
*
* The returned key-value maps are a copy so changing values in the map does not have any effect
* @param {string|string[]} vName - the (array with) CSS parameter name(s)
* @param {sap.ui.core.Element} oElement - Element / control instance to take into account when looking for a parameter value. This can make a difference when a parameter value is overridden in a theme scope set via a CSS class.
* @returns {string|any|any} the CSS parameter value(s)
*/
function get(vName: string|string[], oElement?: sap.ui.core.Element): string|any|any;
/**
* Returns the active scope(s) for a given control by looking up the hierarchy.
*
* The lookup navigates the DOM hierarchy if it's available. Otherwise if controls aren't rendered yet,
* it navigates the control hierarchy. By navigating the control hierarchy, inner-html elements
* with the respective scope classes can't get recognized as the Custom Style Class API does only for
* root elements.
* @param {any} oElement - element/control instance
* @returns {string[][]} Two dimensional array with scopes in bottom up order
*/
function getActiveScopesFor(oElement: any): string[][];
/**
* Resets the CSS parameters which finally will reload the parameters
* the next time they are queried via the method get
.
*/
function reset(): void;
}
}
/**
* Represents a title element that can be used for aggregation with other controls
*/
export class Title extends sap.ui.core.Element {
/**
* Constructor for a new Title.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.Title with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getEmphasized emphasized}.
*
* If set the title is displayed emphasized.
* This feature is nor supported by all controls using the Title.control.
*
* Default value is false
.
* @returns {boolean} Value of property emphasized
*/
public getEmphasized(): boolean;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Defines the URL for icon display
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getLevel level}.
*
* Defines the level of the title. If set to auto the level of the title is chosen by the control rendering the title.
*
* Currently not all controls using the Title.control supporting this property.
*
* Default value is Auto
.
* @returns {sap.ui.core.TitleLevel} Value of property level
*/
public getLevel(): sap.ui.core.TitleLevel;
/**
* Returns a metadata object for class sap.ui.core.Title.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* Defines the title text
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Sets a new value for property {@link #getEmphasized emphasized}.
*
* If set the title is displayed emphasized.
* This feature is nor supported by all controls using the Title.control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEmphasized - New value for property emphasized
* @returns {sap.ui.core.Title} Reference to this
in order to allow method chaining
*/
public setEmphasized(bEmphasized: boolean): sap.ui.core.Title;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Defines the URL for icon display
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.core.Title} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.core.Title;
/**
* Sets a new value for property {@link #getLevel level}.
*
* Defines the level of the title. If set to auto the level of the title is chosen by the control rendering the title.
*
* Currently not all controls using the Title.control supporting this property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.ui.core.TitleLevel} sLevel - New value for property level
* @returns {sap.ui.core.Title} Reference to this
in order to allow method chaining
*/
public setLevel(sLevel: sap.ui.core.TitleLevel): sap.ui.core.Title;
/**
* Sets a new value for property {@link #getText text}.
*
* Defines the title text
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.core.Title} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.core.Title;
}
/**
* Level of a title.
*/
export enum TitleLevel {
/**
* The level of the title is choosen by the control rendering the title.
*/
Auto = "Auto",
/**
* The Title is of level 1.
*/
H1 = "H1",
/**
* The Title is of level 2
*/
H2 = "H2",
/**
* The Title is of level 3
*/
H3 = "H3",
/**
* The Title is of level 4
*/
H4 = "H4",
/**
* The Title is of level 5
*/
H5 = "H5",
/**
* The Title is of level 6
*/
H6 = "H6",
}
/**
*/
namespace tmpl {
/**
* Represents a DOM attribute of a DOM element.
*/
export class DOMAttribute extends sap.ui.core.Element {
/**
* Constructor for a new tmpl/DOMAttribute.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.tmpl.DOMAttribute with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.tmpl.DOMAttribute.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* Name of the DOM attribute
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets current value of property {@link #getValue value}.
*
* Value of the DOM attribute
* @returns {string} Value of property value
*/
public getValue(): string;
/**
* Sets a new value for property {@link #getName name}.
*
* Name of the DOM attribute
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.ui.core.tmpl.DOMAttribute} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.ui.core.tmpl.DOMAttribute;
/**
* Sets a new value for property {@link #getValue value}.
*
* Value of the DOM attribute
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sValue - New value for property value
* @returns {sap.ui.core.tmpl.DOMAttribute} Reference to this
in order to allow method chaining
*/
public setValue(sValue: string): sap.ui.core.tmpl.DOMAttribute;
}
/**
* Represents a DOM element. It allows to use databinding for the properties and nested DOM attributes.
*/
export class DOMElement extends sap.ui.core.Control {
/**
* Constructor for a new tmpl/DOMElement.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some attribute to the aggregation {@link #getAttributes attributes}.
* @param {sap.ui.core.tmpl.DOMAttribute} oAttribute - the attribute to add; if empty, nothing is inserted
* @returns {sap.ui.core.tmpl.DOMElement} Reference to this
in order to allow method chaining
*/
public addAttribute(oAttribute: sap.ui.core.tmpl.DOMAttribute): sap.ui.core.tmpl.DOMElement;
/**
* Adds some element to the aggregation {@link #getElements elements}.
* @param {sap.ui.core.tmpl.DOMElement} oElement - the element to add; if empty, nothing is inserted
* @returns {sap.ui.core.tmpl.DOMElement} Reference to this
in order to allow method chaining
*/
public addElement(oElement: sap.ui.core.tmpl.DOMElement): sap.ui.core.tmpl.DOMElement;
/**
* Returns the value of a DOM attribute if available or undefined if the DOM attribute is not available when using this method with the parameter name only.
* When using the method with the parameter name and value the method acts as a setter and sets the value of a DOM attribute.
* In this case the return value is the reference to this DOM element to support method chaining. If you pass null as value of the attribute the attribute will be removed.
* @param {string} sName - The name of the DOM attribute.
* @param {string} sValue - The value of the DOM attribute. If the value is undefined the DOM attribute will be removed.
* @returns {any} value of attribute or this
when called as a setter
*/
public attr(sName: string, sValue: string): any;
/**
* Destroys all the attributes in the aggregation {@link #getAttributes attributes}.
* @returns {sap.ui.core.tmpl.DOMElement} Reference to this
in order to allow method chaining
*/
public destroyAttributes(): sap.ui.core.tmpl.DOMElement;
/**
* Destroys all the elements in the aggregation {@link #getElements elements}.
* @returns {sap.ui.core.tmpl.DOMElement} Reference to this
in order to allow method chaining
*/
public destroyElements(): sap.ui.core.tmpl.DOMElement;
/**
* Creates a new subclass of class sap.ui.core.tmpl.DOMElement with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getAttributes attributes}.
*
* DOM attributes which are rendered as part of the DOM element and bindable
* @returns {sap.ui.core.tmpl.DOMAttribute[]}
*/
public getAttributes(): sap.ui.core.tmpl.DOMAttribute[];
/**
* Gets content of aggregation {@link #getElements elements}.
*
* Nested DOM elements to support nested bindable structures
* @returns {sap.ui.core.tmpl.DOMElement[]}
*/
public getElements(): sap.ui.core.tmpl.DOMElement[];
/**
* Returns a metadata object for class sap.ui.core.tmpl.DOMElement.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTag tag}.
*
* The HTML-tag of the DOM element which contains the text
*
* Default value is span
.
* @returns {string} Value of property tag
*/
public getTag(): string;
/**
* Gets current value of property {@link #getText text}.
*
* The text content of the DOM element
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Checks for the provided sap.ui.core.tmpl.DOMAttribute
in the aggregation {@link #getAttributes attributes}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.tmpl.DOMAttribute} oAttribute - The attribute whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAttribute(oAttribute: sap.ui.core.tmpl.DOMAttribute): number;
/**
* Checks for the provided sap.ui.core.tmpl.DOMElement
in the aggregation {@link #getElements elements}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.tmpl.DOMElement} oElement - The element whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfElement(oElement: sap.ui.core.tmpl.DOMElement): number;
/**
* Inserts a attribute into the aggregation {@link #getAttributes attributes}.
* @param {sap.ui.core.tmpl.DOMAttribute} oAttribute - the attribute to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the attribute should be inserted at; for a negative value of iIndex
, the attribute is inserted at position 0; for a value greater than the current size of the aggregation, the attribute is inserted at the last position
* @returns {sap.ui.core.tmpl.DOMElement} Reference to this
in order to allow method chaining
*/
public insertAttribute(oAttribute: sap.ui.core.tmpl.DOMAttribute, iIndex: number): sap.ui.core.tmpl.DOMElement;
/**
* Inserts a element into the aggregation {@link #getElements elements}.
* @param {sap.ui.core.tmpl.DOMElement} oElement - the element to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the element should be inserted at; for a negative value of iIndex
, the element is inserted at position 0; for a value greater than the current size of the aggregation, the element is inserted at the last position
* @returns {sap.ui.core.tmpl.DOMElement} Reference to this
in order to allow method chaining
*/
public insertElement(oElement: sap.ui.core.tmpl.DOMElement, iIndex: number): sap.ui.core.tmpl.DOMElement;
/**
* Removes all the controls from the aggregation {@link #getAttributes attributes}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.tmpl.DOMAttribute[]} An array of the removed elements (might be empty)
*/
public removeAllAttributes(): sap.ui.core.tmpl.DOMAttribute[];
/**
* Removes all the controls from the aggregation {@link #getElements elements}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.tmpl.DOMElement[]} An array of the removed elements (might be empty)
*/
public removeAllElements(): sap.ui.core.tmpl.DOMElement[];
/**
* Removes the DOM attribute for the given name and returns the reference to this DOM element to support method chaining.
* @param {string} sName - The name of the DOM attribute.
* @returns {sap.ui.core.tmpl.DOMElement}
*/
public removeAttr(sName: string): sap.ui.core.tmpl.DOMElement;
/**
* Removes a attribute from the aggregation {@link #getAttributes attributes}.
* @param {number|string|sap.ui.core.tmpl.DOMAttribute} vAttribute - The attribute to remove or its index or id
* @returns {sap.ui.core.tmpl.DOMAttribute} The removed attribute or null
*/
public removeAttribute(vAttribute: number|string|sap.ui.core.tmpl.DOMAttribute): sap.ui.core.tmpl.DOMAttribute;
/**
* Removes a element from the aggregation {@link #getElements elements}.
* @param {number|string|sap.ui.core.tmpl.DOMElement} vElement - The element to remove or its index or id
* @returns {sap.ui.core.tmpl.DOMElement} The removed element or null
*/
public removeElement(vElement: number|string|sap.ui.core.tmpl.DOMElement): sap.ui.core.tmpl.DOMElement;
/**
* Sets a new value for property {@link #getTag tag}.
*
* The HTML-tag of the DOM element which contains the text
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is span
.
* @param {string} sTag - New value for property tag
* @returns {sap.ui.core.tmpl.DOMElement} Reference to this
in order to allow method chaining
*/
public setTag(sTag: string): sap.ui.core.tmpl.DOMElement;
/**
* Sets a new value for property {@link #getText text}.
*
* The text content of the DOM element
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.core.tmpl.DOMElement} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.core.tmpl.DOMElement;
}
/**
* The class for Handlebars Templates.
*/
export class HandlebarsTemplate extends sap.ui.core.tmpl.Template {
/**
* Creates and initializes a new handlebars template with the given sId
* and settings.
*
* The set of allowed entries in the mSettings
object depends on
* the concrete subclass and is described there.
* @param {string} sId - optional id for the new template; generated automatically if no non-empty id is given Note: this can be omitted, no matter whether mSettings
will be given or not!
* @param {any} mSettings - optional map/JSON-object with initial settings for the new component instance
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.tmpl.HandlebarsTemplate with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.tmpl.Template.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.tmpl.HandlebarsTemplate.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Base Class for Template.
*/
export class Template extends sap.ui.base.ManagedObject {
/**
* Creates and initializes a new template with the given sId
and
* settings.
*
* The set of allowed entries in the mSettings
object depends on
* the concrete subclass and is described there.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - optional id for the new template; generated automatically if no non-empty id is given Note: this can be omitted, no matter whether mSettings
will be given or not!
* @param {any} mSettings - optional map/JSON-object with initial settings for the new component instance
*/
public constructor(sId?: string, mSettings?: any);
/**
* Returns the registered template for the given ID, if any.
* @param {string} sId
* @returns {sap.ui.core.tmpl.Template} the template for the given ID
*/
public static byId(sId: string): sap.ui.core.tmpl.Template;
/**
* Creates an anonymous TemplateControl for the Template.
* @param {string} sId - the control ID
* @param {sap.ui.core.mvc.View} oView
* @returns {sap.ui.core.tmpl.TemplateControl} the created control instance
*/
public createControl(sId: string, oView: sap.ui.core.mvc.View): sap.ui.core.tmpl.TemplateControl;
/**
* Creates an anonymous TemplateControl for the Template.
* @param {string} sId - the control ID
* @param {any} oContext - the context for the renderer/templating
* @param {sap.ui.core.mvc.View} oView
* @returns {sap.ui.core.tmpl.TemplateControl} the created control instance
*/
public createControl(sId: string, oContext: any, oView: sap.ui.core.mvc.View): sap.ui.core.tmpl.TemplateControl;
/**
* Declares a new control based on this template and returns the created
* class / constructor function. The class is based on the information coming
* from the abstract functions createMetadata
and
* createRenderer
.
* @param {string} sControl - the fully qualified name of the control
* @returns {Function} the created class / constructor function
*/
public declareControl(sControl: string): Function;
/**
* Creates a new subclass of class sap.ui.core.tmpl.Template with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getContent content}.
*
* The Template definition as a String.
* @returns {string} Value of property content
*/
public getContent(): string;
/**
* @returns {sap.ui.base.Interface}
*/
public getInterface(): sap.ui.base.Interface;
/**
* Returns a metadata object for class sap.ui.core.tmpl.Template.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* parses the given path and extracts the model and path
* @param {string} sPath - the path
* @returns {any} the model and the path
*/
protected static parsePath(sPath: string): any;
/**
* Creates an anonymous TemplateControl for the Template and places the control
* into the specified DOM element.
* @param {string|HTMLElement} oRef - the id or the DOM reference where to render the template
* @param {boolean} bInline
* @returns {sap.ui.core.tmpl.TemplateControl} the created control instance
*/
public placeAt(oRef: string|HTMLElement, bInline: boolean): sap.ui.core.tmpl.TemplateControl;
/**
* Creates an anonymous TemplateControl for the Template and places the control
* into the specified DOM element.
* @param {string|HTMLElement} oRef - the id or the DOM reference where to render the template
* @param {string|number} vPosition - Describes the position where the control should be put into the container
* @param {boolean} bInline
* @returns {sap.ui.core.tmpl.TemplateControl} the created control instance
*/
public placeAt(oRef: string|HTMLElement, vPosition: string|number, bInline: boolean): sap.ui.core.tmpl.TemplateControl;
/**
* Creates an anonymous TemplateControl for the Template and places the control
* into the specified DOM element.
* @param {string|HTMLElement} oRef - the id or the DOM reference where to render the template
* @param {any} oContext - The context to use to evaluate the Template. It will be applied as value for the context property of the created control.
* @param {boolean} bInline
* @returns {sap.ui.core.tmpl.TemplateControl} the created control instance
*/
public placeAt(oRef: string|HTMLElement, oContext: any, bInline: boolean): sap.ui.core.tmpl.TemplateControl;
/**
* Creates an anonymous TemplateControl for the Template and places the control
* into the specified DOM element.
* @param {string|HTMLElement} oRef - the id or the DOM reference where to render the template
* @param {any} oContext - The context to use to evaluate the Template. It will be applied as value for the context property of the created control.
* @param {string|number} vPosition - Describes the position where the control should be put into the container
* @param {boolean} bInline
* @returns {sap.ui.core.tmpl.TemplateControl} the created control instance
*/
public placeAt(oRef: string|HTMLElement, oContext: any, vPosition: string|number, bInline: boolean): sap.ui.core.tmpl.TemplateControl;
/**
* Sets a new value for property {@link #getContent content}.
*
* The Template definition as a String.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sContent - New value for property content
* @returns {sap.ui.core.tmpl.Template} Reference to this
in order to allow method chaining
*/
public setContent(sContent: string): sap.ui.core.tmpl.Template;
}
/**
* This is the base class for all template controls. Template controls are declared based on templates.
*/
export class TemplateControl extends sap.ui.core.Control {
/**
* Constructor for a new tmpl/TemplateControl.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:afterRendering afterRendering} event of this sap.ui.core.tmpl.TemplateControl
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.tmpl.TemplateControl
itself.
*
* Fired when the Template Control has been (re-)rendered and its HTML is present in the DOM.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.tmpl.TemplateControl
itself
* @returns {sap.ui.core.tmpl.TemplateControl} Reference to this
in order to allow method chaining
*/
public attachAfterRendering(fnFunction: Function, oListener?: any): sap.ui.core.tmpl.TemplateControl;
/**
* Attaches event handler fnFunction
to the {@link #event:afterRendering afterRendering} event of this sap.ui.core.tmpl.TemplateControl
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.tmpl.TemplateControl
itself.
*
* Fired when the Template Control has been (re-)rendered and its HTML is present in the DOM.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.tmpl.TemplateControl
itself
* @returns {sap.ui.core.tmpl.TemplateControl} Reference to this
in order to allow method chaining
*/
public attachAfterRendering(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.tmpl.TemplateControl;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeRendering beforeRendering} event of this sap.ui.core.tmpl.TemplateControl
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.tmpl.TemplateControl
itself.
*
* Fired before this Template Control is re-rendered. Use to unbind event handlers from HTML elements etc.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.tmpl.TemplateControl
itself
* @returns {sap.ui.core.tmpl.TemplateControl} Reference to this
in order to allow method chaining
*/
public attachBeforeRendering(fnFunction: Function, oListener?: any): sap.ui.core.tmpl.TemplateControl;
/**
* Attaches event handler fnFunction
to the {@link #event:beforeRendering beforeRendering} event of this sap.ui.core.tmpl.TemplateControl
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.tmpl.TemplateControl
itself.
*
* Fired before this Template Control is re-rendered. Use to unbind event handlers from HTML elements etc.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.tmpl.TemplateControl
itself
* @returns {sap.ui.core.tmpl.TemplateControl} Reference to this
in order to allow method chaining
*/
public attachBeforeRendering(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.tmpl.TemplateControl;
/**
* Creates a pseudo binding for an aggregation to get notified once the property
* changes to invalidate the control and trigger a re-rendering.
* @param {string} sPath - the binding path
* @returns {any} the value of the path
*/
protected bindList(sPath: string): any;
/**
* Creates a pseudo binding for a property to get notified once the property
* changes to invalidate the control and trigger a re-rendering.
* @param {string} sPath - the binding path
* @returns {any} the value of the path
*/
protected bindProp(sPath: string): any;
/**
* compiles (creates and registers) a new control
* @param {any} mSettings - the settings for the new control
* @param {sap.ui.core.mvc.View} oView
* @returns {sap.ui.core.Control} new control instance
*/
protected createControl(mSettings: any, oView: sap.ui.core.mvc.View): sap.ui.core.Control;
/**
* compiles (creates and registers) a new control
* @param {any} mSettings - the settings for the new control
* @param {boolean} bDoNotAdd - if true, then the control will not be added to the _controls aggregation
* @param {sap.ui.core.mvc.View} oView
* @returns {sap.ui.core.Control} new control instance
*/
protected createControl(mSettings: any, bDoNotAdd: boolean, oView: sap.ui.core.mvc.View): sap.ui.core.Control;
/**
* compiles (creates and registers) a new control
* @param {any} mSettings - the settings for the new control
* @param {string} sParentPath - the parent path for the control
* @param {sap.ui.core.mvc.View} oView
* @returns {sap.ui.core.Control} new control instance
*/
protected createControl(mSettings: any, sParentPath: string, oView: sap.ui.core.mvc.View): sap.ui.core.Control;
/**
* compiles (creates and registers) a new control
* @param {any} mSettings - the settings for the new control
* @param {string} sParentPath - the parent path for the control
* @param {boolean} bDoNotAdd - if true, then the control will not be added to the _controls aggregation
* @param {sap.ui.core.mvc.View} oView
* @returns {sap.ui.core.Control} new control instance
*/
protected createControl(mSettings: any, sParentPath: string, bDoNotAdd: boolean, oView: sap.ui.core.mvc.View): sap.ui.core.Control;
/**
* compiles (creates and registers) a new DOM element
* @param {any} mSettings - the settings for the new DOM element
* @param {string} sParentPath - the parent path for the DOM element
* @param {boolean} bDoNotAdd - if true, then the control will not be added to the _controls aggregation
* @returns {sap.ui.core.Control} new DOM element instance
*/
protected createDOMElement(mSettings: any, sParentPath?: string, bDoNotAdd?: boolean): sap.ui.core.Control;
/**
* Detaches event handler fnFunction
from the {@link #event:afterRendering afterRendering} event of this sap.ui.core.tmpl.TemplateControl
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.core.tmpl.TemplateControl} Reference to this
in order to allow method chaining
*/
public detachAfterRendering(fnFunction: Function, oListener: any): sap.ui.core.tmpl.TemplateControl;
/**
* Detaches event handler fnFunction
from the {@link #event:beforeRendering beforeRendering} event of this sap.ui.core.tmpl.TemplateControl
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.core.tmpl.TemplateControl} Reference to this
in order to allow method chaining
*/
public detachBeforeRendering(fnFunction: Function, oListener: any): sap.ui.core.tmpl.TemplateControl;
/**
* Creates a new subclass of class sap.ui.core.tmpl.TemplateControl with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:afterRendering afterRendering} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.core.tmpl.TemplateControl} Reference to this
in order to allow method chaining
*/
protected fireAfterRendering(mParameters?: any): sap.ui.core.tmpl.TemplateControl;
/**
* Fires event {@link #event:beforeRendering beforeRendering} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.core.tmpl.TemplateControl} Reference to this
in order to allow method chaining
*/
protected fireBeforeRendering(mParameters?: any): sap.ui.core.tmpl.TemplateControl;
/**
* Gets current value of property {@link #getContext context}.
*
* The context is a data object. It can be used for default template expressions. A change of the context object leads to a re-rendering whereas a change of a nested property of the context object doesn't. By default the context is an empty object.
* @returns {any} Value of property context
*/
public getContext(): any;
/**
* Returns a metadata object for class sap.ui.core.tmpl.TemplateControl.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* ID of the element which is the current target of the association {@link #getTemplate template}, or null
.
* @returns {sap.ui.core.ID}
*/
public getTemplate(): sap.ui.core.ID;
/**
* Returns the instance specific renderer for an anonymous template control.
* @returns {Function} the instance specific renderer function
*/
protected getTemplateRenderer(): Function;
/**
* checks whether the control is inline or not
* @returns {boolean} flag, whether to control is inline or not
*/
protected isInline(): boolean;
/**
* Sets a new value for property {@link #getContext context}.
*
* The context is a data object. It can be used for default template expressions. A change of the context object leads to a re-rendering whereas a change of a nested property of the context object doesn't. By default the context is an empty object.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oContext - New value for property context
* @returns {sap.ui.core.tmpl.TemplateControl} Reference to this
in order to allow method chaining
*/
public setContext(oContext: any): sap.ui.core.tmpl.TemplateControl;
/**
* Sets the associated {@link #getTemplate template}.
* @param {sap.ui.core.ID|sap.ui.core.tmpl.Template} oTemplate - ID of an element which becomes the new target of this template association; alternatively, an element instance may be given
* @returns {sap.ui.core.tmpl.TemplateControl} Reference to this
in order to allow method chaining
*/
public setTemplate(oTemplate: sap.ui.core.ID|sap.ui.core.tmpl.Template): sap.ui.core.tmpl.TemplateControl;
/**
* Sets the instance specific renderer for an anonymous template control.
* @param {Function} fnRenderer - the instance specific renderer function
* @returns {sap.ui.core.tmpl.Template} this
to allow method chaining
*/
protected setTemplateRenderer(fnRenderer: Function): sap.ui.core.tmpl.Template;
}
}
/**
* Marker interface for toolbar controls.
*/
export interface Toolbar {
}
/**
* Abstract class that can be extended in order to implement any extended tooltip. For example, RichTooltip Control is based on it. It provides the opening/closing behavior and the main "text" property.
*/
export class TooltipBase extends sap.ui.core.Control {
/**
* Constructor for a new TooltipBase.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:closed closed} event of this sap.ui.core.TooltipBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.TooltipBase
itself.
*
* This event is fired when the Tooltip has been closed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.TooltipBase
itself
* @returns {sap.ui.core.TooltipBase} Reference to this
in order to allow method chaining
*/
public attachClosed(fnFunction: Function, oListener?: any): sap.ui.core.TooltipBase;
/**
* Attaches event handler fnFunction
to the {@link #event:closed closed} event of this sap.ui.core.TooltipBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.core.TooltipBase
itself.
*
* This event is fired when the Tooltip has been closed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.core.TooltipBase
itself
* @returns {sap.ui.core.TooltipBase} Reference to this
in order to allow method chaining
*/
public attachClosed(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.TooltipBase;
/**
* Detaches event handler fnFunction
from the {@link #event:closed closed} event of this sap.ui.core.TooltipBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.core.TooltipBase} Reference to this
in order to allow method chaining
*/
public detachClosed(fnFunction: Function, oListener: any): sap.ui.core.TooltipBase;
/**
* Creates a new subclass of class sap.ui.core.TooltipBase with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:closed closed} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.core.TooltipBase} Reference to this
in order to allow method chaining
*/
protected fireClosed(mParameters?: any): sap.ui.core.TooltipBase;
/**
* Gets current value of property {@link #getAtPosition atPosition}.
*
* Optional. At position defines which position on the target control to align the positioned tooltip.
*
* Default value is begin bottom
.
* @returns {sap.ui.core.Dock} Value of property atPosition
*/
public getAtPosition(): sap.ui.core.Dock;
/**
* Gets current value of property {@link #getCloseDelay closeDelay}.
*
* Closing delay of the tooltip in milliseconds
*
* Default value is 100
.
* @returns {number} Value of property closeDelay
*/
public getCloseDelay(): number;
/**
* Gets current value of property {@link #getCloseDuration closeDuration}.
*
* Optional. Close Duration in milliseconds.
*
* Default value is 200
.
* @returns {number} Value of property closeDuration
*/
public getCloseDuration(): number;
/**
* Gets current value of property {@link #getCollision collision}.
*
* Optional. Collision - when the positioned element overflows the window in some direction, move it to an alternative position.
*
* Default value is flip
.
* @returns {sap.ui.core.Collision} Value of property collision
*/
public getCollision(): sap.ui.core.Collision;
/**
* Returns a metadata object for class sap.ui.core.TooltipBase.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMyPosition myPosition}.
*
* Optional. My position defines which position on the extended tooltip being positioned to align with the target control.
*
* Default value is begin top
.
* @returns {sap.ui.core.Dock} Value of property myPosition
*/
public getMyPosition(): sap.ui.core.Dock;
/**
* Gets current value of property {@link #getOffset offset}.
*
* Optional. Offset adds these left-top values to the calculated position.
* Example: "10 3".
*
* Default value is 10 3
.
* @returns {string} Value of property offset
*/
public getOffset(): string;
/**
* Gets current value of property {@link #getOpenDelay openDelay}.
*
* Opening delay of the tooltip in milliseconds
*
* Default value is 500
.
* @returns {number} Value of property openDelay
*/
public getOpenDelay(): number;
/**
* Gets current value of property {@link #getOpenDuration openDuration}.
*
* Optional. Open Duration in milliseconds.
*
* Default value is 200
.
* @returns {number} Value of property openDuration
*/
public getOpenDuration(): number;
/**
* Gets current value of property {@link #getText text}.
*
* The text that is shown in the tooltip that extends the TooltipBase class, for example in RichTooltip.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Sets a new value for property {@link #getAtPosition atPosition}.
*
* Optional. At position defines which position on the target control to align the positioned tooltip.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is begin bottom
.
* @param {sap.ui.core.Dock} sAtPosition - New value for property atPosition
* @returns {sap.ui.core.TooltipBase} Reference to this
in order to allow method chaining
*/
public setAtPosition(sAtPosition: sap.ui.core.Dock): sap.ui.core.TooltipBase;
/**
* Sets a new value for property {@link #getCloseDelay closeDelay}.
*
* Closing delay of the tooltip in milliseconds
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100
.
* @param {number} iCloseDelay - New value for property closeDelay
* @returns {sap.ui.core.TooltipBase} Reference to this
in order to allow method chaining
*/
public setCloseDelay(iCloseDelay: number): sap.ui.core.TooltipBase;
/**
* Sets a new value for property {@link #getCloseDuration closeDuration}.
*
* Optional. Close Duration in milliseconds.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 200
.
* @param {number} iCloseDuration - New value for property closeDuration
* @returns {sap.ui.core.TooltipBase} Reference to this
in order to allow method chaining
*/
public setCloseDuration(iCloseDuration: number): sap.ui.core.TooltipBase;
/**
* Sets a new value for property {@link #getCollision collision}.
*
* Optional. Collision - when the positioned element overflows the window in some direction, move it to an alternative position.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is flip
.
* @param {sap.ui.core.Collision} sCollision - New value for property collision
* @returns {sap.ui.core.TooltipBase} Reference to this
in order to allow method chaining
*/
public setCollision(sCollision: sap.ui.core.Collision): sap.ui.core.TooltipBase;
/**
* Sets a new value for property {@link #getMyPosition myPosition}.
*
* Optional. My position defines which position on the extended tooltip being positioned to align with the target control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is begin top
.
* @param {sap.ui.core.Dock} sMyPosition - New value for property myPosition
* @returns {sap.ui.core.TooltipBase} Reference to this
in order to allow method chaining
*/
public setMyPosition(sMyPosition: sap.ui.core.Dock): sap.ui.core.TooltipBase;
/**
* Sets a new value for property {@link #getOffset offset}.
*
* Optional. Offset adds these left-top values to the calculated position.
* Example: "10 3".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 10 3
.
* @param {string} sOffset - New value for property offset
* @returns {sap.ui.core.TooltipBase} Reference to this
in order to allow method chaining
*/
public setOffset(sOffset: string): sap.ui.core.TooltipBase;
/**
* Sets a new value for property {@link #getOpenDelay openDelay}.
*
* Opening delay of the tooltip in milliseconds
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 500
.
* @param {number} iOpenDelay - New value for property openDelay
* @returns {sap.ui.core.TooltipBase} Reference to this
in order to allow method chaining
*/
public setOpenDelay(iOpenDelay: number): sap.ui.core.TooltipBase;
/**
* Sets a new value for property {@link #getOpenDuration openDuration}.
*
* Optional. Open Duration in milliseconds.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 200
.
* @param {number} iOpenDuration - New value for property openDuration
* @returns {sap.ui.core.TooltipBase} Reference to this
in order to allow method chaining
*/
public setOpenDuration(iOpenDuration: number): sap.ui.core.TooltipBase;
/**
* Sets a new value for property {@link #getText text}.
*
* The text that is shown in the tooltip that extends the TooltipBase class, for example in RichTooltip.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sText - New value for property text
* @returns {sap.ui.core.TooltipBase} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.core.TooltipBase;
}
/**
* An area in a page that hosts a tree of UI elements.
*
* Provides means for event-handling, rerendering, etc.
*
* Special aggregation "dependents" is connected to the lifecycle management and databinding,
* but not rendered automatically and can be used for popups or other dependent controls. This allows
* definition of popup controls in declarative views and enables propagation of model and context
* information to them.
*/
export class UIArea extends sap.ui.base.ManagedObject {
/**
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {sap.ui.core.Core} oCore - internal API of the Core
that manages this UIArea
* @param {any} oRootNode - reference to the Dom Node that should be 'hosting' the UI Area.
*/
public constructor(oCore: sap.ui.core.Core, oRootNode?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.core.UIArea} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.core.UIArea;
/**
* Adds some dependent to the aggregation {@link #getDependents dependents}.
* @param {sap.ui.core.Control} oDependent - the dependent to add; if empty, nothing is inserted
* @returns {sap.ui.core.UIArea} Reference to this
in order to allow method chaining
*/
public addDependent(oDependent: sap.ui.core.Control): sap.ui.core.UIArea;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.core.UIArea} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.core.UIArea;
/**
* Destroys all the dependents in the aggregation {@link #getDependents dependents}.
* @returns {sap.ui.core.UIArea} Reference to this
in order to allow method chaining
*/
public destroyDependents(): sap.ui.core.UIArea;
/**
* Creates a new subclass of class sap.ui.core.UIArea with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Provide getBindingContext, as UIArea can be parent of an element.
* @returns {sap.ui.model.Context} Always returns null.
*/
public getBindingContext(): sap.ui.model.Context;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Content that is displayed in the UIArea.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets content of aggregation {@link #getDependents dependents}.
*
* Dependent objects whose lifecycle is bound to the UIarea but which are not automatically rendered by the UIArea.
* @returns {sap.ui.core.Control[]}
*/
public getDependents(): sap.ui.core.Control[];
/**
* Returns the Core's event provider as new eventing parent to enable control event bubbling to the core to ensure compatibility with the core validation events.
* @returns {sap.ui.base.EventProvider} the parent event provider
*/
protected getEventingParent(): sap.ui.base.EventProvider;
/**
* Returns this UIArea
's id (as determined from provided RootNode).
* @returns {string} id of this UIArea
*/
public getId(): string;
/**
* Returns a metadata object for class sap.ui.core.UIArea.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the content control of this UIArea
at the specified index.
* If no index is given the first content control is returned.
* @param {number} idx - index of the control in the content of this UIArea
* @returns {sap.ui.core.Control} the content control of this UIArea
at the specified index.
*/
public getRootControl(idx: number): sap.ui.core.Control;
/**
* Returns the Root Node hosting this instance of UIArea
.
* @returns {Element} the Root Node hosting this instance of UIArea
.
*/
public getRootNode(): Element;
/**
* Returns this UI area. Needed to stop recursive calls from an element to its parent.
* @returns {sap.ui.core.UIArea} this
*/
protected getUIArea(): sap.ui.core.UIArea;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getDependents dependents}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oDependent - The dependent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfDependent(oDependent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.core.UIArea} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.core.UIArea;
/**
* Inserts a dependent into the aggregation {@link #getDependents dependents}.
* @param {sap.ui.core.Control} oDependent - the dependent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the dependent should be inserted at; for a negative value of iIndex
, the dependent is inserted at position 0; for a value greater than the current size of the aggregation, the dependent is inserted at the last position
* @returns {sap.ui.core.UIArea} Reference to this
in order to allow method chaining
*/
public insertDependent(oDependent: sap.ui.core.Control, iIndex: number): sap.ui.core.UIArea;
/**
* Will be used as end-point for invalidate-bubbling from controls up their hierarchy.
Triggers re-rendering of
* the UIAreas content.
*/
protected invalidate(): void;
/**
* Checks whether the control is still valid (is in the DOM)
* @returns {boolean} True if the control is still in the active DOM
*/
protected isActive(): boolean;
/**
* Returns whether rerendering is currently suppressed on this UIArea
* @returns {any} boolean
*/
protected isInvalidateSuppressed(): any;
/**
* Returns the locked state of the sap.ui.core.UIArea
* @returns {boolean} locked state
*/
public isLocked(): boolean;
/**
* Locks this instance of UIArea.
*
* Rerendering and eventing will not be active as long as no
* {@link #unlock} is called.
*/
public lock(): void;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getDependents dependents}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllDependents(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a dependent from the aggregation {@link #getDependents dependents}.
* @param {number|string|sap.ui.core.Control} vDependent - The dependent to remove or its index or id
* @returns {sap.ui.core.Control} The removed dependent or null
*/
public removeDependent(vDependent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets the root control to be displayed in this UIArea.
*
* First, all old content controls (if any) will be detached from this UIArea (e.g. their parent
* relationship to this UIArea will be cut off). Then the parent relationship for the new
* content control (if not empty) will be set to this UIArea and finally, the UIArea will
* be marked for re-rendering.
*
* The real re-rendering happens whenever the re-rendering is called. Either implicitly
* at the end of any control event or by calling sap.ui.getCore().applyChanges().
* @param {sap.ui.base.Interface|sap.ui.core.Control} oRootControl - the Control that should be the Root for this UIArea
.
*/
public setRootControl(oRootControl: sap.ui.base.Interface|sap.ui.core.Control): void;
/**
* Allows setting the Root Node hosting this instance of UIArea
.
The Dom Ref must have an Id that
* will be used as Id for this instance of UIArea
.
* @param {any} oRootNode - the hosting Dom Ref for this instance of UIArea
.
*/
public setRootNode(oRootNode: any): void;
/**
* Un-Locks this instance of UIArea.
*
* Rerendering and eventing will now be enabled again.
*/
public unlock(): void;
}
/**
* Creates and initializes a new UIComponent with the given sId
and
* settings.
*
* The set of allowed entries in the mSettings
object depends on
* the concrete subclass and is described there. See {@link sap.ui.core.Component}
* for a general description of this argument.
*/
export class UIComponent extends sap.ui.core.Component {
/**
* Base Class for UIComponent.
*
* If you are extending a UIComponent make sure you read the {@link #.extend} documentation since the metadata is special.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Optional ID for the new control; generated automatically if no non-empty ID is given Note: this can be omitted, no matter whether mSettings
will be given or not!
* @param {any} mSettings - optional map/JSON-object with initial settings for the new component instance
*/
public constructor(sId?: string, mSettings?: any);
/**
* Returns an element by its ID in the context of the component.
* @param {string} sId - Component local ID of the element
* @returns {sap.ui.core.Element} element by its ID or undefined
*/
public byId(sId: string): sap.ui.core.Element;
/**
* Hook method to create the content (UI Control Tree) of this component.
*
* The default implementation in this class reads the name (and optionally type) of a root view from the
* descriptor for this component (path /sap.ui5/rootView
) or, for backward compatibility,
* just the name from static component metadata (property rootView
). When no type is specified,
* it defaults to XML. The method then calls the {@link sap.ui.view view factory} to instantiate the root
* view and returns the result.
*
* When there is no root view configuration, null
will be returned.
*
* This method can be overwritten by subclasses if the default implementation doesn't fit their needs.
* Subclasses are not limited to views as return type but may return any control, but only a single control
* (can be the root of a larger control tree, however).
* @returns {sap.ui.core.mvc.View|sap.ui.core.Control} Root control of the UI tree or null
if none is configured
*/
public createContent(): sap.ui.core.mvc.View|sap.ui.core.Control;
/**
* Convert the given component local element ID to a globally unique ID
* by prefixing it with the component ID.
* @param {string} sId - Component local ID of the element
* @returns {string} prefixed id
*/
public createId(sId: string): string;
/**
* Creates a new subclass of class sap.ui.core.UIComponent with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Component.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* A method to be implemented by UIComponents, returning the flag whether to prefix
* the IDs of controls automatically or not if the controls are created inside
* the {@link sap.ui.core.UIComponent#createContent} function. By default this
* feature is not activated.
*
* You can overwrite this function and return true
to activate the automatic
* prefixing. In addition the default behavior can be configured in the manifest
* by specifying the entry sap.ui5/autoPrefixId
.
* @returns {boolean} true, if the Controls IDs should be prefixed automatically
*/
protected getAutoPrefixId(): boolean;
/**
* @returns {sap.ui.base.EventProvider}
*/
protected getEventingParent(): sap.ui.base.EventProvider;
/**
* Returns the local ID of an element by removing the component ID prefix or
* null
if the ID does not contain a prefix.
* @param {string} sId - Prefixed ID
* @returns {string} ID without prefix or null
*/
public getLocalId(sId: string): string;
/**
* Returns a metadata object for class sap.ui.core.UIComponent.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the content of {@link sap.ui.core.UIComponent#createContent}.
* If you specified a rootView
in your metadata or in the descriptor file (manifest.json),
* you will get the instance of the root view.
* This getter will only return something if the {@link sap.ui.core.UIComponent#init} function was invoked.
* If createContent
is not implemented, and there is no root view, it will return null
. Here is an example:
*
*
* var MyExtension = UIComponent.extend("my.Component", {
* metadata: {
* rootView: "my.View"
* },
* init: function () {
* this.getRootControl(); // returns null
* UIComponent.prototype.init.apply(this, arguments);
* this.getRootControl(); // returns the view "my.View"
* }
* });
*
*
* @returns {sap.ui.core.Control} the control created by {@link sap.ui.core.UIComponent#createContent}
*/
protected getRootControl(): sap.ui.core.Control;
/**
* Returns the reference to the router instance which has been created by
* the UIComponent once the routes in the routing metadata has been defined.
* @returns {sap.ui.core.routing.Router} the router instance
*/
public getRouter(): sap.ui.core.routing.Router;
/**
* Returns the reference to the router instance. The passed controller or view
* has to be created in the context of a UIComponent to return the router
* instance. Otherwise this function will return undefined.
* You may define the routerClass property in the config section of the routing to make the Component create your router extension.
* Example:
* routing: {
* config: {
* routerClass : myAppNamespace.MyRouterClass
* ...
* }
* ...
* @param {sap.ui.core.mvc.View|sap.ui.core.mvc.Controller} oControllerOrView - either a view or controller
* @returns {sap.ui.core.routing.Router} the router instance
*/
public static getRouterFor(oControllerOrView: sap.ui.core.mvc.View|sap.ui.core.mvc.Controller): sap.ui.core.routing.Router;
/**
* Returns the reference to the Targets instance which has been created by
* the UIComponent once the targets in the routing metadata has been defined.
* If routes have been defined, it will be the Targets instance created and used by the router.
* @returns {sap.ui.core.routing.Targets} the targets instance
*/
public getTargets(): sap.ui.core.routing.Targets;
/**
* Returns the reference to the UIArea of the container.
* @returns {sap.ui.core.UIArea} reference to the UIArea of the container
*/
public getUIArea(): sap.ui.core.UIArea;
/**
* Initializes the Component instance after creation.
*
* Applications must not call this hook method directly, it is called by the
* framework while the constructor of a Component is executed.
*
* Subclasses of Component should override this hook to implement any necessary
* initialization. When overriding this function make sure to invoke the
* init function of the UIComponent as well!
*/
protected init(): void;
/**
* Function is called when the rendering of the ComponentContainer is completed.
*
* Applications must not call this hook method directly, it is called from ComponentContainer.
*
* Subclasses of UIComponent override this hook to implement any necessary actions after the rendering.
*/
protected onAfterRendering(): void;
/**
* Function is called when the rendering of the ComponentContainer is started.
*
* Applications must not call this hook method directly, it is called from ComponentContainer.
*
* Subclasses of UIComponent override this hook to implement any necessary actions before the rendering.
*/
protected onBeforeRendering(): void;
/**
* Renders the the root control of the UIComponent.
* @param {sap.ui.core.RenderManager} oRenderManager - a RenderManager instance
*/
public render(oRenderManager: sap.ui.core.RenderManager): void;
/**
* Sets the reference to the ComponentContainer - later required for the
* determination of the UIArea for the UIComponent.
* @param {sap.ui.core.ComponentContainer} oContainer - reference to a ComponentContainer
* @returns {sap.ui.core.UIComponent} reference to this instance to allow method chaining
*/
public setContainer(oContainer: sap.ui.core.ComponentContainer): sap.ui.core.UIComponent;
}
/**
* A string type that represents an RFC 3986 conformant URI.
*/
export type URI = string;
/**
*/
namespace util {
/**
* Export provides the possibility to generate a list of data in a specific format / type, e.g. CSV to use it in other programs / applications.
*/
export class Export extends sap.ui.core.Control {
/**
* Constructor for a new Export.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some column to the aggregation {@link #getColumns columns}.
* @param {sap.ui.core.util.ExportColumn} oColumn - the column to add; if empty, nothing is inserted
* @returns {sap.ui.core.util.Export} Reference to this
in order to allow method chaining
*/
public addColumn(oColumn: sap.ui.core.util.ExportColumn): sap.ui.core.util.Export;
/**
* Adds some row to the aggregation {@link #getRows rows}.
* @param {sap.ui.core.util.ExportRow} oRow - the row to add; if empty, nothing is inserted
* @returns {sap.ui.core.util.Export} Reference to this
in order to allow method chaining
*/
public addRow(oRow: sap.ui.core.util.ExportRow): sap.ui.core.util.Export;
/**
* Binds aggregation {@link #getColumns columns} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.core.util.Export} Reference to this
in order to allow method chaining
*/
public bindColumns(oBindingInfo: any): sap.ui.core.util.Export;
/**
* Binds aggregation {@link #getRows rows} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.core.util.Export} Reference to this
in order to allow method chaining
*/
public bindRows(oBindingInfo: any): sap.ui.core.util.Export;
/**
* Destroys all the columns in the aggregation {@link #getColumns columns}.
* @returns {sap.ui.core.util.Export} Reference to this
in order to allow method chaining
*/
public destroyColumns(): sap.ui.core.util.Export;
/**
* Destroys the exportType in the aggregation {@link #getExportType exportType}.
* @returns {sap.ui.core.util.Export} Reference to this
in order to allow method chaining
*/
public destroyExportType(): sap.ui.core.util.Export;
/**
* Destroys all the rows in the aggregation {@link #getRows rows}.
* @returns {sap.ui.core.util.Export} Reference to this
in order to allow method chaining
*/
public destroyRows(): sap.ui.core.util.Export;
/**
* Creates a new subclass of class sap.ui.core.util.Export with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Generates the file content and returns a Promise
* with the instance as context (this).
* The promise will be resolved with the generated content
* as a string.
*
* Please note: The return value was changed from jQuery Promises to standard ES6 Promises.
* jQuery specific Promise methods ('done', 'fail', 'always', 'pipe' and 'state') are still available but should not be used.
* Please use only the standard methods 'then' and 'catch'!
* @returns {Promise} Promise object
*/
public generate(): Promise;
/**
* Gets content of aggregation {@link #getColumns columns}.
*
* Columns for the Export.
* @returns {sap.ui.core.util.ExportColumn[]}
*/
public getColumns(): sap.ui.core.util.ExportColumn[];
/**
* Gets content of aggregation {@link #getExportType exportType}.
*
* Type that generates the content.
* @returns {sap.ui.core.util.ExportType}
*/
public getExportType(): sap.ui.core.util.ExportType;
/**
* Returns a metadata object for class sap.ui.core.util.Export.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getRows rows}.
*
* Rows of the Export.
* @returns {sap.ui.core.util.ExportRow[]}
*/
public getRows(): sap.ui.core.util.ExportRow[];
/**
* Checks for the provided sap.ui.core.util.ExportColumn
in the aggregation {@link #getColumns columns}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.util.ExportColumn} oColumn - The column whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfColumn(oColumn: sap.ui.core.util.ExportColumn): number;
/**
* Checks for the provided sap.ui.core.util.ExportRow
in the aggregation {@link #getRows rows}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.util.ExportRow} oRow - The row whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfRow(oRow: sap.ui.core.util.ExportRow): number;
/**
* Inserts a column into the aggregation {@link #getColumns columns}.
* @param {sap.ui.core.util.ExportColumn} oColumn - the column to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the column should be inserted at; for a negative value of iIndex
, the column is inserted at position 0; for a value greater than the current size of the aggregation, the column is inserted at the last position
* @returns {sap.ui.core.util.Export} Reference to this
in order to allow method chaining
*/
public insertColumn(oColumn: sap.ui.core.util.ExportColumn, iIndex: number): sap.ui.core.util.Export;
/**
* Inserts a row into the aggregation {@link #getRows rows}.
* @param {sap.ui.core.util.ExportRow} oRow - the row to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the row should be inserted at; for a negative value of iIndex
, the row is inserted at position 0; for a value greater than the current size of the aggregation, the row is inserted at the last position
* @returns {sap.ui.core.util.Export} Reference to this
in order to allow method chaining
*/
public insertRow(oRow: sap.ui.core.util.ExportRow, iIndex: number): sap.ui.core.util.Export;
/**
* Removes all the controls from the aggregation {@link #getColumns columns}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.util.ExportColumn[]} An array of the removed elements (might be empty)
*/
public removeAllColumns(): sap.ui.core.util.ExportColumn[];
/**
* Removes all the controls from the aggregation {@link #getRows rows}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.util.ExportRow[]} An array of the removed elements (might be empty)
*/
public removeAllRows(): sap.ui.core.util.ExportRow[];
/**
* Removes a column from the aggregation {@link #getColumns columns}.
* @param {number|string|sap.ui.core.util.ExportColumn} vColumn - The column to remove or its index or id
* @returns {sap.ui.core.util.ExportColumn} The removed column or null
*/
public removeColumn(vColumn: number|string|sap.ui.core.util.ExportColumn): sap.ui.core.util.ExportColumn;
/**
* Removes a row from the aggregation {@link #getRows rows}.
* @param {number|string|sap.ui.core.util.ExportRow} vRow - The row to remove or its index or id
* @returns {sap.ui.core.util.ExportRow} The removed row or null
*/
public removeRow(vRow: number|string|sap.ui.core.util.ExportRow): sap.ui.core.util.ExportRow;
/**
* Generates the file content, triggers a download / save action and
* returns a Promise with the instance as context (this).
* The promise will be resolved with the generated content
* as a string.
* For information about browser support, see sap.ui.core.util.File.save
*
* Please note: The return value was changed from jQuery Promises to standard ES6 Promises.
* jQuery specific Promise methods ('done', 'fail', 'always', 'pipe' and 'state') are still available but should not be used.
* Please use only the standard methods 'then' and 'catch'!
* @param {string} sFileName - file name, defaults to 'data'
* @returns {Promise} Promise object
*/
public saveFile(sFileName?: string): Promise;
/**
* Sets the aggregated {@link #getExportType exportType}.
* @param {sap.ui.core.util.ExportType} oExportType - The exportType to set
* @returns {sap.ui.core.util.Export} Reference to this
in order to allow method chaining
*/
public setExportType(oExportType: sap.ui.core.util.ExportType): sap.ui.core.util.Export;
/**
* Unbinds aggregation {@link #getColumns columns} from model data.
* @returns {sap.ui.core.util.Export} Reference to this
in order to allow method chaining
*/
public unbindColumns(): sap.ui.core.util.Export;
/**
* Unbinds aggregation {@link #getRows rows} from model data.
* @returns {sap.ui.core.util.Export} Reference to this
in order to allow method chaining
*/
public unbindRows(): sap.ui.core.util.Export;
}
/**
* Contains content that can be used to export data. Used in {@link sap.ui.core.util.ExportColumn ExportColumn} / {@link sap.ui.core.util.Export Export}.
*/
export class ExportCell extends sap.ui.core.Element {
/**
* Constructor for a new ExportCell.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.util.ExportCell with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getContent content}.
*
* Cell content.
* @returns {string} Value of property content
*/
public getContent(): string;
/**
* Returns a metadata object for class sap.ui.core.util.ExportCell.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets a new value for property {@link #getContent content}.
*
* Cell content.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sContent - New value for property content
* @returns {sap.ui.core.util.ExportCell} Reference to this
in order to allow method chaining
*/
public setContent(sContent: string): sap.ui.core.util.ExportCell;
}
/**
* Can have a name and a cell template.
*/
export class ExportColumn extends sap.ui.base.ManagedObject {
/**
* Constructor for a new ExportCell.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Destroys the template in the aggregation {@link #getTemplate template}.
* @returns {sap.ui.core.util.ExportColumn} Reference to this
in order to allow method chaining
*/
public destroyTemplate(): sap.ui.core.util.ExportColumn;
/**
* Creates a new subclass of class sap.ui.core.util.ExportColumn with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.util.ExportColumn.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* Column name.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets content of aggregation {@link #getTemplate template}.
*
* Cell template for column.
* @returns {sap.ui.core.util.ExportCell}
*/
public getTemplate(): sap.ui.core.util.ExportCell;
/**
* Sets a new value for property {@link #getName name}.
*
* Column name.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.ui.core.util.ExportColumn} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.ui.core.util.ExportColumn;
/**
* Sets the aggregated {@link #getTemplate template}.
* @param {sap.ui.core.util.ExportCell} oTemplate - The template to set
* @returns {sap.ui.core.util.ExportColumn} Reference to this
in order to allow method chaining
*/
public setTemplate(oTemplate: sap.ui.core.util.ExportCell): sap.ui.core.util.ExportColumn;
}
/**
* Internally used in {@link sap.ui.core.util.Export Export}.
*/
export class ExportRow extends sap.ui.base.ManagedObject {
/**
* Constructor for a new ExportRow.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some cell to the aggregation {@link #getCells cells}.
* @param {sap.ui.core.util.ExportCell} oCell - the cell to add; if empty, nothing is inserted
* @returns {sap.ui.core.util.ExportRow} Reference to this
in order to allow method chaining
*/
public addCell(oCell: sap.ui.core.util.ExportCell): sap.ui.core.util.ExportRow;
/**
* Destroys all the cells in the aggregation {@link #getCells cells}.
* @returns {sap.ui.core.util.ExportRow} Reference to this
in order to allow method chaining
*/
public destroyCells(): sap.ui.core.util.ExportRow;
/**
* Creates a new subclass of class sap.ui.core.util.ExportRow with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getCells cells}.
*
* Cells for the Export.
* @returns {sap.ui.core.util.ExportCell[]}
*/
public getCells(): sap.ui.core.util.ExportCell[];
/**
* Returns a metadata object for class sap.ui.core.util.ExportRow.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.util.ExportCell
in the aggregation {@link #getCells cells}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.util.ExportCell} oCell - The cell whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfCell(oCell: sap.ui.core.util.ExportCell): number;
/**
* Inserts a cell into the aggregation {@link #getCells cells}.
* @param {sap.ui.core.util.ExportCell} oCell - the cell to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the cell should be inserted at; for a negative value of iIndex
, the cell is inserted at position 0; for a value greater than the current size of the aggregation, the cell is inserted at the last position
* @returns {sap.ui.core.util.ExportRow} Reference to this
in order to allow method chaining
*/
public insertCell(oCell: sap.ui.core.util.ExportCell, iIndex: number): sap.ui.core.util.ExportRow;
/**
* Removes all the controls from the aggregation {@link #getCells cells}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.util.ExportCell[]} An array of the removed elements (might be empty)
*/
public removeAllCells(): sap.ui.core.util.ExportCell[];
/**
* Removes a cell from the aggregation {@link #getCells cells}.
* @param {number|string|sap.ui.core.util.ExportCell} vCell - The cell to remove or its index or id
* @returns {sap.ui.core.util.ExportCell} The removed cell or null
*/
public removeCell(vCell: number|string|sap.ui.core.util.ExportCell): sap.ui.core.util.ExportCell;
}
/**
* Base export type. Subclasses can be used for {@link sap.ui.core.util.Export Export}.
*/
export class ExportType extends sap.ui.base.ManagedObject {
/**
* Constructor for a new ExportType.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Handles the generation process of the file.
* @param {sap.ui.core.util.Export} oExport - export instance
* @returns {string} content
*/
protected _generate(oExport: sap.ui.core.util.Export): string;
/**
* Creates a cell "generator" (inspired by ES6 Generators)
* @returns {IterableIterator} generator
*/
protected cellGenerator(): IterableIterator;
/**
* Creates a column "generator" (inspired by ES6 Generators)
* @returns {IterableIterator} generator
*/
protected columnGenerator(): IterableIterator;
/**
* Creates a new subclass of class sap.ui.core.util.ExportType with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Generates the file content.
* Should be implemented by the individual types!
* @returns {string} content
*/
protected generate(): string;
/**
* Gets current value of property {@link #getByteOrderMark byteOrderMark}.
*
* Whether to prepend an unicode byte order mark when saving as a file (only applies for utf-8 charset).
*
* Default value is undefined
.
* @returns {boolean} Value of property byteOrderMark
*/
public getByteOrderMark(): boolean;
/**
* Gets current value of property {@link #getCharset charset}.
*
* Charset.
* @returns {string} Value of property charset
*/
public getCharset(): string;
/**
* Returns the number of columns.
* @returns {number} count
*/
protected getColumnCount(): number;
/**
* Gets current value of property {@link #getFileExtension fileExtension}.
*
* File extension.
* @returns {string} Value of property fileExtension
*/
public getFileExtension(): string;
/**
* Returns a metadata object for class sap.ui.core.util.ExportType.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMimeType mimeType}.
*
* MIME type.
* @returns {string} Value of property mimeType
*/
public getMimeType(): string;
/**
* Returns the number of rows.
* @returns {number} count
*/
protected getRowCount(): number;
/**
* Creates a row "generator" (inspired by ES6 Generators)
* @returns {IterableIterator} generator
*/
protected rowGenerator(): IterableIterator;
/**
* Sets a new value for property {@link #getByteOrderMark byteOrderMark}.
*
* Whether to prepend an unicode byte order mark when saving as a file (only applies for utf-8 charset).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is undefined
.
* @param {boolean} bByteOrderMark - New value for property byteOrderMark
* @returns {sap.ui.core.util.ExportType} Reference to this
in order to allow method chaining
*/
public setByteOrderMark(bByteOrderMark: boolean): sap.ui.core.util.ExportType;
/**
* Sets a new value for property {@link #getCharset charset}.
*
* Charset.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sCharset - New value for property charset
* @returns {sap.ui.core.util.ExportType} Reference to this
in order to allow method chaining
*/
public setCharset(sCharset: string): sap.ui.core.util.ExportType;
/**
* Sets a new value for property {@link #getFileExtension fileExtension}.
*
* File extension.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sFileExtension - New value for property fileExtension
* @returns {sap.ui.core.util.ExportType} Reference to this
in order to allow method chaining
*/
public setFileExtension(sFileExtension: string): sap.ui.core.util.ExportType;
/**
* Sets a new value for property {@link #getMimeType mimeType}.
*
* MIME type.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sMimeType - New value for property mimeType
* @returns {sap.ui.core.util.ExportType} Reference to this
in order to allow method chaining
*/
public setMimeType(sMimeType: string): sap.ui.core.util.ExportType;
}
/**
* CSV export type. Can be used for {@link sap.ui.core.util.Export Export}.
*
* Please note that there could be an issue with the separator char depending on the user's system language in some programs such as Microsoft Excel.
* To prevent those issues use the data-import functionality which enables the possibility to explicitly set the separator char that should be used.
* This way the content will be displayed correctly.
*
* Potential formulas (cell data starts with one of = + - @) will be escaped by prepending a single quote.
* As the export functionality is intended to be used with actual (user) data there is no reason to allow formulas.
*/
export class ExportTypeCSV extends sap.ui.core.util.ExportType {
/**
* Constructor for a new ExportTypeCSV.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.core.util.ExportTypeCSV with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.util.ExportType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Generates the file content.
* @returns {string} content
*/
protected generate(): string;
/**
* Returns a metadata object for class sap.ui.core.util.ExportTypeCSV.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSeparatorChar separatorChar}.
*
* Separator char.
*
* Value needs to be exactly one character or empty for default.
*
* Default value is ,
.
* @returns {string} Value of property separatorChar
*/
public getSeparatorChar(): string;
/**
* Setter for property separatorChar
.
*
* Value needs to be exactly one character or empty for default. Default value is ','.
* @param {string} sSeparatorChar - new value for property separatorChar
* @returns {sap.ui.core.util.ExportTypeCSV} this
to allow method chaining
*/
public setSeparatorChar(sSeparatorChar: string): sap.ui.core.util.ExportTypeCSV;
}
/**
* Utility class to handle files
*/
namespace File {
/**
* Triggers a download / save action of the given file.
*
* There are limitations for this feature in some browsers:
*
*
macOS Safari < 10.1 / iOS Safari
* A new window or tab is opened.
* In macOS, the user has to save the file manually (by using key combination "CMD + S", choosing the page source format, and specifying a file name).
* In iOS, the content can be opened in another app (Mail, Notes, ...) or can be copied to the clipboard.
* If a pop-up blocker prevents this action, an error will be thrown which can be used to notify the user that the pop-up blocker needs to be disabled.
*
* Android Browser
* Not supported
*
* Windows Phone 10 Edge
* Not supported
* @param {string} sData - file content
* @param {string} sFileName - file name
* @param {string} sFileExtension - file extension
* @param {string} sMimeType - file mime-type
* @param {string} sCharset - file charset
* @param {boolean} bByteOrderMark - Whether to prepend an unicode byte order mark (only applies for utf-8 charset). Default is false
except when sFileExtension
= csv/code> it is true
(compatibility reasons).
*/
function save(sData: string, sFileName: string, sFileExtension: string, sMimeType: string, sCharset: string, bByteOrderMark?: boolean): void;
}
/**
* Class to mock http requests made to a remote server
*/
export class MockServer extends sap.ui.base.ManagedObject {
/**
* Enum for the method.
*/
public static HTTPMETHOD: any;
/**
* Creates a mocked server. This helps to mock all or some backend calls, e.g. for OData/JSON Models or simple XHR calls, without
* changing the application code. This class can also be used for qunit tests.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new server object; generated automatically if no non-empty id is given Note: this can be omitted, no matter whether mSettings
will be given or not!
* @param {any} mSettings - optional map/JSON-object with initial property values, aggregated objects etc. for the new object
* @param {any} oScope - scope object for resolving string based type and formatter references in bindings
*/
public constructor(sId?: string, mSettings?: any, oScope?: any);
/**
* Attaches an event handler to be called after the built-in request processing of the mock server
* @param {string} event - type according to HTTP Method
* @param {Function} fnCallback - the name of the function that will be called at this exit The callback function exposes an event with parameters, depending on the type of the request. oEvent.getParameters() lists the parameters as per the request. Examples are: oXhr : the request object; oFilteredData : the mock data entries that are about to be returned in the response; oEntry : the mock data entry that is about to be returned in the response;
* @param {string} sEntitySet - (optional) the name of the entity set
*/
public attachAfter(event: string, fnCallback: Function, sEntitySet: string): void;
/**
* Attaches an event handler to be called before the built-in request processing of the mock server
* @param {string} event - type according to HTTP Method
* @param {Function} fnCallback - the name of the function that will be called at this exit. The callback function exposes an event with parameters, depending on the type of the request. oEvent.getParameters() lists the parameters as per the request. Examples are: oXhr : the request object; sUrlParams : the URL parameters of the request; sKeys : key properties of the requested entry; sNavProp/sNavName : name of navigation
* @param {string} sEntitySet - (optional) the name of the entity set
*/
public attachBefore(event: string, fnCallback: Function, sEntitySet: string): void;
/**
* Global configuration of all mock servers.
* @param {any} mConfig - the configuration object.
*/
public static config(mConfig: any): void;
/**
* Cleans up the resources associated with this object and all its aggregated children.
*
* After an object has been destroyed, it can no longer be used in!
*
* Applications should call this method if they don't need the object any longer.
* @param {boolean} bSuppressInvalidate - if true, this ManagedObject is not marked as changed
*/
public destroy(bSuppressInvalidate?: boolean): void;
/**
* Stops and calls destroy on all registered servers. Use this method for cleaning up.
*/
public static destroyAll(): void;
/**
* Removes a previously attached event handler
* @param {string} event - type according to HTTP Method
* @param {Function} fnCallback - the name of the function that will be called at this exit
* @param {string} sEntitySet - (optional) the name of the entity set
*/
public detachAfter(event: string, fnCallback: Function, sEntitySet: string): void;
/**
* Removes a previously attached event handler
* @param {string} event - type according to HTTP Method
* @param {Function} fnCallback - the name of the function that will be called at this exit
* @param {string} sEntitySet - (optional) the name of the entity set
*/
public detachBefore(event: string, fnCallback: Function, sEntitySet: string): void;
/**
* Creates a new subclass of class sap.ui.core.util.MockServer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the data model of the given EntitySet name.
* @param {any} sEntitySetName - EntitySet name
* @returns {any[]} data model of the given EntitySet
*/
public getEntitySetData(sEntitySetName: any): any[];
/**
* Returns a metadata object for class sap.ui.core.util.MockServer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Getter for property requests
.
*
* Default value is []
* @returns {any[]} the value of property rootUri
*/
public getRequests(): any[];
/**
* Getter for property rootUri
.
*
* Default value is empty/undefined
* @returns {string} the value of property rootUri
*/
public getRootUri(): string;
/**
* Returns whether the server is started or not.
* @returns {boolean} whether the server is started or not.
*/
public isStarted(): boolean;
/**
* Respond to a request, when the servers are configured not to automatically respond.
*/
public static respond(): void;
/**
* Sets the data of the given EntitySet name with the given array.
* @param {any} sEntitySetName - EntitySet name
* @param {any} aData
*/
public setEntitySetData(sEntitySetName: any, aData: any): void;
/**
* Setter for property requests
.
*
* Default value is is []
*
* Each array entry should consist of an array with the following properties / values:
*
*
* - method
: "GET"|"POST"|"DELETE|"PUT"
*
* (any HTTP verb)
*
* - path
: "/path/to/resource"
*
* The path is converted to a regular expression, so it can contain normal regular expression syntax.
* All regular expression groups are forwarded as arguments to the response
function.
* In addition to this, parameters can be written in this notation: :param
. These placeholder will be replaced by regular expression groups.
*
* - response
: function(xhr, param1, param2, ...) { }
*
* The xhr object can be used to respond on the request. Supported methods are:
*
* xhr.respond(iStatusCode, mHeaders, sBody)
*
* xhr.respondJSON(iStatusCode, mHeaders, oJsonObjectOrString)
. By default a JSON header is set for response header
*
* xhr.respondXML(iStatusCode, mHeaders, sXmlString)
. By default an XML header is set for response header
*
* xhr.respondFile(iStatusCode, mHeaders, sFileUrl)
. By default the mime type of the file is set for response header
*
*
* @param {any[]} requests - new value for property requests
*/
public setRequests(requests: any[]): void;
/**
* Setter for property rootUri
. All request path URI are prefixed with this root URI if set.
*
* Default value is empty/undefined
* @param {string} rootUri - new value for property rootUri
*/
public setRootUri(rootUri: string): void;
/**
* Simulates an existing OData service by sepcifiying the metadata URL and the base URL for the mockdata. The server
* configures the request handlers depending on the service metadata. The mockdata needs to be stored individually for
* each entity type in a separate JSON file. The name of the JSON file needs to match the name of the entity type. If
* no base url for the mockdata is specified then the mockdata are generated from the metadata
* @param {string} sMetadataUrl - url to the service metadata document
* @param {string|any} vMockdataSettings - (optional) base url which contains the path to the mockdata, or an object which contains the following properties: sMockdataBaseUrl, bGenerateMissingMockData, aEntitySetsNames. See below for descriptions of these parameters. Ommit this parameter to produce random mock data based on the service metadata.
*/
public simulate(sMetadataUrl: string, vMockdataSettings?: string|any): void;
/**
* Starts the server.
*/
public start(): void;
/**
* Starts all registered servers.
*/
public static startAll(): void;
/**
* Stops the server.
*/
public stop(): void;
/**
* Stops all registered servers.
*/
public static stopAll(): void;
}
/**
*/
namespace serializer {
/**
*/
namespace delegate {
/**
* Abstract serializer delegate class.
*/
export class Delegate extends sap.ui.base.EventProvider {
/**
* Abstract serializer delegate class. All delegates must extend from this class and implement the abstract methods.
*/
public constructor();
/**
* Creates a new subclass of class sap.ui.core.util.serializer.delegate.Delegate with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.util.serializer.delegate.Delegate.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* HTML serializer delegate class.
*/
export class HTML extends sap.ui.core.util.serializer.delegate.Delegate {
/**
* HTML serializer delegate class. Called by the serializer instance.
* @param {Function} fnGetControlId - delegate function which returns the control id
* @param {Function} fnGetEventHandlerName - delegate function which returns the event handler name
*/
public constructor(fnGetControlId?: Function, fnGetEventHandlerName?: Function);
/**
* Creates a new subclass of class sap.ui.core.util.serializer.delegate.HTML with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.util.serializer.delegate.Delegate.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.util.serializer.delegate.HTML.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* XML serializer delegate class.
*/
export class XML extends sap.ui.core.util.serializer.delegate.Delegate {
/**
* XML serializer delegate class. Called by the serializer instance.
* @param {string} sDefaultXmlNamespace - defines the default XML namespace
* @param {Function} fnGetControlId - delegate function which returns the control id
* @param {Function} fnGetEventHandlerName - delegate function which returns the event handler name
* @param {Function} fnMemorizePackage - a delegate function to memorize the control packages
*/
public constructor(sDefaultXmlNamespace?: string, fnGetControlId?: Function, fnGetEventHandlerName?: Function, fnMemorizePackage?: Function);
/**
* Creates a new subclass of class sap.ui.core.util.serializer.delegate.XML with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.util.serializer.delegate.Delegate.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.util.serializer.delegate.XML.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
}
/**
* HTMLViewSerializer class.
*/
export class HTMLViewSerializer extends sap.ui.base.EventProvider {
/**
* HTML view serializer class. Serializes a given view.
* @param {sap.ui.core.mvc.HTMLView} oView - the view to serialize
* @param {Function} fnGetControlId - delegate function which returns the control id
* @param {Function} fnGetEventHandlerName - delegate function which returns the event handler name
*/
public constructor(oView: sap.ui.core.mvc.HTMLView, fnGetControlId: Function, fnGetEventHandlerName: Function);
/**
* HTML view serializer class. Serializes a given view.
* @param {sap.ui.core.mvc.HTMLView} oView - the view to serialize
* @param {any} oWindow - the window object. Default is the window object the instance of the serializer is running in
* @param {Function} fnGetControlId - delegate function which returns the control id
* @param {Function} fnGetEventHandlerName - delegate function which returns the event handler name
*/
public constructor(oView: sap.ui.core.mvc.HTMLView, oWindow: any, fnGetControlId: Function, fnGetEventHandlerName: Function);
/**
* Creates a new subclass of class sap.ui.core.util.serializer.HTMLViewSerializer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.util.serializer.HTMLViewSerializer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Serializer class.
*/
export class Serializer extends sap.ui.base.EventProvider {
/**
* Serializer class. Iterates over all controls and call a given serializer delegate.
* @param {sap.ui.core.Control|sap.ui.core.UIArea} oRootControl - the root control to serialize
* @param {any} serializeDelegate - the serializer delegate. Has to implement start/middle/end methods.
* @param {boolean} bSkipRoot - whether to skip the root node or not
* @param {Function} fnSkipAggregations - whether to skip aggregations
* @param {Function} fnSkipElement - whether to skip an element
*/
public constructor(oRootControl: sap.ui.core.Control|sap.ui.core.UIArea, serializeDelegate: any, bSkipRoot: boolean, fnSkipAggregations: Function, fnSkipElement: Function);
/**
* Creates a new subclass of class sap.ui.core.util.serializer.Serializer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.util.serializer.Serializer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* ViewSerializer class.
*/
export class ViewSerializer extends sap.ui.base.EventProvider {
/**
* View serializer class. Iterates over all controls and serializes all found views by calling the corresponding view type serializer.
* @param {sap.ui.core.Control|sap.ui.core.UIArea} oRootControl - the root control to serialize
* @param {any} oWindow - the window object. Default is the window object the instance of the serializer is running in.
* @param {string} sDefaultXmlNamespace - defines the default xml namespace
*/
public constructor(oRootControl: sap.ui.core.Control|sap.ui.core.UIArea, oWindow?: any, sDefaultXmlNamespace?: string);
/**
* Creates a new subclass of class sap.ui.core.util.serializer.ViewSerializer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.util.serializer.ViewSerializer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* XMLViewSerializer class.
*/
export class XMLViewSerializer extends sap.ui.base.EventProvider {
/**
* XML view serializer class. Serializes a given view.
* @param {sap.ui.core.mvc.XMLView} oView - the view to serialize
* @param {Function} fnGetControlId - delegate function which returns the control id
* @param {Function} fnGetEventHandlerName - delegate function which returns the event handler name
*/
public constructor(oView: sap.ui.core.mvc.XMLView, fnGetControlId: Function, fnGetEventHandlerName: Function);
/**
* XML view serializer class. Serializes a given view.
* @param {sap.ui.core.mvc.XMLView} oView - the view to serialize
* @param {string} sDefaultXmlNamespace - defines the default XML namespace
* @param {Function} fnGetControlId - delegate function which returns the control id
* @param {Function} fnGetEventHandlerName - delegate function which returns the event handler name
*/
public constructor(oView: sap.ui.core.mvc.XMLView, sDefaultXmlNamespace: string, fnGetControlId: Function, fnGetEventHandlerName: Function);
/**
* XML view serializer class. Serializes a given view.
* @param {sap.ui.core.mvc.XMLView} oView - the view to serialize
* @param {any} oWindow - the window object. Default is the window object the instance of the serializer is running in
* @param {Function} fnGetControlId - delegate function which returns the control id
* @param {Function} fnGetEventHandlerName - delegate function which returns the event handler name
*/
public constructor(oView: sap.ui.core.mvc.XMLView, oWindow: any, fnGetControlId: Function, fnGetEventHandlerName: Function);
/**
* XML view serializer class. Serializes a given view.
* @param {sap.ui.core.mvc.XMLView} oView - the view to serialize
* @param {any} oWindow - the window object. Default is the window object the instance of the serializer is running in
* @param {string} sDefaultXmlNamespace - defines the default XML namespace
* @param {Function} fnGetControlId - delegate function which returns the control id
* @param {Function} fnGetEventHandlerName - delegate function which returns the event handler name
*/
public constructor(oView: sap.ui.core.mvc.XMLView, oWindow: any, sDefaultXmlNamespace: string, fnGetControlId: Function, fnGetEventHandlerName: Function);
/**
* Creates a new subclass of class sap.ui.core.util.serializer.XMLViewSerializer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.util.serializer.XMLViewSerializer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
}
/**
* The XML pre-processor for template instructions in XML views.
*/
namespace XMLPreprocessor {
/**
* Context interface provided by XML template processing as an additional first
* argument to any formatter function which opts in to this mechanism. Candidates for
* such formatter functions are all those used in binding expressions which are
* evaluated during XML template processing, including those used inside template
* instructions like <template:if>
. The formatter function needs to be
* marked with a property requiresIContext = true
to express that it
* requires this extended signature (compared to ordinary formatter functions). The
* usual arguments are provided after the first one (currently: the raw value from the
* model).
*
* This interface provides callback functions to access the model and path which are
* needed to process OData V4 annotations. It initially offers a subset of methods
* from {@link sap.ui.model.Context} so that formatters might also be called with a
* context object for convenience, e.g. outside of XML template processing (see below
* for an exception to this rule).
*
* Example: Suppose you have a formatter function called "foo" like below
* and it is used within an XML template like
* <template:if test="{path: '...', formatter: 'foo'}">
.
* In this case foo
is called with arguments
* oInterface, vRawValue
such that
* oInterface.getModel().getObject(oInterface.getPath()) === vRawValue
* holds.
*
* window.foo = function (oInterface, vRawValue) {
* //TODO ...
* };
* window.foo.requiresIContext = true;
*
*
* Composite Binding Examples: Suppose you have the same formatter function and
* it is used in a composite binding like <Text text="{path: 'Label',
* formatter: 'foo'}: {path: 'Value', formatter: 'foo'}"/>
.
* In this case oInterface.getPath()
refers to ".../Label" in the 1st call
* and ".../Value" in the 2nd call. This means each formatter call knows which part of
* the composite binding it belongs to and behaves just as if it was an ordinary
* binding.
*
* Suppose your formatter is not used within a part of the composite binding, but at
* the root of the composite binding in order to aggregate all parts like
* <Text text="{parts: [{path: 'Label'}, {path: 'Value'}], formatter: 'foo'}"/>
*
. In this case oInterface.getPath(0)
refers to ".../Label" and
* oInterface.getPath(1)
refers to ".../Value". This means, the root
* formatter can access the ith part of the composite binding at will (since 1.31.0);
* see also {@link #.getInterface getInterface}.
* The function foo
is called with arguments such that
* oInterface.getModel(i).getObject(oInterface.getPath(i)) === arguments[i + 1]
* holds.
* This use is not supported within an expression binding, that is, <Text
* text="{= ${parts: [{path: 'Label'}, {path: 'Value'}], formatter: 'foo'} }"/>
* does not work as expected because the property requiresIContext = true
* is ignored.
*
* To distinguish those two use cases, just check whether
* oInterface.getModel() === undefined
, in which case the formatter is
* called on root level of a composite binding. To find out the number of parts, probe
* for the smallest non-negative integer where
* oInterface.getModel(i) === undefined
.
* This additional functionality is, of course, not available from
* {@link sap.ui.model.Context}, i.e. such formatters MUST be called with an instance
* of this context interface.
*/
export interface IContext {
/**
* Returns a context interface for the indicated part in case of the root formatter
* of a composite binding. The new interface provides access to the original
* settings, but only to the model and path of the indicated part:
*
* this.getInterface(i).getSetting(sName) === this.getSetting(sName);
* this.getInterface(i).getModel() === this.getModel(i);
* this.getInterface(i).getPath() === this.getPath(i);
*
*
* If a path is given, the new interface points to the resolved path as follows:
*
* this.getInterface(i, "foo/bar").getPath() === this.getPath(i) + "/foo/bar";
* this.getInterface(i, "/absolute/path").getPath() === "/absolute/path";
*
* A formatter which is not at the root level of a composite binding can also
* provide a path, but must not provide an index:
*
* this.getInterface("foo/bar").getPath() === this.getPath() + "/foo/bar";
* this.getInterface("/absolute/path").getPath() === "/absolute/path";
*
* Note that at least one argument must be present.
* @param {number} iPart - index of part in case of the root formatter of a composite binding
* @param {string} sPath - a path, interpreted relative to this.getPath(iPart)
* @returns {sap.ui.core.util.XMLPreprocessor.IContext} the context interface related to the indicated part
*/
getInterface(iPart?: number, sPath?: string): sap.ui.core.util.XMLPreprocessor.IContext;
/**
* Returns the model related to the current formatter call.
* @param {number} iPart - index of part in case of the root formatter of a composite binding (since 1.31.0)
* @returns {sap.ui.model.Model} the model related to the current formatter call, or (since 1.31.0) undefined
in case of a root formatter if no iPart
is given or if iPart
is out of range
*/
getModel(iPart?: number): sap.ui.model.Model;
/**
* Returns the absolute path related to the current formatter call.
* @param {number} iPart - index of part in case of the root formatter of a composite binding (since 1.31.0)
* @returns {string} the absolute path related to the current formatter call, or (since 1.31.0) undefined
in case of a root formatter if no iPart
is given or if iPart
is out of range
*/
getPath(iPart?: number): string;
/**
* Returns the value of the setting with the given name which was provided to the
* XML template processing.
* @param {string} sName - the name of the setting
* @returns {any} the value of the setting
*/
getSetting(sName: string): any;
}
}
}
/**
* Marker for the correctness of the current value.
*/
export enum ValueState {
/**
* State is not valid.
*/
Error = "Error",
/**
* State is not specified.
*/
None = "None",
/**
* State is valid.
*/
Success = "Success",
/**
* State is valid but with a warning.
*/
Warning = "Warning",
}
/**
* Helper functionality for value state support.
*/
namespace ValueStateSupport {
/**
* Appends a generic success, warning or error message to the given tooltip text if the given Element
* has a property "valueState" with one of these three states.
* @param {sap.ui.core.Element} oElement - the Element of which the tooltip needs to be modified
* @param {string} sTooltipText - the original tooltip text (may be null)
* @returns {string} the given text, with appended success/warning/error text, if appropriate
*/
function enrichTooltip(oElement: sap.ui.core.Element, sTooltipText: string): string;
/**
* Returns a ValueState object based on the given integer value
*
* 0 : ValueState.None
* 1 : ValueState.Warning
* 2 : ValueState.Success
* 3 : ValueState.Error
* @param {number} iState - the state as an integer
* @returns {sap.ui.core.ValueState} the corresponding ValueState object
*/
function formatValueState(iState: number): sap.ui.core.ValueState;
/**
* Returns a generic success, warning or error message if the given Element
* has a property "valueState" with one of these three states or the given ValueState
* represents one of these states.
* @param {sap.ui.core.Element|sap.ui.core.ValueState} vValue - the Element of which the valueState needs to be checked, or the ValueState explicitly
* @returns {string} the success/warning/error text, if appropriate; otherwise null
*/
function getAdditionalText(vValue: sap.ui.core.Element|sap.ui.core.ValueState): string;
}
/**
* Allows to add multiple LayoutData to one control in case that an easy switch of layouts (e.g. in a Form) is needed.
*/
export class VariantLayoutData extends sap.ui.core.LayoutData {
/**
* Constructor for a new VariantLayoutData.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some multipleLayoutData to the aggregation {@link #getMultipleLayoutData multipleLayoutData}.
* @param {sap.ui.core.LayoutData} oMultipleLayoutData - the multipleLayoutData to add; if empty, nothing is inserted
* @returns {sap.ui.core.VariantLayoutData} Reference to this
in order to allow method chaining
*/
public addMultipleLayoutData(oMultipleLayoutData: sap.ui.core.LayoutData): sap.ui.core.VariantLayoutData;
/**
* Destroys all the multipleLayoutData in the aggregation {@link #getMultipleLayoutData multipleLayoutData}.
* @returns {sap.ui.core.VariantLayoutData} Reference to this
in order to allow method chaining
*/
public destroyMultipleLayoutData(): sap.ui.core.VariantLayoutData;
/**
* Creates a new subclass of class sap.ui.core.VariantLayoutData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.LayoutData.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.core.VariantLayoutData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getMultipleLayoutData multipleLayoutData}.
*
* Allows multiple LayoutData.
* @returns {sap.ui.core.LayoutData[]}
*/
public getMultipleLayoutData(): sap.ui.core.LayoutData[];
/**
* Checks for the provided sap.ui.core.LayoutData
in the aggregation {@link #getMultipleLayoutData multipleLayoutData}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.LayoutData} oMultipleLayoutData - The multipleLayoutData whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfMultipleLayoutData(oMultipleLayoutData: sap.ui.core.LayoutData): number;
/**
* Inserts a multipleLayoutData into the aggregation {@link #getMultipleLayoutData multipleLayoutData}.
* @param {sap.ui.core.LayoutData} oMultipleLayoutData - the multipleLayoutData to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the multipleLayoutData should be inserted at; for a negative value of iIndex
, the multipleLayoutData is inserted at position 0; for a value greater than the current size of the aggregation, the multipleLayoutData is inserted at the last position
* @returns {sap.ui.core.VariantLayoutData} Reference to this
in order to allow method chaining
*/
public insertMultipleLayoutData(oMultipleLayoutData: sap.ui.core.LayoutData, iIndex: number): sap.ui.core.VariantLayoutData;
/**
* Removes all the controls from the aggregation {@link #getMultipleLayoutData multipleLayoutData}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.LayoutData[]} An array of the removed elements (might be empty)
*/
public removeAllMultipleLayoutData(): sap.ui.core.LayoutData[];
/**
* Removes a multipleLayoutData from the aggregation {@link #getMultipleLayoutData multipleLayoutData}.
* @param {number|string|sap.ui.core.LayoutData} vMultipleLayoutData - The multipleLayoutData to remove or its index or id
* @returns {sap.ui.core.LayoutData} The removed multipleLayoutData or null
*/
public removeMultipleLayoutData(vMultipleLayoutData: number|string|sap.ui.core.LayoutData): sap.ui.core.LayoutData;
}
/**
* Configuration options for vertical alignments, for example of a layout cell content within the borders.
*/
export enum VerticalAlign {
/**
* Content is aligned at the bottom.
*/
Bottom = "Bottom",
/**
* Content respect the parent's vertical alignment.
*/
Inherit = "Inherit",
/**
* Content is centered vertically .
*/
Middle = "Middle",
/**
* Content is aligned at the top.
*/
Top = "Top",
}
/**
* Configuration options for text wrapping.
*/
export enum Wrapping {
/**
* Inserts actual line breaks in the text at the wrap point.
*/
Hard = "Hard",
/**
* The standard browser behavior is considered for wrapping.
*/
None = "None",
/**
* Wrapping shall not be allowed.
*/
Off = "Off",
/**
* The text is actually on the same line but displayed within several lines.
*/
Soft = "Soft",
}
/**
*/
namespace ws {
/**
* Defines the different ready states for a WebSocket connection.
*/
export enum ReadyState {
/**
* The connection has been closed or could not be opened.
*/
CLOSED = "CLOSED",
/**
* The connection is going through the closing handshake.
*/
CLOSING = "CLOSING",
/**
* The connection has not yet been established.
*/
CONNECTING = "CONNECTING",
/**
* The WebSocket connection is established and communication is possible.
*/
OPEN = "OPEN",
}
/**
* WebSocket class implementing the pcp-protocol
*/
export class SapPcpWebSocket extends sap.ui.core.ws.WebSocket {
/**
* Creates a new WebSocket connection and uses the pcp-protocol for communication.
* @param {string} sUrl - relative or absolute URL for WebSocket connection.
* @param {any[]} aProtocols - array of protocols as strings, a single protocol as a string. Protocol(s) should be selected from {@link sap.ui.core.ws.SapPcpWebSocket.SUPPORTED_PROTOCOLS}.
*/
public constructor(sUrl: string, aProtocols?: any[]);
/**
* Creates a new subclass of class sap.ui.core.ws.SapPcpWebSocket with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.ws.WebSocket.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event 'message' to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.ws.SapPcpWebSocket} this
to allow method chaining
*/
protected fireMessage(mArguments?: any): sap.ui.core.ws.SapPcpWebSocket;
/**
* Returns a metadata object for class sap.ui.core.ws.SapPcpWebSocket.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sends a message and optional pcp-header-fields using the pcp-protocol.
*
* If the connection is not yet opened, the message will be queued and sent
* when the connection is established.
* @param {string|Blob|ArrayBuffer} message - message to send
* @param {any} oPcpFields - additional pcp-fields as key-value map
* @returns {sap.ui.core.ws.SapPcpWebSocket} this
to allow method chaining
*/
public send(message: string|Blob|ArrayBuffer, oPcpFields?: any): sap.ui.core.ws.SapPcpWebSocket;
}
namespace SapPcpWebSocket {
/**
* Protocol versions.
* One (or more) of these have to be selected to create an SapPcpWebSocket connection
* (or no protocol at all).
*/
namespace SUPPORTED_PROTOCOLS {
/**
* Protocol v10.pcp.sap.com
*/
var v10: any;
}
}
/**
* Basic WebSocket class
*/
export class WebSocket extends sap.ui.base.EventProvider {
/**
* Creates a new WebSocket connection.
* @param {string} sUrl - relative or absolute URL for WebSocket connection.
* @param {any[]} aProtocols - array of protocols as strings, a single protocol as a string
*/
public constructor(sUrl: string, aProtocols?: any[]);
/**
* Attach event-handler fnFunction
to the 'close' event of this sap.ui.core.ws.WebSocket
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this WebSocket is used.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
public attachClose(fnFunction: Function, oListener?: any): sap.ui.core.ws.WebSocket;
/**
* Attach event-handler fnFunction
to the 'close' event of this sap.ui.core.ws.WebSocket
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this WebSocket is used.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
public attachClose(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.ws.WebSocket;
/**
* Attach event-handler fnFunction
to the 'error' event of this sap.ui.core.ws.WebSocket
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this WebSocket is used.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
public attachError(fnFunction: Function, oListener?: any): sap.ui.core.ws.WebSocket;
/**
* Attach event-handler fnFunction
to the 'error' event of this sap.ui.core.ws.WebSocket
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this WebSocket is used.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
public attachError(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.ws.WebSocket;
/**
* Attach event-handler fnFunction
to the 'message' event of this sap.ui.core.ws.WebSocket
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this WebSocket is used.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
public attachMessage(fnFunction: Function, oListener?: any): sap.ui.core.ws.WebSocket;
/**
* Attach event-handler fnFunction
to the 'message' event of this sap.ui.core.ws.WebSocket
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this WebSocket is used.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
public attachMessage(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.ws.WebSocket;
/**
* Attach event-handler fnFunction
to the 'open' event of this sap.ui.core.ws.WebSocket
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this WebSocket is used.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
public attachOpen(fnFunction: Function, oListener?: any): sap.ui.core.ws.WebSocket;
/**
* Attach event-handler fnFunction
to the 'open' event of this sap.ui.core.ws.WebSocket
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this WebSocket is used.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
public attachOpen(oData: any, fnFunction: Function, oListener?: any): sap.ui.core.ws.WebSocket;
/**
* Closes the connection.
* @param {number} iCode - Status code that explains why the connection is closed. Must be either 1000, or between 3000 and 4999 (default 1000)
* @param {string} sReason - Closing reason as a string
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
public close(iCode?: number, sReason?: string): sap.ui.core.ws.WebSocket;
/**
* Detach event-handler fnFunction
from the 'close' event of this sap.ui.core.ws.WebSocket
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
public detachClose(fnFunction: Function, oListener: any): sap.ui.core.ws.WebSocket;
/**
* Detach event-handler fnFunction
from the 'error' event of this sap.ui.core.ws.WebSocket
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
public detachError(fnFunction: Function, oListener: any): sap.ui.core.ws.WebSocket;
/**
* Detach event-handler fnFunction
from the 'message' event of this sap.ui.core.ws.WebSocket
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
public detachMessage(fnFunction: Function, oListener: any): sap.ui.core.ws.WebSocket;
/**
* Detach event-handler fnFunction
from the 'open' event of this sap.ui.core.ws.WebSocket
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
public detachOpen(fnFunction: Function, oListener: any): sap.ui.core.ws.WebSocket;
/**
* Creates a new subclass of class sap.ui.core.ws.WebSocket with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event 'close' to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
protected fireClose(mArguments?: any): sap.ui.core.ws.WebSocket;
/**
* Fire event 'error' to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
protected fireError(mArguments?: any): sap.ui.core.ws.WebSocket;
/**
* Fire event 'message' to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
protected fireMessage(mArguments?: any): sap.ui.core.ws.WebSocket;
/**
* Fire event 'open' to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
protected fireOpen(mArguments?: any): sap.ui.core.ws.WebSocket;
/**
* @returns {sap.ui.base.Interface}
*/
public getInterface(): sap.ui.base.Interface;
/**
* Returns a metadata object for class sap.ui.core.ws.WebSocket.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Getter for the protocol selected by the server once the connection is open.
* @returns {string} protocol
*/
public getProtocol(): string;
/**
* Getter for WebSocket readyState.
* @returns {sap.ui.core.ws.ReadyState} readyState
*/
public getReadyState(): sap.ui.core.ws.ReadyState;
/**
* Sends a message.
*
* If the connection is not yet opened, the message will be queued and sent
* when the connection is established.
* @param {string} sMessage - Message to send
* @returns {sap.ui.core.ws.WebSocket} this
to allow method chaining
*/
public send(sMessage: string): sap.ui.core.ws.WebSocket;
}
}
}
/**
* SAPUI5 library with non-public controls, used in the UI5 demokit (SDK)
*/
namespace demokit {
/**
* A container for both the source and the runtime results of a CodeSample. By default, only the runtime results are shown. There are additional controls that allow the user to display the source, modify and run it.
*
* The container provides a sub container that can be used in calls to sap.ui.setRoot() as if it would be a normal UIArea. So the sample code doesn't have to know that it runs in a CodeSample container.
*/
export class CodeSampleContainer extends sap.ui.core.Control {
/**
* Constructor for a new CodeSampleContainer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:apply apply} event of this sap.ui.demokit.CodeSampleContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.demokit.CodeSampleContainer
itself.
*
* Fired when the user decides to apply his/her changes to the sample code
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.demokit.CodeSampleContainer
itself
* @returns {sap.ui.demokit.CodeSampleContainer} Reference to this
in order to allow method chaining
*/
public attachApply(fnFunction: Function, oListener?: any): sap.ui.demokit.CodeSampleContainer;
/**
* Attaches event handler fnFunction
to the {@link #event:apply apply} event of this sap.ui.demokit.CodeSampleContainer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.demokit.CodeSampleContainer
itself.
*
* Fired when the user decides to apply his/her changes to the sample code
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.demokit.CodeSampleContainer
itself
* @returns {sap.ui.demokit.CodeSampleContainer} Reference to this
in order to allow method chaining
*/
public attachApply(oData: any, fnFunction: Function, oListener?: any): sap.ui.demokit.CodeSampleContainer;
/**
* Detaches event handler fnFunction
from the {@link #event:apply apply} event of this sap.ui.demokit.CodeSampleContainer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.demokit.CodeSampleContainer} Reference to this
in order to allow method chaining
*/
public detachApply(fnFunction: Function, oListener: any): sap.ui.demokit.CodeSampleContainer;
/**
* Creates a new subclass of class sap.ui.demokit.CodeSampleContainer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:apply apply} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.demokit.CodeSampleContainer} Reference to this
in order to allow method chaining
*/
protected fireApply(mParameters?: any): sap.ui.demokit.CodeSampleContainer;
/**
* Returns a metadata object for class sap.ui.demokit.CodeSampleContainer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getScriptElementId scriptElementId}.
*
* Id of the script element that contains the initial sample code for this code sample.
* @returns {string} Value of property scriptElementId
*/
public getScriptElementId(): string;
/**
* Gets current value of property {@link #getSourceVisible sourceVisible}.
*
* Whether the source code is visible or not.
*
* Default value is false
.
* @returns {boolean} Value of property sourceVisible
*/
public getSourceVisible(): boolean;
/**
* Gets current value of property {@link #getTitle title}.
*
* A title to be displayed above the code.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getUiAreaId uiAreaId}.
*
* Id of the container for the running code. This Id can be used in calls to sap.ui.setRoot as if it would be a normal UIArea. Internally, a container UIElement is created with that Id.
* @returns {string} Value of property uiAreaId
*/
public getUiAreaId(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the CodeSample container.
*
* Default value is 90%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getScriptElementId scriptElementId}.
*
* Id of the script element that contains the initial sample code for this code sample.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sScriptElementId - New value for property scriptElementId
* @returns {sap.ui.demokit.CodeSampleContainer} Reference to this
in order to allow method chaining
*/
public setScriptElementId(sScriptElementId: string): sap.ui.demokit.CodeSampleContainer;
/**
* Sets a new value for property {@link #getSourceVisible sourceVisible}.
*
* Whether the source code is visible or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSourceVisible - New value for property sourceVisible
* @returns {sap.ui.demokit.CodeSampleContainer} Reference to this
in order to allow method chaining
*/
public setSourceVisible(bSourceVisible: boolean): sap.ui.demokit.CodeSampleContainer;
/**
* Sets a new value for property {@link #getTitle title}.
*
* A title to be displayed above the code.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.demokit.CodeSampleContainer} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.demokit.CodeSampleContainer;
/**
* Sets a new value for property {@link #getUiAreaId uiAreaId}.
*
* Id of the container for the running code. This Id can be used in calls to sap.ui.setRoot as if it would be a normal UIArea. Internally, a container UIElement is created with that Id.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sUiAreaId - New value for property uiAreaId
* @returns {sap.ui.demokit.CodeSampleContainer} Reference to this
in order to allow method chaining
*/
public setUiAreaId(sUiAreaId: string): sap.ui.demokit.CodeSampleContainer;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of the CodeSample container.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 90%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.demokit.CodeSampleContainer} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.demokit.CodeSampleContainer;
}
/**
* Shows a piece of (Javascript) code and allows to edit it
*/
export class CodeViewer extends sap.ui.core.Control {
/**
* Constructor for a new CodeViewer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.demokit.CodeViewer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.demokit.CodeViewer
itself.
*
* Called when the mouse button is clicked over the non-editable(!) control
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.demokit.CodeViewer
itself
* @returns {sap.ui.demokit.CodeViewer} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.ui.demokit.CodeViewer;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.demokit.CodeViewer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.demokit.CodeViewer
itself.
*
* Called when the mouse button is clicked over the non-editable(!) control
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.demokit.CodeViewer
itself
* @returns {sap.ui.demokit.CodeViewer} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.ui.demokit.CodeViewer;
/**
* Attaches event handler fnFunction
to the {@link #event:save save} event of this sap.ui.demokit.CodeViewer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.demokit.CodeViewer
itself.
*
* Called when the editor is active and should be saved
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.demokit.CodeViewer
itself
* @returns {sap.ui.demokit.CodeViewer} Reference to this
in order to allow method chaining
*/
public attachSave(fnFunction: Function, oListener?: any): sap.ui.demokit.CodeViewer;
/**
* Attaches event handler fnFunction
to the {@link #event:save save} event of this sap.ui.demokit.CodeViewer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.demokit.CodeViewer
itself.
*
* Called when the editor is active and should be saved
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.demokit.CodeViewer
itself
* @returns {sap.ui.demokit.CodeViewer} Reference to this
in order to allow method chaining
*/
public attachSave(oData: any, fnFunction: Function, oListener?: any): sap.ui.demokit.CodeViewer;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.ui.demokit.CodeViewer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.demokit.CodeViewer} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.ui.demokit.CodeViewer;
/**
* Detaches event handler fnFunction
from the {@link #event:save save} event of this sap.ui.demokit.CodeViewer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.demokit.CodeViewer} Reference to this
in order to allow method chaining
*/
public detachSave(fnFunction: Function, oListener: any): sap.ui.demokit.CodeViewer;
/**
* Creates a new subclass of class sap.ui.demokit.CodeViewer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.demokit.CodeViewer} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.ui.demokit.CodeViewer;
/**
* Fires event {@link #event:save save} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.demokit.CodeViewer} Reference to this
in order to allow method chaining
*/
protected fireSave(mParameters?: any): sap.ui.demokit.CodeViewer;
/**
* Gets current value of property {@link #getEditable editable}.
*
* Whether the code can be edited or not
*
* Default value is false
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* The CSS height property
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getLineNumbering lineNumbering}.
*
* Whether the code to have line numbering or not
*
* Default value is false
.
* @returns {boolean} Value of property lineNumbering
*/
public getLineNumbering(): boolean;
/**
* Returns a metadata object for class sap.ui.demokit.CodeViewer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSource source}.
*
* The source code to display.
* @returns {string} Value of property source
*/
public getSource(): string;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Whether the code viewer should be visible
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* The CSS width property
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Whether the code can be edited or not
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.ui.demokit.CodeViewer} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.ui.demokit.CodeViewer;
/**
* Sets a new value for property {@link #getHeight height}.
*
* The CSS height property
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.demokit.CodeViewer} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.demokit.CodeViewer;
/**
* Sets a new value for property {@link #getLineNumbering lineNumbering}.
*
* Whether the code to have line numbering or not
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bLineNumbering - New value for property lineNumbering
* @returns {sap.ui.demokit.CodeViewer} Reference to this
in order to allow method chaining
*/
public setLineNumbering(bLineNumbering: boolean): sap.ui.demokit.CodeViewer;
/**
* Sets a new value for property {@link #getSource source}.
*
* The source code to display.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sSource - New value for property source
* @returns {sap.ui.demokit.CodeViewer} Reference to this
in order to allow method chaining
*/
public setSource(sSource: string): sap.ui.demokit.CodeViewer;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Whether the code viewer should be visible
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.ui.demokit.CodeViewer} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.demokit.CodeViewer;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The CSS width property
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.demokit.CodeViewer} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.demokit.CodeViewer;
}
/**
* Control that allows to monitor uploaded files in a demo scenario. This is not a general purpose monitor but only works with the demo fileupload service.
*/
export class FileUploadIntrospector extends sap.ui.core.Control {
/**
* Constructor for a new FileUploadIntrospector.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.demokit.FileUploadIntrospector with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAutoRefreshInterval autoRefreshInterval}.
*
* Interval in milliseconds after which the content is checked again. values lower or equal to 0 mean 'no automatic refresh'.
*
* Default value is 0
.
* @returns {string} Value of property autoRefreshInterval
*/
public getAutoRefreshInterval(): string;
/**
* Gets current value of property {@link #getHeight height}.
*
* (CSS) Height of the control
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.demokit.FileUploadIntrospector.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getUploadUrl uploadUrl}.
*
* The URL to check the upload content with....
* @returns {string} Value of property uploadUrl
*/
public getUploadUrl(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the file list
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Trigger an explicit refresh of the displayed information
*/
public refresh(): void;
/**
* Sets a new value for property {@link #getAutoRefreshInterval autoRefreshInterval}.
*
* Interval in milliseconds after which the content is checked again. values lower or equal to 0 mean 'no automatic refresh'.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {string} sAutoRefreshInterval - New value for property autoRefreshInterval
* @returns {sap.ui.demokit.FileUploadIntrospector} Reference to this
in order to allow method chaining
*/
public setAutoRefreshInterval(sAutoRefreshInterval: string): sap.ui.demokit.FileUploadIntrospector;
/**
* Sets a new value for property {@link #getHeight height}.
*
* (CSS) Height of the control
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.demokit.FileUploadIntrospector} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.demokit.FileUploadIntrospector;
/**
* Sets a new value for property {@link #getUploadUrl uploadUrl}.
*
* The URL to check the upload content with....
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sUploadUrl - New value for property uploadUrl
* @returns {sap.ui.demokit.FileUploadIntrospector} Reference to this
in order to allow method chaining
*/
public setUploadUrl(sUploadUrl: string): sap.ui.demokit.FileUploadIntrospector;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of the file list
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.demokit.FileUploadIntrospector} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.demokit.FileUploadIntrospector;
}
/**
* A custom button with a 'hexagon' shape
*/
export class HexagonButton extends sap.ui.core.Control {
/**
* Constructor for a new HexagonButton.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.demokit.HexagonButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.demokit.HexagonButton
itself.
*
* Fired when the user clicks the hex button
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.demokit.HexagonButton
itself
* @returns {sap.ui.demokit.HexagonButton} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.ui.demokit.HexagonButton;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.demokit.HexagonButton
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.demokit.HexagonButton
itself.
*
* Fired when the user clicks the hex button
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.demokit.HexagonButton
itself
* @returns {sap.ui.demokit.HexagonButton} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.ui.demokit.HexagonButton;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.ui.demokit.HexagonButton
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.demokit.HexagonButton} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.ui.demokit.HexagonButton;
/**
* Creates a new subclass of class sap.ui.demokit.HexagonButton with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.demokit.HexagonButton} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.ui.demokit.HexagonButton;
/**
* Gets current value of property {@link #getColor color}.
*
* The color of the hexagon
*
* Default value is blue
.
* @returns {string} Value of property color
*/
public getColor(): string;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Whether the button is enabled or not.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Icon to display
* @returns {string} Value of property icon
*/
public getIcon(): string;
/**
* Gets current value of property {@link #getImagePosition imagePosition}.
*
* The position of the contained image. If not set the image is rendered with a fixed relative position.
* @returns {string} Value of property imagePosition
*/
public getImagePosition(): string;
/**
* Returns a metadata object for class sap.ui.demokit.HexagonButton.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPosition position}.
*
* The position. If set, the button is rendered with an absolute position.
* @returns {string} Value of property position
*/
public getPosition(): string;
/**
* Sets a new value for property {@link #getColor color}.
*
* The color of the hexagon
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is blue
.
* @param {string} sColor - New value for property color
* @returns {sap.ui.demokit.HexagonButton} Reference to this
in order to allow method chaining
*/
public setColor(sColor: string): sap.ui.demokit.HexagonButton;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Whether the button is enabled or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.demokit.HexagonButton} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.demokit.HexagonButton;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Icon to display
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sIcon - New value for property icon
* @returns {sap.ui.demokit.HexagonButton} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: string): sap.ui.demokit.HexagonButton;
/**
* Sets a new value for property {@link #getImagePosition imagePosition}.
*
* The position of the contained image. If not set the image is rendered with a fixed relative position.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sImagePosition - New value for property imagePosition
* @returns {sap.ui.demokit.HexagonButton} Reference to this
in order to allow method chaining
*/
public setImagePosition(sImagePosition: string): sap.ui.demokit.HexagonButton;
/**
* Sets a new value for property {@link #getPosition position}.
*
* The position. If set, the button is rendered with an absolute position.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sPosition - New value for property position
* @returns {sap.ui.demokit.HexagonButton} Reference to this
in order to allow method chaining
*/
public setPosition(sPosition: string): sap.ui.demokit.HexagonButton;
}
/**
* A group of HexagonButtons, aligned in a packed grid
*/
export class HexagonButtonGroup extends sap.ui.core.Control {
/**
* Constructor for a new HexagonButtonGroup.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some button to the aggregation {@link #getButtons buttons}.
* @param {sap.ui.demokit.HexagonButton} oButton - the button to add; if empty, nothing is inserted
* @returns {sap.ui.demokit.HexagonButtonGroup} Reference to this
in order to allow method chaining
*/
public addButton(oButton: sap.ui.demokit.HexagonButton): sap.ui.demokit.HexagonButtonGroup;
/**
* Destroys all the buttons in the aggregation {@link #getButtons buttons}.
* @returns {sap.ui.demokit.HexagonButtonGroup} Reference to this
in order to allow method chaining
*/
public destroyButtons(): sap.ui.demokit.HexagonButtonGroup;
/**
* Creates a new subclass of class sap.ui.demokit.HexagonButtonGroup with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getButtons buttons}.
*
* The buttons to layout in a grid
* @returns {sap.ui.demokit.HexagonButton[]}
*/
public getButtons(): sap.ui.demokit.HexagonButton[];
/**
* Gets current value of property {@link #getColspan colspan}.
*
* How many buttons might be placed in the same row of the grid
*
* Default value is 3
.
* @returns {number} Value of property colspan
*/
public getColspan(): number;
/**
* Returns a metadata object for class sap.ui.demokit.HexagonButtonGroup.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.demokit.HexagonButton
in the aggregation {@link #getButtons buttons}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.demokit.HexagonButton} oButton - The button whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfButton(oButton: sap.ui.demokit.HexagonButton): number;
/**
* Inserts a button into the aggregation {@link #getButtons buttons}.
* @param {sap.ui.demokit.HexagonButton} oButton - the button to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the button should be inserted at; for a negative value of iIndex
, the button is inserted at position 0; for a value greater than the current size of the aggregation, the button is inserted at the last position
* @returns {sap.ui.demokit.HexagonButtonGroup} Reference to this
in order to allow method chaining
*/
public insertButton(oButton: sap.ui.demokit.HexagonButton, iIndex: number): sap.ui.demokit.HexagonButtonGroup;
/**
* Removes all the controls from the aggregation {@link #getButtons buttons}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.demokit.HexagonButton[]} An array of the removed elements (might be empty)
*/
public removeAllButtons(): sap.ui.demokit.HexagonButton[];
/**
* Removes a button from the aggregation {@link #getButtons buttons}.
* @param {number|string|sap.ui.demokit.HexagonButton} vButton - The button to remove or its index or id
* @returns {sap.ui.demokit.HexagonButton} The removed button or null
*/
public removeButton(vButton: number|string|sap.ui.demokit.HexagonButton): sap.ui.demokit.HexagonButton;
/**
* Sets a new value for property {@link #getColspan colspan}.
*
* How many buttons might be placed in the same row of the grid
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 3
.
* @param {number} iColspan - New value for property colspan
* @returns {sap.ui.demokit.HexagonButtonGroup} Reference to this
in order to allow method chaining
*/
public setColspan(iColspan: number): sap.ui.demokit.HexagonButtonGroup;
}
/**
* Layout which renders content items with equal width and height. The items are arranged in rows.
*/
export class IndexLayout extends sap.ui.core.Control {
/**
* Constructor for a new IndexLayout.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.demokit.IndexLayout} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.demokit.IndexLayout;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.demokit.IndexLayout} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.demokit.IndexLayout;
/**
* Creates a new subclass of class sap.ui.demokit.IndexLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content items
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getEnableScaling enableScaling}.
*
* Whether the given item width/height should be scaled according to the screen size.
*
* Default value is true
.
* @returns {boolean} Value of property enableScaling
*/
public getEnableScaling(): boolean;
/**
* Gets current value of property {@link #getItemHeight itemHeight}.
*
* The height of a content item. Only px values are allowed.
*
* Default value is 200px
.
* @returns {sap.ui.core.CSSSize} Value of property itemHeight
*/
public getItemHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getItemWidth itemWidth}.
*
* The width of a content item. Only px values are allowed.
*
* Default value is 200px
.
* @returns {sap.ui.core.CSSSize} Value of property itemWidth
*/
public getItemWidth(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.demokit.IndexLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.demokit.IndexLayout} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.demokit.IndexLayout;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getEnableScaling enableScaling}.
*
* Whether the given item width/height should be scaled according to the screen size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableScaling - New value for property enableScaling
* @returns {sap.ui.demokit.IndexLayout} Reference to this
in order to allow method chaining
*/
public setEnableScaling(bEnableScaling: boolean): sap.ui.demokit.IndexLayout;
/**
* Sets a new value for property {@link #getItemHeight itemHeight}.
*
* The height of a content item. Only px values are allowed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 200px
.
* @param {sap.ui.core.CSSSize} sItemHeight - New value for property itemHeight
* @returns {sap.ui.demokit.IndexLayout} Reference to this
in order to allow method chaining
*/
public setItemHeight(sItemHeight: sap.ui.core.CSSSize): sap.ui.demokit.IndexLayout;
/**
* Sets a new value for property {@link #getItemWidth itemWidth}.
*
* The width of a content item. Only px values are allowed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 200px
.
* @param {sap.ui.core.CSSSize} sItemWidth - New value for property itemWidth
* @returns {sap.ui.demokit.IndexLayout} Reference to this
in order to allow method chaining
*/
public setItemWidth(sItemWidth: sap.ui.core.CSSSize): sap.ui.demokit.IndexLayout;
}
/**
* A Tag in a TagCloud
*/
export class Tag extends sap.ui.core.Element {
/**
* Constructor for a new Tag.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.demokit.Tag with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.demokit.Tag.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* The text to be disaplyed for this tag.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getWeight weight}.
*
* The weight for this tag. Can be any integer value.
*
* Default value is 1
.
* @returns {number} Value of property weight
*/
public getWeight(): number;
/**
* Sets a new value for property {@link #getText text}.
*
* The text to be disaplyed for this tag.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.demokit.Tag} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.demokit.Tag;
/**
* Sets a new value for property {@link #getWeight weight}.
*
* The weight for this tag. Can be any integer value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} iWeight - New value for property weight
* @returns {sap.ui.demokit.Tag} Reference to this
in order to allow method chaining
*/
public setWeight(iWeight: number): sap.ui.demokit.Tag;
}
/**
* A simple TagCloud representing a set of weighted tags
*/
export class TagCloud extends sap.ui.core.Control {
/**
* Constructor for a new TagCloud.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some tag to the aggregation {@link #getTags tags}.
* @param {sap.ui.demokit.Tag} oTag - the tag to add; if empty, nothing is inserted
* @returns {sap.ui.demokit.TagCloud} Reference to this
in order to allow method chaining
*/
public addTag(oTag: sap.ui.demokit.Tag): sap.ui.demokit.TagCloud;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.demokit.TagCloud
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.demokit.TagCloud
itself.
*
* Fired when a Tag is clicked.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.demokit.TagCloud
itself
* @returns {sap.ui.demokit.TagCloud} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.ui.demokit.TagCloud;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.demokit.TagCloud
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.demokit.TagCloud
itself.
*
* Fired when a Tag is clicked.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.demokit.TagCloud
itself
* @returns {sap.ui.demokit.TagCloud} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.ui.demokit.TagCloud;
/**
* Destroys all the tags in the aggregation {@link #getTags tags}.
* @returns {sap.ui.demokit.TagCloud} Reference to this
in order to allow method chaining
*/
public destroyTags(): sap.ui.demokit.TagCloud;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.ui.demokit.TagCloud
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.demokit.TagCloud} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.ui.demokit.TagCloud;
/**
* Creates a new subclass of class sap.ui.demokit.TagCloud with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.demokit.TagCloud} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.ui.demokit.TagCloud;
/**
* Gets current value of property {@link #getMaxFontSize maxFontSize}.
*
* Maximum font size that may be chosen for a tag in this cloud
*
* Default value is 30
.
* @returns {number} Value of property maxFontSize
*/
public getMaxFontSize(): number;
/**
* Returns a metadata object for class sap.ui.demokit.TagCloud.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinFontSize minFontSize}.
*
* Minimum font size that must be used for a tag in this cloud
*
* Default value is 10
.
* @returns {number} Value of property minFontSize
*/
public getMinFontSize(): number;
/**
* Gets content of aggregation {@link #getTags tags}.
*
* The tags displayed in this tag cloud
* @returns {sap.ui.demokit.Tag[]}
*/
public getTags(): sap.ui.demokit.Tag[];
/**
* Checks for the provided sap.ui.demokit.Tag
in the aggregation {@link #getTags tags}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.demokit.Tag} oTag - The tag whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfTag(oTag: sap.ui.demokit.Tag): number;
/**
* Inserts a tag into the aggregation {@link #getTags tags}.
* @param {sap.ui.demokit.Tag} oTag - the tag to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the tag should be inserted at; for a negative value of iIndex
, the tag is inserted at position 0; for a value greater than the current size of the aggregation, the tag is inserted at the last position
* @returns {sap.ui.demokit.TagCloud} Reference to this
in order to allow method chaining
*/
public insertTag(oTag: sap.ui.demokit.Tag, iIndex: number): sap.ui.demokit.TagCloud;
/**
* Removes all the controls from the aggregation {@link #getTags tags}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.demokit.Tag[]} An array of the removed elements (might be empty)
*/
public removeAllTags(): sap.ui.demokit.Tag[];
/**
* Removes a tag from the aggregation {@link #getTags tags}.
* @param {number|string|sap.ui.demokit.Tag} vTag - The tag to remove or its index or id
* @returns {sap.ui.demokit.Tag} The removed tag or null
*/
public removeTag(vTag: number|string|sap.ui.demokit.Tag): sap.ui.demokit.Tag;
/**
* Sets a new value for property {@link #getMaxFontSize maxFontSize}.
*
* Maximum font size that may be chosen for a tag in this cloud
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 30
.
* @param {number} iMaxFontSize - New value for property maxFontSize
* @returns {sap.ui.demokit.TagCloud} Reference to this
in order to allow method chaining
*/
public setMaxFontSize(iMaxFontSize: number): sap.ui.demokit.TagCloud;
/**
* Sets a new value for property {@link #getMinFontSize minFontSize}.
*
* Minimum font size that must be used for a tag in this cloud
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 10
.
* @param {number} iMinFontSize - New value for property minFontSize
* @returns {sap.ui.demokit.TagCloud} Reference to this
in order to allow method chaining
*/
public setMinFontSize(iMinFontSize: number): sap.ui.demokit.TagCloud;
}
/**
* Displays documentation for a UI5 entity (control or type).
*
* The documentation will be read from a UI5 metamodel file that by default is loaded from the same resource location
* where the control or type would be loaded from (using the UI5 resource loading). This control displays all properties,
* aggregations, associations, events and methods that are described in the metamodel. For each part, it lists the name,
* type (where applicable) and documentation. If the navigable property is set to true, all types are shown as links
* and when pressed, the navigate event is fired. This allows consumers to react on a user click on such a type
* (and to e.g. navigate to the underlying type of a property or aggregation)
*/
export class UI5EntityCueCard extends sap.ui.core.Control {
/**
* Constructor for a new UI5EntityCueCard.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.ui.demokit.UI5EntityCueCard
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.demokit.UI5EntityCueCard
itself.
*
* Fired when a link for a type is activated (clicked) by the user.
*
* When property "navigable" is set to true, type links are created for the types of properties, aggregations and associations, for the types of event or method parameters and for the return types of methods (if not void).
*
* The default behavior for this event is to set the entityName property to the clicked entityName. Applications can prevent the default by calling the corresponding method on the event object.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.demokit.UI5EntityCueCard
itself
* @returns {sap.ui.demokit.UI5EntityCueCard} Reference to this
in order to allow method chaining
*/
public attachNavigate(fnFunction: Function, oListener?: any): sap.ui.demokit.UI5EntityCueCard;
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.ui.demokit.UI5EntityCueCard
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.demokit.UI5EntityCueCard
itself.
*
* Fired when a link for a type is activated (clicked) by the user.
*
* When property "navigable" is set to true, type links are created for the types of properties, aggregations and associations, for the types of event or method parameters and for the return types of methods (if not void).
*
* The default behavior for this event is to set the entityName property to the clicked entityName. Applications can prevent the default by calling the corresponding method on the event object.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.demokit.UI5EntityCueCard
itself
* @returns {sap.ui.demokit.UI5EntityCueCard} Reference to this
in order to allow method chaining
*/
public attachNavigate(oData: any, fnFunction: Function, oListener?: any): sap.ui.demokit.UI5EntityCueCard;
/**
* Detaches event handler fnFunction
from the {@link #event:navigate navigate} event of this sap.ui.demokit.UI5EntityCueCard
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.demokit.UI5EntityCueCard} Reference to this
in order to allow method chaining
*/
public detachNavigate(fnFunction: Function, oListener: any): sap.ui.demokit.UI5EntityCueCard;
/**
* Creates a new subclass of class sap.ui.demokit.UI5EntityCueCard with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:navigate navigate} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireNavigate(mParameters?: any): boolean;
/**
* Gets current value of property {@link #getCollapsible collapsible}.
*
* Whether the cue card can be collapsed at all. When set to true, the value of property expanded determines the current collapsed/expanded state. When false, the control is always expanded.
*
* Default value is true
.
* @returns {boolean} Value of property collapsible
*/
public getCollapsible(): boolean;
/**
* Gets current value of property {@link #getEntityName entityName}.
*
* Qualified name of the control or type to show the documentation for. The name can be specified in the metamodel notation ('sap.ui.core/Control' or in the UI5 resource notation (sap.ui.core.Control).
* @returns {string} Value of property entityName
*/
public getEntityName(): string;
/**
* Gets current value of property {@link #getExpanded expanded}.
*
* Whether the cue card is currently expanded.
*
* Default value is false
.
* @returns {boolean} Value of property expanded
*/
public getExpanded(): boolean;
/**
* Returns a metadata object for class sap.ui.demokit.UI5EntityCueCard.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getNavigable navigable}.
*
* Whether type information is navigable. Also see event 'navigate'.
*
* Default value is false
.
* @returns {boolean} Value of property navigable
*/
public getNavigable(): boolean;
/**
* Gets current value of property {@link #getStyle style}.
*
* Style of the cue card.
* @returns {sap.ui.demokit.UI5EntityCueCardStyle} Value of property style
*/
public getStyle(): sap.ui.demokit.UI5EntityCueCardStyle;
/**
* Sets a new value for property {@link #getCollapsible collapsible}.
*
* Whether the cue card can be collapsed at all. When set to true, the value of property expanded determines the current collapsed/expanded state. When false, the control is always expanded.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bCollapsible - New value for property collapsible
* @returns {sap.ui.demokit.UI5EntityCueCard} Reference to this
in order to allow method chaining
*/
public setCollapsible(bCollapsible: boolean): sap.ui.demokit.UI5EntityCueCard;
/**
* Sets a new value for property {@link #getEntityName entityName}.
*
* Qualified name of the control or type to show the documentation for. The name can be specified in the metamodel notation ('sap.ui.core/Control' or in the UI5 resource notation (sap.ui.core.Control).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sEntityName - New value for property entityName
* @returns {sap.ui.demokit.UI5EntityCueCard} Reference to this
in order to allow method chaining
*/
public setEntityName(sEntityName: string): sap.ui.demokit.UI5EntityCueCard;
/**
* Sets a new value for property {@link #getExpanded expanded}.
*
* Whether the cue card is currently expanded.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bExpanded - New value for property expanded
* @returns {sap.ui.demokit.UI5EntityCueCard} Reference to this
in order to allow method chaining
*/
public setExpanded(bExpanded: boolean): sap.ui.demokit.UI5EntityCueCard;
/**
* Sets a new value for property {@link #getNavigable navigable}.
*
* Whether type information is navigable. Also see event 'navigate'.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bNavigable - New value for property navigable
* @returns {sap.ui.demokit.UI5EntityCueCard} Reference to this
in order to allow method chaining
*/
public setNavigable(bNavigable: boolean): sap.ui.demokit.UI5EntityCueCard;
/**
* Sets a new value for property {@link #getStyle style}.
*
* Style of the cue card.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.demokit.UI5EntityCueCardStyle} sStyle - New value for property style
* @returns {sap.ui.demokit.UI5EntityCueCard} Reference to this
in order to allow method chaining
*/
public setStyle(sStyle: sap.ui.demokit.UI5EntityCueCardStyle): sap.ui.demokit.UI5EntityCueCard;
}
/**
* Different styles for an entity cue card.
*/
export enum UI5EntityCueCardStyle {
/**
* Demokit style
*/
Demokit = "Demokit",
/**
* default style (no special styling).
*/
Standard = "Standard",
}
/**
* A substitute for a UIArea that can be embedded in the control tree.
*/
export class UIAreaSubstitute extends sap.ui.core.Element {
/**
* Constructor for a new UIAreaSubstitute.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.demokit.UIAreaSubstitute} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.demokit.UIAreaSubstitute;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.demokit.UIAreaSubstitute} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.demokit.UIAreaSubstitute;
/**
* Creates a new subclass of class sap.ui.demokit.UIAreaSubstitute with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Content Area used for the running sample code
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.ui.demokit.UIAreaSubstitute.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.demokit.UIAreaSubstitute} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.demokit.UIAreaSubstitute;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
}
}
/**
* Device and Feature Detection API: Provides information about the used browser / device and cross platform support for certain events
* like media queries, orientation change or resizing.
*
* This API is independent from any other part of the UI5 framework. This allows it to be loaded beforehand, if it is needed, to create the UI5 bootstrap
* dynamically depending on the capabilities of the browser or device.
*/
namespace Device {
/**
* Contains information about the used browser.
*/
namespace browser {
/**
* If this flag is set to true
, the Google Chrome browser is used.
*/
var chrome: boolean;
/**
* If this flag is set to true
, the Microsoft Edge browser is used.
*/
var edge: boolean;
/**
* If this flag is set to true
, the Mozilla Firefox browser is used.
*/
var firefox: boolean;
/**
* If this flag is set to true
, the Safari browser runs in standalone fullscreen mode on iOS.
*
* Note: This flag is only available if the Safari browser was detected. Furthermore, if this mode is detected,
* technically not a standard Safari is used. There might be slight differences in behavior and detection, e.g.
* the availability of {@link sap.ui.Device.browser.version}.
*/
var fullscreen: boolean;
/**
* If this flag is set to true
, the Microsoft Internet Explorer browser is used.
*/
var internet_explorer: boolean;
/**
* If this flag is set to true
, the mobile variant of the browser is used or
* a tablet or phone device is detected.
*
* Note: This information might not be available for all browsers.
*/
var mobile: boolean;
/**
* If this flag is set to true
, a browser featuring a Mozilla engine is used.
*/
var mozilla: boolean;
/**
* If this flag is set to true
, the Microsoft Internet Explorer browser is used.
*/
var msie: boolean;
/**
* The name of the browser.
*/
var name: string;
/**
* If this flag is set to true
, the Apple Safari browser is used.
*
* Note:
* This flag is also true
when the standalone (fullscreen) mode or webview is used on iOS devices.
* Please also note the flags {@link sap.ui.Device.browser.fullscreen} and {@link sap.ui.Device.browser.webview}.
*/
var safari: boolean;
/**
* The version of the browser as float
.
*
* Might be -1
if no version can be determined.
*/
var version: number;
/**
* The version of the browser as string
.
*
* Might be empty if no version can be determined.
*/
var versionStr: string;
/**
* If this flag is set to true
, a browser featuring a Webkit engine is used.
*/
var webkit: boolean;
/**
* If this flag is set to true
, the Safari browser runs in webview mode on iOS.
*
* Note: This flag is only available if the Safari browser was detected. Furthermore, if this mode is detected,
* technically not a standard Safari is used. There might be slight differences in behavior and detection, e.g.
* the availability of {@link sap.ui.Device.browser.version}.
*/
var webview: boolean;
/**
* Enumeration containing the names of known browsers.
*/
namespace BROWSER {
/**
* Android stock browser name.
*/
var ANDROID: any;
/**
* Chrome browser name.
*/
var CHROME: any;
/**
* Edge browser name.
*/
var EDGE: any;
/**
* Firefox browser name.
*/
var FIREFOX: any;
/**
* Internet Explorer browser name.
*/
var INTERNET_EXPLORER: any;
/**
* Safari browser name.
*/
var SAFARI: any;
}
}
/**
* Event API for screen width changes.
*
* This API is based on media queries but can also be used if media queries are not natively supported by the used browser.
* In this case, the behavior of media queries is simulated by this API.
*
* There are several predefined {@link sap.ui.Device.media.RANGESETS range sets} available. Each of them defines a
* set of intervals for the screen width (from small to large). Whenever the screen width changes and the current screen width is in
* a different interval to the one before the change, the registered event handlers for the range set are called.
*
* If needed, it is also possible to define a custom set of intervals.
*
* The following example shows a typical use case:
*
* function sizeChanged(mParams) {
* switch(mParams.name) {
* case "Phone":
* // Do what is needed for a little screen
* break;
* case "Tablet":
* // Do what is needed for a medium sized screen
* break;
* case "Desktop":
* // Do what is needed for a large screen
* }
* }
*
* // Register an event handler to changes of the screen size
* sap.ui.Device.media.attachHandler(sizeChanged, null, sap.ui.Device.media.RANGESETS.SAP_STANDARD);
* // Do some initialization work based on the current size
* sizeChanged(sap.ui.Device.media.getCurrentRange(sap.ui.Device.media.RANGESETS.SAP_STANDARD));
*
*/
namespace media {
/**
* Registers the given event handler to change events of the screen width based on the range set with the specified name.
*
* The event is fired whenever the screen width changes and the current screen width is in
* a different interval of the given range set than before the width change.
*
* The event handler is called with a single argument: a map mParams
which provides the following information
* about the entered interval:
*
* mParams.from
: The start value (inclusive) of the entered interval as a number
* mParams.to
: The end value (exclusive) range of the entered interval as a number or undefined for the last interval (infinity)
* mParams.unit
: The unit used for the values above, e.g. "px"
* mParams.name
: The name of the entered interval, if available
*
* @param {Function} fnFunction - The handler function to call when the event occurs. This function will be called in the context of the oListener
instance (if present) or on the window
instance. A map with information about the entered range set is provided as a single argument to the handler (see details above).
* @param {string} sName - The name of the range set to listen to. The range set must be initialized beforehand ({@link sap.ui.Device.media.initRangeSet}). If no name is provided, the {@link sap.ui.Device.media.RANGESETS.SAP_STANDARD default range set} is used.
*/
function attachHandler(fnFunction: Function, sName: string): void;
/**
* Registers the given event handler to change events of the screen width based on the range set with the specified name.
*
* The event is fired whenever the screen width changes and the current screen width is in
* a different interval of the given range set than before the width change.
*
* The event handler is called with a single argument: a map mParams
which provides the following information
* about the entered interval:
*
* mParams.from
: The start value (inclusive) of the entered interval as a number
* mParams.to
: The end value (exclusive) range of the entered interval as a number or undefined for the last interval (infinity)
* mParams.unit
: The unit used for the values above, e.g. "px"
* mParams.name
: The name of the entered interval, if available
*
* @param {Function} fnFunction - The handler function to call when the event occurs. This function will be called in the context of the oListener
instance (if present) or on the window
instance. A map with information about the entered range set is provided as a single argument to the handler (see details above).
* @param {any} oListener - The object that wants to be notified when the event occurs (this
context within the handler function). If it is not specified, the handler function is called in the context of the window
.
* @param {string} sName - The name of the range set to listen to. The range set must be initialized beforehand ({@link sap.ui.Device.media.initRangeSet}). If no name is provided, the {@link sap.ui.Device.media.RANGESETS.SAP_STANDARD default range set} is used.
*/
function attachHandler(fnFunction: Function, oListener: any, sName: string): void;
/**
* Removes a previously attached event handler from the change events of the screen width.
*
* The passed parameters must match those used for registration with {@link #.attachHandler} beforehand.
* @param {Function} fnFunction - The handler function to detach from the event
* @param {string} sName - The name of the range set to listen to. If no name is provided, the {@link sap.ui.Device.media.RANGESETS.SAP_STANDARD default range set} is used.
*/
function detachHandler(fnFunction: Function, sName: string): void;
/**
* Removes a previously attached event handler from the change events of the screen width.
*
* The passed parameters must match those used for registration with {@link #.attachHandler} beforehand.
* @param {Function} fnFunction - The handler function to detach from the event
* @param {any} oListener - The object that wanted to be notified when the event occurred
* @param {string} sName - The name of the range set to listen to. If no name is provided, the {@link sap.ui.Device.media.RANGESETS.SAP_STANDARD default range set} is used.
*/
function detachHandler(fnFunction: Function, oListener: any, sName: string): void;
/**
* Returns information about the current active range of the range set with the given name.
*
* If the optional parameter iWidth is given, the active range will be determined for that width,
* otherwise it is determined for the current window size.
* @param {string} sName - The name of the range set. The range set must be initialized beforehand ({@link sap.ui.Device.media.initRangeSet})
* @param {number} iWidth - An optional width, based on which the range should be determined; If iWidth
is not a number, the window size will be used.
* @returns {{ [key: string]: any }} Information about the current active interval of the range set. The returned map has the same structure as the argument of the event handlers ({@link sap.ui.Device.media.attachHandler})
*/
function getCurrentRange(sName: string, iWidth?: number): { [key: string]: any };
/**
* Returns true
if a range set with the given name is already initialized.
* @param {string} sName - The name of the range set.
* @returns {boolean} Returns true
if a range set with the given name is already initialized
*/
function hasRangeSet(sName: string): boolean;
/**
* Initializes a screen width media query range set.
*
* This initialization step makes the range set ready to be used for one of the other functions in namespace sap.ui.Device.media
.
* The most important {@link sap.ui.Device.media.RANGESETS predefined range sets} are initialized automatically.
*
* To make a not yet initialized {@link sap.ui.Device.media.RANGESETS predefined range set} ready to be used, call this function with the
* name of the range set to be initialized:
*
* sap.ui.Device.media.initRangeSet(sap.ui.Device.media.RANGESETS.SAP_3STEPS);
*
*
* Alternatively it is possible to define custom range sets as shown in the following example:
*
* sap.ui.Device.media.initRangeSet("MyRangeSet", [200, 400], "px", ["Small", "Medium", "Large"]);
*
* This example defines the following named ranges:
*
* "Small"
: For screens smaller than 200 pixels.
* "Medium"
: For screens greater than or equal to 200 pixels and smaller than 400 pixels.
* "Large"
: For screens greater than or equal to 400 pixels.
*
* The range names are optional. If they are specified a CSS class (e.g. sapUiMedia-MyRangeSet-Small
) is also
* added to the document root depending on the current active range. This can be suppressed via parameter bSuppressClasses
.
* @param {string} sName - The name of the range set to be initialized - either a {@link sap.ui.Device.media.RANGESETS predefined} or custom one. The name must be a valid id and consist only of letters and numeric digits.
* @param {number[]} aRangeBorders - The range borders
* @param {string} sUnit - The unit which should be used for the values given in aRangeBorders
. The allowed values are "px"
(default), "em"
or "rem"
* @param {string[]} aRangeNames - The names of the ranges. The names must be a valid id and consist only of letters and digits. If names are specified, CSS classes are also added to the document root as described above. This behavior can be switched off explicitly by using bSuppressClasses
. Note: aRangeBorders
with n
entries define n+1
ranges. Therefore n+1
names must be provided.
* @param {boolean} bSuppressClasses - Whether or not writing of CSS classes to the document root should be suppressed when aRangeNames
are provided
*/
function initRangeSet(sName: string, aRangeBorders?: number[], sUnit?: string, aRangeNames?: string[], bSuppressClasses?: boolean): void;
/**
* Removes a previously initialized range set and detaches all registered handlers.
*
* Only custom range sets can be removed via this function. Initialized predefined range sets
* ({@link sap.ui.Device.media.RANGESETS}) cannot be removed.
* @param {string} sName - The name of the range set which should be removed.
*/
function removeRangeSet(sName: string): void;
/**
* Enumeration containing the names and settings of predefined screen width media query range sets.
*/
namespace RANGESETS {
/**
* A 3-step range set (S-L).
*
* The ranges of this set are:
*
* "S"
: For screens smaller than 520 pixels.
* "M"
: For screens greater than or equal to 520 pixels and smaller than 960 pixels.
* "L"
: For screens greater than or equal to 960 pixels.
*
*
* To use this range set, you must initialize it explicitly ({@link sap.ui.Device.media.initRangeSet}).
*
* If this range set is initialized, a CSS class is added to the page root (html
tag) which indicates the current
* screen width range: sapUiMedia-3Step-NAME_OF_THE_INTERVAL
.
*/
var SAP_3STEPS: any;
/**
* A 4-step range set (S-XL).
*
* The ranges of this set are:
*
* "S"
: For screens smaller than 520 pixels.
* "M"
: For screens greater than or equal to 520 pixels and smaller than 760 pixels.
* "L"
: For screens greater than or equal to 760 pixels and smaller than 960 pixels.
* "XL"
: For screens greater than or equal to 960 pixels.
*
*
* To use this range set, you must initialize it explicitly ({@link sap.ui.Device.media.initRangeSet}).
*
* If this range set is initialized, a CSS class is added to the page root (html
tag) which indicates the current
* screen width range: sapUiMedia-4Step-NAME_OF_THE_INTERVAL
.
*/
var SAP_4STEPS: any;
/**
* A 6-step range set (XS-XXL).
*
* The ranges of this set are:
*
* "XS"
: For screens smaller than 241 pixels.
* "S"
: For screens greater than or equal to 241 pixels and smaller than 400 pixels.
* "M"
: For screens greater than or equal to 400 pixels and smaller than 541 pixels.
* "L"
: For screens greater than or equal to 541 pixels and smaller than 768 pixels.
* "XL"
: For screens greater than or equal to 768 pixels and smaller than 960 pixels.
* "XXL"
: For screens greater than or equal to 960 pixels.
*
*
* To use this range set, you must initialize it explicitly ({@link sap.ui.Device.media.initRangeSet}).
*
* If this range set is initialized, a CSS class is added to the page root (html
tag) which indicates the current
* screen width range: sapUiMedia-6Step-NAME_OF_THE_INTERVAL
.
*/
var SAP_6STEPS: any;
/**
* A 3-step range set (Phone, Tablet, Desktop).
*
* The ranges of this set are:
*
* "Phone"
: For screens smaller than 600 pixels.
* "Tablet"
: For screens greater than or equal to 600 pixels and smaller than 1024 pixels.
* "Desktop"
: For screens greater than or equal to 1024 pixels.
*
*
* This range set is initialized by default. An initialization via {@link sap.ui.Device.media.initRangeSet} is not needed.
*
* A CSS class is added to the page root (html
tag) which indicates the current
* screen width range: sapUiMedia-Std-NAME_OF_THE_INTERVAL
.
* Furthermore there are 5 additional CSS classes to hide elements based on the width of the screen:
*
* sapUiHideOnPhone
: Will be hidden if the screen has 600px or more
* sapUiHideOnTablet
: Will be hidden if the screen has less than 600px or more than 1023px
* sapUiHideOnDesktop
: Will be hidden if the screen is smaller than 1024px
* sapUiVisibleOnlyOnPhone
: Will be visible if the screen has less than 600px
* sapUiVisibleOnlyOnTablet
: Will be visible if the screen has 600px or more but less than 1024px
* sapUiVisibleOnlyOnDesktop
: Will be visible if the screen has 1024px or more
*
*/
var SAP_STANDARD: any;
/**
* A 4-step range set (Phone, Tablet, Desktop, LargeDesktop).
*
* The ranges of this set are:
*
* "Phone"
: For screens smaller than 600 pixels.
* "Tablet"
: For screens greater than or equal to 600 pixels and smaller than 1024 pixels.
* "Desktop"
: For screens greater than or equal to 1024 pixels and smaller than 1440 pixels.
* "LargeDesktop"
: For screens greater than or equal to 1440 pixels.
*
*
* This range set is initialized by default. An initialization via {@link sap.ui.Device.media.initRangeSet} is not needed.
*
* A CSS class is added to the page root (html
tag) which indicates the current
* screen width range: sapUiMedia-StdExt-NAME_OF_THE_INTERVAL
.
*/
var SAP_STANDARD_EXTENDED: any;
}
}
/**
* Common API for orientation change notifications across all platforms.
*
* For browsers or devices that do not provide native support for orientation change events
* the API simulates them based on the ratio of the document's width and height.
*/
namespace orientation {
/**
* If this flag is set to true
, the screen is currently in landscape mode (the width is greater than the height).
*/
var landscape: boolean;
/**
* If this flag is set to true
, the screen is currently in portrait mode (the height is greater than the width).
*/
var portrait: boolean;
/**
* Registers the given event handler to orientation change events of the document's window.
*
* The event is fired whenever the screen orientation changes and the width of the document's window
* becomes greater than its height or the other way round.
*
* The event handler is called with a single argument: a map mParams
which provides the following information:
*
* mParams.landscape
: If this flag is set to true
, the screen is currently in landscape mode, otherwise in portrait mode.
*
* @param {Function} fnFunction - The handler function to call when the event occurs. This function will be called in the context of the oListener
instance (if present) or on the window
instance. A map with information about the orientation is provided as a single argument to the handler (see details above).
* @param {any} oListener - The object that wants to be notified when the event occurs (this
context within the handler function). If it is not specified, the handler function is called in the context of the window
.
*/
function attachHandler(fnFunction: Function, oListener?: any): void;
/**
* Removes a previously attached event handler from the orientation change events.
*
* The passed parameters must match those used for registration with {@link #.attachHandler} beforehand.
* @param {Function} fnFunction - The handler function to detach from the event
* @param {any} oListener - The object that wanted to be notified when the event occurred
*/
function detachHandler(fnFunction: Function, oListener?: any): void;
}
/**
* Contains information about the operating system of the device.
*/
namespace os {
/**
* If this flag is set to true
, an Android operating system is used.
*/
var android: boolean;
/**
* If this flag is set to true
, a Blackberry operating system is used.
*/
var blackberry: boolean;
/**
* If this flag is set to true
, an iOS operating system is used.
*/
var ios: boolean;
/**
* If this flag is set to true
, a Linux operating system is used.
*/
var linux: boolean;
/**
* If this flag is set to true
, a Mac operating system is used.
*/
var macintosh: boolean;
/**
* The name of the operating system.
*/
var name: string;
/**
* The version of the operating system as float
.
*
* Might be -1
if no version can be determined.
*/
var version: number;
/**
* The version of the operating system as string
.
*
* Might be empty if no version can be determined.
*/
var versionStr: string;
/**
* If this flag is set to true
, a Windows operating system is used.
*/
var windows: boolean;
/**
* If this flag is set to true
, a Windows Phone operating system is used.
*/
var windows_phone: boolean;
/**
* Enumeration containing the names of known operating systems.
*/
namespace OS {
/**
* Android operating system name.
*/
var ANDROID: any;
/**
* Blackberry operating system name.
*/
var BLACKBERRY: any;
/**
* iOS operating system name.
*/
var IOS: any;
/**
* Linux operating system name.
*/
var LINUX: any;
/**
* MAC operating system name.
*/
var MACINTOSH: any;
/**
* Windows operating system name.
*/
var WINDOWS: any;
/**
* Windows Phone operating system name.
*/
var WINDOWS_PHONE: any;
}
}
/**
* Common API for document window size change notifications across all platforms.
*/
namespace resize {
/**
* The current height of the document's window in pixels.
*/
var height: number;
/**
* The current width of the document's window in pixels.
*/
var width: number;
/**
* Registers the given event handler to resize change events of the document's window.
*
* The event is fired whenever the document's window size changes.
*
* The event handler is called with a single argument: a map mParams
which provides the following information:
*
* mParams.height
: The height of the document's window in pixels.
* mParams.width
: The width of the document's window in pixels.
*
* @param {Function} fnFunction - The handler function to call when the event occurs. This function will be called in the context of the oListener
instance (if present) or on the window
instance. A map with information about the size is provided as a single argument to the handler (see details above).
* @param {any} oListener - The object that wants to be notified when the event occurs (this
context within the handler function). If it is not specified, the handler function is called in the context of the window
.
*/
function attachHandler(fnFunction: Function, oListener?: any): void;
/**
* Removes a previously attached event handler from the resize events.
*
* The passed parameters must match those used for registration with {@link #.attachHandler} beforehand.
* @param {Function} fnFunction - The handler function to detach from the event
* @param {any} oListener - The object that wanted to be notified when the event occurred
*/
function detachHandler(fnFunction: Function, oListener?: any): void;
}
/**
* Contains information about detected capabilities of the used browser or device.
*/
namespace support {
/**
* If this flag is set to true
, the used browser natively supports media queries via JavaScript.
*
* Note: The {@link sap.ui.Device.media media queries API} of the device API can also be used when there is no native support.
*/
var matchmedia: boolean;
/**
* If this flag is set to true
, the used browser natively supports events of media queries via JavaScript.
*
* Note: The {@link sap.ui.Device.media media queries API} of the device API can also be used when there is no native support.
*/
var matchmedialistener: boolean;
/**
* If this flag is set to true
, the used browser natively supports the orientationchange
event.
*
* Note: The {@link sap.ui.Device.orientation orientation event} of the device API can also be used when there is no native support.
*/
var orientation: boolean;
/**
* If this flag is set to true
, the used browser supports pointer events.
*/
var pointer: boolean;
/**
* If this flag is set to true
, the device has a display with a high resolution.
*/
var retina: boolean;
/**
* If this flag is set to true
, the used browser supports touch events.
*
* Note: This flag indicates whether the used browser supports touch events or not.
* This does not necessarily mean that the used device has a touchable screen.
*/
var touch: boolean;
/**
* If this flag is set to true
, the used browser supports web sockets.
*/
var websocket: boolean;
}
/**
* Provides a basic categorization of the used device based on various indicators.
*
* These indicators are for example the support of touch events, the screen size, the used operation system or
* the user agent of the browser.
*
* Note: Depending on the capabilities of the device it is also possible that multiple flags are set to true
.
*/
namespace system {
/**
* If this flag is set to true
, the device is recognized as a combination of a desktop system and tablet.
*
* Furthermore, a CSS class sap-combi
is added to the document root element.
*
* Note: This property is mainly for Microsoft Windows 8 (and following) devices where the mouse and touch event may be supported
* natively by the browser being used. This property is set to true
only when both mouse and touch event are natively supported.
*/
var combi: boolean;
/**
* If this flag is set to true
, the device is recognized as a desktop system.
*
* Furthermore, a CSS class sap-desktop
is added to the document root element.
*/
var desktop: boolean;
/**
* If this flag is set to true
, the device is recognized as a phone.
*
* Furthermore, a CSS class sap-phone
is added to the document root element.
*/
var phone: boolean;
/**
* If this flag is set to true
, the device is recognized as a tablet.
*
* Furthermore, a CSS class sap-tablet
is added to the document root element.
*
* Note: This flag is also true for some browsers on desktop devices running on Windows 8 or higher. Also see the
* documentation for {@link sap.ui.Device.system.combi} devices.
* You can use the following logic to ensure that the current device is a tablet device:
*
*
* if(sap.ui.Device.system.tablet && !sap.ui.Device.system.desktop){
* ...tablet related commands...
* }
*
*/
var tablet: boolean;
}
}
/**
* SAPUI5 library with layout controls.
*/
namespace layout {
/**
* Available Background Design.
*/
export enum BackgroundDesign {
/**
* A solid background color dependent on the theme.
*/
Solid = "Solid",
/**
* A translucent background depending on the opacity value of the theme.
*/
Translucent = "Translucent",
/**
* Transparent background.
*/
Transparent = "Transparent",
}
/**
* A string type that is used inside the BlockLayout to set predefined background color to the cells inside
* the control.
*/
export enum BlockBackgroundType {
/**
* Background with pre-defined accent colors
*/
Accent = "Accent",
/**
* For applications that want to make use of e.g. charts in the Blocks, this layout type has spacings around the Blocks
*/
Dashboard = "Dashboard",
/**
* Background is transparent
*/
Default = "Default",
/**
* Background is with predefined light colors
*/
Light = "Light",
/**
* Background with bright and dark background colors
*/
Mixed = "Mixed",
}
/**
* The BlockLayout is used to display several objects in a section-based manner.
* Overview
* The BlockLayout uses horizontal and vertical subdivisions, and full-width banners to display a set of elements.
* By placing pictorial and textual elements side-by-side in different blocks, you can establish a visual connection between blocks and between similar elements.
* Structure
* The BlockLayout comes in five predefined types for background colors:
*
* - Layout only (default) - a layout scheme and no background colors
* - Bright - a layout scheme with bright colors
* - Accent - a layout scheme with four pre-defined color sets
* - Dashboard - a layout scheme with additional borders and no background colors
* - Mixed - a layout scheme with a mix of light and dark colors
*
* Background colors are attached directly to the blocks of the layout.
*
* Special full-width sections of the BlockLayout allow horizontal scrolling through a set of blocks.
*
* Note: With version 1.48 colors can be set for each individual {@link sap.ui.layout.BlockLayoutCell cell}. There are 11 pre-defined color sets, each with 4 different shades.
* The main colors of the sets can be changed in Theme Designer. To change the background of a particular cell, set backgroundColorSet
(main color)
* and backgroundColorShade
(shade).
*
* Usage
* When to use
*
* - You want to create a catalogue-like page with sections of blocks.
* - The BlockLayout is intended for developing administrative tools and applications.
*
* When not to use
*
* - You want to display properties or features of one content item. Use a {@link sap.uxap.ObjectPage object page} or {@link sap.f.DynamicPage dynamic page} instead.
*
* Responsive Behavior
*
* - The breakpoints of the block layout react to the width of the control itself and not to the actual screen size.
* - On small screens all blocks will wrap to a single scrollable column
*
*/
export class BlockLayout extends sap.ui.core.Control {
/**
* Constructor for a new BlockLayout.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.layout.BlockLayoutRow} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.layout.BlockLayout} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.layout.BlockLayoutRow): sap.ui.layout.BlockLayout;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.layout.BlockLayout} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.layout.BlockLayout;
/**
* Creates a new subclass of class sap.ui.layout.BlockLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getBackground background}.
*
* Determines the background used for the Layout
*
* Default value is Default
.
* @returns {sap.ui.layout.BlockBackgroundType} Value of property background
*/
public getBackground(): sap.ui.layout.BlockBackgroundType;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The Rows to be included in the content of the control
* @returns {sap.ui.layout.BlockLayoutRow[]}
*/
public getContent(): sap.ui.layout.BlockLayoutRow[];
/**
* Returns a metadata object for class sap.ui.layout.BlockLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.layout.BlockLayoutRow
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.layout.BlockLayoutRow} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.layout.BlockLayoutRow): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.layout.BlockLayoutRow} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.layout.BlockLayout} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.layout.BlockLayoutRow, iIndex: number): sap.ui.layout.BlockLayout;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.layout.BlockLayoutRow[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.layout.BlockLayoutRow[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.layout.BlockLayoutRow} vContent - The content to remove or its index or id
* @returns {sap.ui.layout.BlockLayoutRow} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.layout.BlockLayoutRow): sap.ui.layout.BlockLayoutRow;
/**
* Changes background type
* @param {string} sNewBackground - Background's style of type sap.ui.layout.BlockBackgroundType
* @returns {sap.ui.layout.BlockLayout} BlockLayout instance. Allows method chaining
*/
public setBackground(sNewBackground: string): sap.ui.layout.BlockLayout;
}
/**
* The BlockLayoutCell is used as an aggregation of the BlockLayoutRow. It contains Controls.
* The BlockLayoutCell should be used only as aggregation of the BlockLayoutRow.
*/
export class BlockLayoutCell extends sap.ui.core.Control {
/**
* Constructor for a new BlockLayoutCell.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.layout.BlockLayoutCell} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.layout.BlockLayoutCell;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.layout.BlockLayoutCell} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.layout.BlockLayoutCell;
/**
* Creates a new subclass of class sap.ui.layout.BlockLayoutCell with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getBackgroundColorSet backgroundColorSet}.
*
* The Background color set from which the background color will be selected.
* By using background colors from the predefined sets your colors could later be customized from the Theme Designer.
* Note: backgroundColorSet should be used only in combination with backgroundColorShade.
* @returns {sap.ui.layout.BlockLayoutCellColorSet} Value of property backgroundColorSet
*/
public getBackgroundColorSet(): sap.ui.layout.BlockLayoutCellColorSet;
/**
* Gets current value of property {@link #getBackgroundColorShade backgroundColorShade}.
*
* The index of the background color in the color set from which the color will be selected.
* By using background colors from the predefined sets your colors could later be customized from the Theme Designer.
* Note: backgroundColorShade should be used only in combination with backgroundColorSet.
* @returns {sap.ui.layout.BlockLayoutCellColorShade} Value of property backgroundColorShade
*/
public getBackgroundColorShade(): sap.ui.layout.BlockLayoutCellColorShade;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content to be included inside the cell
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.ui.layout.BlockLayoutCell.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTitle title}.
*
* Defines the title of the cell
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getTitleAlignment titleAlignment}.
*
* Defines the alignment of the cell title
*
* Default value is Begin
.
* @returns {sap.ui.core.HorizontalAlign} Value of property titleAlignment
*/
public getTitleAlignment(): sap.ui.core.HorizontalAlign;
/**
* Gets current value of property {@link #getTitleLevel titleLevel}.
*
* Defines the aria level of the title
* This information is e.g. used by assistive technologies like screenreaders to create a hierarchical site map for faster navigation.
*
* Default value is Auto
.
* @returns {sap.ui.core.TitleLevel} Value of property titleLevel
*/
public getTitleLevel(): sap.ui.core.TitleLevel;
/**
* Gets current value of property {@link #getWidth width}.
*
* Defines the width of the cell. Depending on the context of the cell - whether it's in scrollable,
* or non scrollable row, this property is interpreted in two different ways.
* If the cell is placed inside a scrollable row - this property defines the width of the cell in
* percentages. If no value is provided - the default is 40%.
* If the cell is placed inside a non scrollable row - this property defines the grow factor of the cell
* compared to the whole row.
* For example: If you have 2 cells, each with width of 1, this means that they should be of equal size,
* and they need to fill the whole row. This results in 50% width for each cell. If you have 2 cells,
* one with width of 1, the other with width of 3, this means that the whole row width is 4, so the first
* cell will have a width of 25%, the second - 75%.
* According to the visual guidelines, it is suggested that you only use 25%, 50%, 75% or 100% cells in
* you applications. For example, 12,5% width is not desirable (1 cell with width 1, and another with width 7)
*
* Default value is 0
.
* @returns {number} Value of property width
*/
public getWidth(): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.layout.BlockLayoutCell} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.layout.BlockLayoutCell;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getBackgroundColorSet backgroundColorSet}.
*
* The Background color set from which the background color will be selected.
* By using background colors from the predefined sets your colors could later be customized from the Theme Designer.
* Note: backgroundColorSet should be used only in combination with backgroundColorShade.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.layout.BlockLayoutCellColorSet} sBackgroundColorSet - New value for property backgroundColorSet
* @returns {sap.ui.layout.BlockLayoutCell} Reference to this
in order to allow method chaining
*/
public setBackgroundColorSet(sBackgroundColorSet: sap.ui.layout.BlockLayoutCellColorSet): sap.ui.layout.BlockLayoutCell;
/**
* Sets a new value for property {@link #getBackgroundColorShade backgroundColorShade}.
*
* The index of the background color in the color set from which the color will be selected.
* By using background colors from the predefined sets your colors could later be customized from the Theme Designer.
* Note: backgroundColorShade should be used only in combination with backgroundColorSet.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.layout.BlockLayoutCellColorShade} sBackgroundColorShade - New value for property backgroundColorShade
* @returns {sap.ui.layout.BlockLayoutCell} Reference to this
in order to allow method chaining
*/
public setBackgroundColorShade(sBackgroundColorShade: sap.ui.layout.BlockLayoutCellColorShade): sap.ui.layout.BlockLayoutCell;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Defines the title of the cell
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.layout.BlockLayoutCell} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.layout.BlockLayoutCell;
/**
* Sets a new value for property {@link #getTitleAlignment titleAlignment}.
*
* Defines the alignment of the cell title
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Begin
.
* @param {sap.ui.core.HorizontalAlign} sTitleAlignment - New value for property titleAlignment
* @returns {sap.ui.layout.BlockLayoutCell} Reference to this
in order to allow method chaining
*/
public setTitleAlignment(sTitleAlignment: sap.ui.core.HorizontalAlign): sap.ui.layout.BlockLayoutCell;
/**
* Sets a new value for property {@link #getTitleLevel titleLevel}.
*
* Defines the aria level of the title
* This information is e.g. used by assistive technologies like screenreaders to create a hierarchical site map for faster navigation.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.ui.core.TitleLevel} sTitleLevel - New value for property titleLevel
* @returns {sap.ui.layout.BlockLayoutCell} Reference to this
in order to allow method chaining
*/
public setTitleLevel(sTitleLevel: sap.ui.core.TitleLevel): sap.ui.layout.BlockLayoutCell;
}
/**
* A string type that is used inside the BlockLayoutCell to set a predefined set of colors for the cells.
*/
export enum BlockLayoutCellColorSet {
/**
* Color Set 1
*/
ColorSet1 = "ColorSet1",
/**
* Color Set 10
*/
ColorSet10 = "ColorSet10",
/**
* Color Set 11
*/
ColorSet11 = "ColorSet11",
/**
* Color Set 2
*/
ColorSet2 = "ColorSet2",
/**
* Color Set 3
*/
ColorSet3 = "ColorSet3",
/**
* Color Set 4
*/
ColorSet4 = "ColorSet4",
/**
* Color Set 5
*/
ColorSet5 = "ColorSet5",
/**
* Color Set 6
*/
ColorSet6 = "ColorSet6",
/**
* Color Set 7
*/
ColorSet7 = "ColorSet7",
/**
* Color Set 8
*/
ColorSet8 = "ColorSet8",
/**
* Color Set 9
*/
ColorSet9 = "ColorSet9",
}
/**
* A string type that is used inside the BlockLayoutCell to set a predefined set of color shades for the cells.
* The colors are defined with sap.ui.layout.BlockLayoutCellColorSet. And this is for the shades only.
*/
export enum BlockLayoutCellColorShade {
/**
* Shade A
*/
ShadeA = "ShadeA",
/**
* Shade B
*/
ShadeB = "ShadeB",
/**
* Shade C
*/
ShadeC = "ShadeC",
/**
* Shade D
*/
ShadeD = "ShadeD",
}
/**
* The BlockLayoutRow is used as an aggregation to the BlockLayout. It aggregates Block Layout cells.
* The BlockLayoutRow has 2 rendering modes - scrollable and non scrollable.
*/
export class BlockLayoutRow extends sap.ui.core.Control {
/**
* Constructor for a new BlockLayoutRow.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some accentCell into the association {@link #getAccentCells accentCells}.
* @param {sap.ui.core.ID|sap.ui.layout.BlockLayoutCell} vAccentCell - the accentCells to add; if empty, nothing is inserted
* @returns {sap.ui.layout.BlockLayoutRow} Reference to this
in order to allow method chaining
*/
public addAccentCell(vAccentCell: sap.ui.core.ID|sap.ui.layout.BlockLayoutCell): sap.ui.layout.BlockLayoutRow;
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.layout.BlockLayoutCell} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.layout.BlockLayoutRow} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.layout.BlockLayoutCell): sap.ui.layout.BlockLayoutRow;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.layout.BlockLayoutRow} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.layout.BlockLayoutRow;
/**
* Creates a new subclass of class sap.ui.layout.BlockLayoutRow with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAccentCells accentCells}.
* @returns {sap.ui.core.ID[]}
*/
public getAccentCells(): sap.ui.core.ID[];
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content cells to be included in the row.
* @returns {sap.ui.layout.BlockLayoutCell[]}
*/
public getContent(): sap.ui.layout.BlockLayoutCell[];
/**
* Returns a metadata object for class sap.ui.layout.BlockLayoutRow.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRowColorSet rowColorSet}.
*
* Defines background type for that row.
* There might be several rows with the same type
* @returns {sap.ui.layout.BlockRowColorSets} Value of property rowColorSet
*/
public getRowColorSet(): sap.ui.layout.BlockRowColorSets;
/**
* Gets current value of property {@link #getScrollable scrollable}.
*
* Sets the rendering mode of the BlockLayoutRow to scrollable. In scrollable mode, the cells get
* aligned side by side, with horizontal scroll bar for the row.
*
* Default value is false
.
* @returns {boolean} Value of property scrollable
*/
public getScrollable(): boolean;
/**
* Checks for the provided sap.ui.layout.BlockLayoutCell
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.layout.BlockLayoutCell} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.layout.BlockLayoutCell): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.layout.BlockLayoutCell} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.layout.BlockLayoutRow} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.layout.BlockLayoutCell, iIndex: number): sap.ui.layout.BlockLayoutRow;
/**
* Removes an accentCell from the association named {@link #getAccentCells accentCells}.
* @param {number|sap.ui.core.ID|sap.ui.layout.BlockLayoutCell} vAccentCell - The accentCell to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed accentCell or null
*/
public removeAccentCell(vAccentCell: number|sap.ui.core.ID|sap.ui.layout.BlockLayoutCell): sap.ui.core.ID;
/**
* Removes all the controls in the association named {@link #getAccentCells accentCells}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAccentCells(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.layout.BlockLayoutCell[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.layout.BlockLayoutCell[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.layout.BlockLayoutCell} vContent - The content to remove or its index or id
* @returns {sap.ui.layout.BlockLayoutCell} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.layout.BlockLayoutCell): sap.ui.layout.BlockLayoutCell;
/**
* Sets a new value for property {@link #getScrollable scrollable}.
*
* Sets the rendering mode of the BlockLayoutRow to scrollable. In scrollable mode, the cells get
* aligned side by side, with horizontal scroll bar for the row.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bScrollable - New value for property scrollable
* @returns {sap.ui.layout.BlockLayoutRow} Reference to this
in order to allow method chaining
*/
public setScrollable(bScrollable: boolean): sap.ui.layout.BlockLayoutRow;
}
/**
* A string type that is used inside the BlockLayoutRow to set predefined set of colors the cells inside
* the control. Color sets depend on sap.ui.layout.BlockBackgroundType
*/
export enum BlockRowColorSets {
/**
* sap.ui.layout.BlockBackgroundType.Default: N/A
* sap.ui.layout.BlockBackgroundType.Light: Color Set 1
* sap.ui.layout.BlockBackgroundType.Mixed: Color Set 1
* sap.ui.layout.BlockBackgroundType.Accent: Color Set 1
* sap.ui.layout.BlockBackgroundType.Dashboard: N/A
*/
ColorSet1 = "ColorSet1",
/**
* sap.ui.layout.BlockBackgroundType.Default: N/A
* sap.ui.layout.BlockBackgroundType.Light: Color Set 2
* sap.ui.layout.BlockBackgroundType.Mixed: Color Set 2
* sap.ui.layout.BlockBackgroundType.Accent: Color Set 2
* sap.ui.layout.BlockBackgroundType.Dashboard: N/A
*/
ColorSet2 = "ColorSet2",
/**
* sap.ui.layout.BlockBackgroundType.Default: N/A
* sap.ui.layout.BlockBackgroundType.Light: Color Set 1
* sap.ui.layout.BlockBackgroundType.Mixed: Color Set 1
* sap.ui.layout.BlockBackgroundType.Accent: Color Set 3
* sap.ui.layout.BlockBackgroundType.Dashboard: N/A
*/
ColorSet3 = "ColorSet3",
/**
* sap.ui.layout.BlockBackgroundType.Default: N/A
* sap.ui.layout.BlockBackgroundType.Light: Color Set 2
* sap.ui.layout.BlockBackgroundType.Mixed: Color Set 2
* sap.ui.layout.BlockBackgroundType.Accent: Color Set 4
* sap.ui.layout.BlockBackgroundType.Dashboard: N/A
*/
ColorSet4 = "ColorSet4",
}
/**
* Layout control that allows additional (side) content to be displayed dynamically.
*
* Overview
*
* DynamicSideContent
is a layout control that allows additional content
* to be displayed in a way that flexibly adapts to different screen sizes. The side
* content appears in a container next to or directly below the main content
* (it doesn't overlay). When the side content is triggered, the main content becomes
* narrower (if appearing side-by-side). The side content contains a separate scrollbar
* when appearing next to the main content.
*
* Usage
*
* When to use?
*
* Use this control if you want to display relevant information that is not critical
* for users to complete a task. Users should have access to all the key functions and
* critical information in the app even if they do not see the side content. This is
* important because on smaller screen sizes it may be difficult to display the side
* content in a way that is easily accessible for the user.
*
* When not to use?
*
* Don't use it if you want to display navigation or critical information that prevents
* users from completing a task when they have no access to the side content.
*
* Responsive Behavior
*
* Screen width > 1440 px
*
* - Main vs. side content ratio is 75 vs. 25 percent (with a minimum of 320px
* each).
* - If the application defines a trigger, the side content can be hidden.
*
* Screen width <= 1440 px and > 720px
*
* - Main vs. side content ratio is 66.666 vs. 33.333 percent (with a minimum of
* 320px each). If the side content width falls below 320 px, it automatically slides
* under the main content, unless the app development team specifies that it should
* disappear.
*
* Screen width <= 720 px (for example on a mobile device)
*
* - In this case, the side content automatically disappears from the screen (unless
* specified to stay under the content) and can be triggered from a pre-set trigger
* (specified within the app). When the side content is triggered, it replaces the
* main content. We recommend that you always place the trigger for the side content
* in the same location, such as in the app footer.
*
* A special case, allows for comparison mode between the main and side content. In
* this case, the screen is split into 50:50 percent for main vs. side content. The
* responsive behavior of the equal split is the same as in the standard view - the
* side content disappears on screen widths of less than 720 px and can only be
* viewed by triggering it.
*/
export class DynamicSideContent extends sap.ui.core.Control {
/**
* Constructor for a new DynamicSideContent
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds a control to the main content area.
* Only the main content part in the aggregation is re-rendered.
* @param {any} oControl - Object to be added in the aggregation
* @returns {sap.ui.layout.DynamicSideContent} this pointer for chaining
*/
public addMainContent(oControl: any): sap.ui.layout.DynamicSideContent;
/**
* Adds a control to the side content area.
* Only the side content part in the aggregation is re-rendered.
* @param {any} oControl - Object to be added in the aggregation
* @returns {sap.ui.layout.DynamicSideContent} this pointer for chaining
*/
public addSideContent(oControl: any): sap.ui.layout.DynamicSideContent;
/**
* Attaches event handler fnFunction
to the {@link #event:breakpointChanged breakpointChanged} event of this sap.ui.layout.DynamicSideContent
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.layout.DynamicSideContent
itself.
*
* Fires when the current breakpoint has been changed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.layout.DynamicSideContent
itself
* @returns {sap.ui.layout.DynamicSideContent} Reference to this
in order to allow method chaining
*/
public attachBreakpointChanged(fnFunction: Function, oListener?: any): sap.ui.layout.DynamicSideContent;
/**
* Attaches event handler fnFunction
to the {@link #event:breakpointChanged breakpointChanged} event of this sap.ui.layout.DynamicSideContent
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.layout.DynamicSideContent
itself.
*
* Fires when the current breakpoint has been changed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.layout.DynamicSideContent
itself
* @returns {sap.ui.layout.DynamicSideContent} Reference to this
in order to allow method chaining
*/
public attachBreakpointChanged(oData: any, fnFunction: Function, oListener?: any): sap.ui.layout.DynamicSideContent;
/**
* Destroys all the mainContent in the aggregation {@link #getMainContent mainContent}.
* @returns {sap.ui.layout.DynamicSideContent} Reference to this
in order to allow method chaining
*/
public destroyMainContent(): sap.ui.layout.DynamicSideContent;
/**
* Destroys all the sideContent in the aggregation {@link #getSideContent sideContent}.
* @returns {sap.ui.layout.DynamicSideContent} Reference to this
in order to allow method chaining
*/
public destroySideContent(): sap.ui.layout.DynamicSideContent;
/**
* Detaches event handler fnFunction
from the {@link #event:breakpointChanged breakpointChanged} event of this sap.ui.layout.DynamicSideContent
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.layout.DynamicSideContent} Reference to this
in order to allow method chaining
*/
public detachBreakpointChanged(fnFunction: Function, oListener: any): sap.ui.layout.DynamicSideContent;
/**
* Creates a new subclass of class sap.ui.layout.DynamicSideContent with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:breakpointChanged breakpointChanged} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.layout.DynamicSideContent} Reference to this
in order to allow method chaining
*/
protected fireBreakpointChanged(mParameters?: any): sap.ui.layout.DynamicSideContent;
/**
* Gets current value of property {@link #getContainerQuery containerQuery}.
*
* If set to TRUE, then not the media Query (device screen size) but the size of the container, surrounding the control, defines the current range.
*
* Default value is false
.
* @returns {boolean} Value of property containerQuery
*/
public getContainerQuery(): boolean;
/**
* Returns the breakpoint for the current state of the control.
* @returns {string} currentBreakpoint
*/
public getCurrentBreakpoint(): string;
/**
* Gets current value of property {@link #getEqualSplit equalSplit}.
*
* Defines whether the control is in equal split mode. In this mode, the side and the main content
* take 50:50 percent of the container on all screen sizes except for phone, where the main and
* side contents are switching visibility using the toggle method.
*
* Default value is false
.
* @returns {boolean} Value of property equalSplit
*/
public getEqualSplit(): boolean;
/**
* Gets content of aggregation {@link #getMainContent mainContent}.
*
* Main content controls.
* @returns {sap.ui.core.Control[]}
*/
public getMainContent(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.ui.layout.DynamicSideContent.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets the value of showMainContent property.
* @returns {boolean} Side content visibility state
*/
public getShowMainContent(): boolean;
/**
* Gets the value of showSideContent property.
* @returns {boolean} Side content visibility state
*/
public getShowSideContent(): boolean;
/**
* Gets content of aggregation {@link #getSideContent sideContent}.
*
* Side content controls.
* @returns {sap.ui.core.Control[]}
*/
public getSideContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getSideContentFallDown sideContentFallDown}.
*
* Determines on which breakpoints the side content falls down below the main content.
*
* Default value is OnMinimumWidth
.
* @returns {sap.ui.layout.SideContentFallDown} Value of property sideContentFallDown
*/
public getSideContentFallDown(): sap.ui.layout.SideContentFallDown;
/**
* Gets current value of property {@link #getSideContentPosition sideContentPosition}.
*
* Determines whether the side content is on the left or on the right side of the main content.
*
* Default value is End
.
* @returns {sap.ui.layout.SideContentPosition} Value of property sideContentPosition
*/
public getSideContentPosition(): sap.ui.layout.SideContentPosition;
/**
* Gets current value of property {@link #getSideContentVisibility sideContentVisibility}.
*
* Determines on which breakpoints the side content is visible.
*
* Default value is ShowAboveS
.
* @returns {sap.ui.layout.SideContentVisibility} Value of property sideContentVisibility
*/
public getSideContentVisibility(): sap.ui.layout.SideContentVisibility;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getMainContent mainContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oMainContent - The mainContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfMainContent(oMainContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getSideContent sideContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oSideContent - The sideContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSideContent(oSideContent: sap.ui.core.Control): number;
/**
* Inserts a mainContent into the aggregation {@link #getMainContent mainContent}.
* @param {sap.ui.core.Control} oMainContent - the mainContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the mainContent should be inserted at; for a negative value of iIndex
, the mainContent is inserted at position 0; for a value greater than the current size of the aggregation, the mainContent is inserted at the last position
* @returns {sap.ui.layout.DynamicSideContent} Reference to this
in order to allow method chaining
*/
public insertMainContent(oMainContent: sap.ui.core.Control, iIndex: number): sap.ui.layout.DynamicSideContent;
/**
* Inserts a sideContent into the aggregation {@link #getSideContent sideContent}.
* @param {sap.ui.core.Control} oSideContent - the sideContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the sideContent should be inserted at; for a negative value of iIndex
, the sideContent is inserted at position 0; for a value greater than the current size of the aggregation, the sideContent is inserted at the last position
* @returns {sap.ui.layout.DynamicSideContent} Reference to this
in order to allow method chaining
*/
public insertSideContent(oSideContent: sap.ui.core.Control, iIndex: number): sap.ui.layout.DynamicSideContent;
/**
* Removes all the controls from the aggregation {@link #getMainContent mainContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllMainContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getSideContent sideContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllSideContent(): sap.ui.core.Control[];
/**
* Removes a mainContent from the aggregation {@link #getMainContent mainContent}.
* @param {number|string|sap.ui.core.Control} vMainContent - The mainContent to remove or its index or id
* @returns {sap.ui.core.Control} The removed mainContent or null
*/
public removeMainContent(vMainContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a sideContent from the aggregation {@link #getSideContent sideContent}.
* @param {number|string|sap.ui.core.Control} vSideContent - The sideContent to remove or its index or id
* @returns {sap.ui.core.Control} The removed sideContent or null
*/
public removeSideContent(vSideContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getContainerQuery containerQuery}.
*
* If set to TRUE, then not the media Query (device screen size) but the size of the container, surrounding the control, defines the current range.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bContainerQuery - New value for property containerQuery
* @returns {sap.ui.layout.DynamicSideContent} Reference to this
in order to allow method chaining
*/
public setContainerQuery(bContainerQuery: boolean): sap.ui.layout.DynamicSideContent;
/**
* Sets or unsets the page in equalSplit mode.
* @param {boolean} bState - Determines if the page is set to equalSplit mode
* @returns {sap.ui.layout.DynamicSideContent} this pointer for chaining
*/
public setEqualSplit(bState?: boolean): sap.ui.layout.DynamicSideContent;
/**
* Sets the showMainContent property.
* @param {boolean} bVisible - Determines if the main content part is visible
* @param {boolean} bSuppressVisualUpdate - Determines if the visual state is updated
* @returns {sap.ui.layout.DynamicSideContent} this pointer for chaining
*/
public setShowMainContent(bVisible: boolean, bSuppressVisualUpdate: boolean): sap.ui.layout.DynamicSideContent;
/**
* Sets the showSideContent property.
* @param {boolean} bVisible - Determines if the side content part is visible
* @param {boolean} bSuppressVisualUpdate - Determines if the visual state is updated
* @returns {sap.ui.layout.DynamicSideContent} this pointer for chaining
*/
public setShowSideContent(bVisible: boolean, bSuppressVisualUpdate: boolean): sap.ui.layout.DynamicSideContent;
/**
* Sets a new value for property {@link #getSideContentFallDown sideContentFallDown}.
*
* Determines on which breakpoints the side content falls down below the main content.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is OnMinimumWidth
.
* @param {sap.ui.layout.SideContentFallDown} sSideContentFallDown - New value for property sideContentFallDown
* @returns {sap.ui.layout.DynamicSideContent} Reference to this
in order to allow method chaining
*/
public setSideContentFallDown(sSideContentFallDown: sap.ui.layout.SideContentFallDown): sap.ui.layout.DynamicSideContent;
/**
* Sets a new value for property {@link #getSideContentPosition sideContentPosition}.
*
* Determines whether the side content is on the left or on the right side of the main content.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is End
.
* @param {sap.ui.layout.SideContentPosition} sSideContentPosition - New value for property sideContentPosition
* @returns {sap.ui.layout.DynamicSideContent} Reference to this
in order to allow method chaining
*/
public setSideContentPosition(sSideContentPosition: sap.ui.layout.SideContentPosition): sap.ui.layout.DynamicSideContent;
/**
* Sets the sideContentVisibility property.
* @param {sap.ui.layout.SideContentVisibility} sVisibility - Determines on which breakpoints the side content is visible.
* @param {boolean} bSuppressVisualUpdate - Determines if the visual state is updated
* @returns {sap.ui.layout.DynamicSideContent} this pointer for chaining
*/
public setSideContentVisibility(sVisibility: sap.ui.layout.SideContentVisibility, bSuppressVisualUpdate: boolean): sap.ui.layout.DynamicSideContent;
/**
* Used for the toggle button functionality.
* When the control is on a phone screen size only, one control area is visible.
* This helper method is used to implement a button/switch for changing
* between the main and side content areas.
* Only works if the current breakpoint is "S".
* @returns {sap.ui.layout.DynamicSideContent} this pointer for chaining
*/
public toggle(): sap.ui.layout.DynamicSideContent;
}
/**
* A layout container with a fixed and a flexible part.
* Overview
* The FixFlex control builds the container for a layout with a fixed and a flexible part. The flexible container adapts its size to the fix container.
* Guidelines:
*
* - The fix container can hold any number of controls, while the flexible container can hold only one
* - In order for the FixFlex to stretch properly, the parent element, in which the control is placed, needs to have a specified height or needs to have an absolute position.
* - Avoid nesting FixFlex in other flexbox-based layout controls ({@link sap.ui.layout.FixFlex FixFlex}, {@link sap.m.FlexBox FlexBox}, Hbox, Vbox). Otherwise, contents may be not accessible or multiple scrollbars can appear.
*
* Structure
* The behavior of the FixFlex is controlled by the following properties:
*
* fixContentSize
- The width/height of the fix part of the control
* fixFirst
- The ordering of the fix and flex part
* minFlexSize
- Scrolling inside the flex part, if its contents are large
* vertical
- Alignment of the FixFlex control
*
* Responsive Behavior
*
* - If the child control of the flex or the fix container has width/height bigger than the container itself, the child control will be cropped in the view.
* - If minFlexSize is set, then a scrollbar is shown in the flexible part, depending on the
vertical
property.
*
*/
export class FixFlex extends sap.ui.core.Control {
/**
* Constructor for a new FixFlex.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some fixContent to the aggregation {@link #getFixContent fixContent}.
* @param {sap.ui.core.Control} oFixContent - the fixContent to add; if empty, nothing is inserted
* @returns {sap.ui.layout.FixFlex} Reference to this
in order to allow method chaining
*/
public addFixContent(oFixContent: sap.ui.core.Control): sap.ui.layout.FixFlex;
/**
* Destroys all the fixContent in the aggregation {@link #getFixContent fixContent}.
* @returns {sap.ui.layout.FixFlex} Reference to this
in order to allow method chaining
*/
public destroyFixContent(): sap.ui.layout.FixFlex;
/**
* Destroys the flexContent in the aggregation {@link #getFlexContent flexContent}.
* @returns {sap.ui.layout.FixFlex} Reference to this
in order to allow method chaining
*/
public destroyFlexContent(): sap.ui.layout.FixFlex;
/**
* Creates a new subclass of class sap.ui.layout.FixFlex with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getFixContent fixContent}.
*
* Controls in the fixed part of the layout.
* @returns {sap.ui.core.Control[]}
*/
public getFixContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getFixContentSize fixContentSize}.
*
* Determines the height (if the vertical property is "true") or the width (if the vertical property is "false") of the fixed area. If left at the default value "auto", the fixed-size area will be as large as its content. In this case the content cannot use percentage sizes.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property fixContentSize
*/
public getFixContentSize(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getFixFirst fixFirst}.
*
* Determines whether the fixed-size area should be on the beginning/top ( if the value is "true") or end/bottom ( if the value is "false").
*
* Default value is true
.
* @returns {boolean} Value of property fixFirst
*/
public getFixFirst(): boolean;
/**
* Gets content of aggregation {@link #getFlexContent flexContent}.
*
* Control in the stretching part of the layout.
* @returns {sap.ui.core.Control}
*/
public getFlexContent(): sap.ui.core.Control;
/**
* Returns a metadata object for class sap.ui.layout.FixFlex.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinFlexSize minFlexSize}.
*
* Enables scrolling inside the flexible part. The given size is calculated in "px". If the child control in the flexible part is larger then the available flexible size on the screen and if the available size for the flexible part is smaller or equal to the minFlexSize value, the scroll will be for the entire FixFlex control.
*
* Default value is 0
.
* @returns {number} Value of property minFlexSize
*/
public getMinFlexSize(): number;
/**
* Gets current value of property {@link #getVertical vertical}.
*
* Determines the direction of the layout of child elements. True for vertical and false for horizontal layout.
*
* Default value is true
.
* @returns {boolean} Value of property vertical
*/
public getVertical(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getFixContent fixContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oFixContent - The fixContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfFixContent(oFixContent: sap.ui.core.Control): number;
/**
* Inserts a fixContent into the aggregation {@link #getFixContent fixContent}.
* @param {sap.ui.core.Control} oFixContent - the fixContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the fixContent should be inserted at; for a negative value of iIndex
, the fixContent is inserted at position 0; for a value greater than the current size of the aggregation, the fixContent is inserted at the last position
* @returns {sap.ui.layout.FixFlex} Reference to this
in order to allow method chaining
*/
public insertFixContent(oFixContent: sap.ui.core.Control, iIndex: number): sap.ui.layout.FixFlex;
/**
* Removes all the controls from the aggregation {@link #getFixContent fixContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllFixContent(): sap.ui.core.Control[];
/**
* Removes a fixContent from the aggregation {@link #getFixContent fixContent}.
* @param {number|string|sap.ui.core.Control} vFixContent - The fixContent to remove or its index or id
* @returns {sap.ui.core.Control} The removed fixContent or null
*/
public removeFixContent(vFixContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getFixContentSize fixContentSize}.
*
* Determines the height (if the vertical property is "true") or the width (if the vertical property is "false") of the fixed area. If left at the default value "auto", the fixed-size area will be as large as its content. In this case the content cannot use percentage sizes.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.core.CSSSize} sFixContentSize - New value for property fixContentSize
* @returns {sap.ui.layout.FixFlex} Reference to this
in order to allow method chaining
*/
public setFixContentSize(sFixContentSize: sap.ui.core.CSSSize): sap.ui.layout.FixFlex;
/**
* Sets a new value for property {@link #getFixFirst fixFirst}.
*
* Determines whether the fixed-size area should be on the beginning/top ( if the value is "true") or end/bottom ( if the value is "false").
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bFixFirst - New value for property fixFirst
* @returns {sap.ui.layout.FixFlex} Reference to this
in order to allow method chaining
*/
public setFixFirst(bFixFirst: boolean): sap.ui.layout.FixFlex;
/**
* Sets the aggregated {@link #getFlexContent flexContent}.
* @param {sap.ui.core.Control} oFlexContent - The flexContent to set
* @returns {sap.ui.layout.FixFlex} Reference to this
in order to allow method chaining
*/
public setFlexContent(oFlexContent: sap.ui.core.Control): sap.ui.layout.FixFlex;
/**
* Sets a new value for property {@link #getMinFlexSize minFlexSize}.
*
* Enables scrolling inside the flexible part. The given size is calculated in "px". If the child control in the flexible part is larger then the available flexible size on the screen and if the available size for the flexible part is smaller or equal to the minFlexSize value, the scroll will be for the entire FixFlex control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iMinFlexSize - New value for property minFlexSize
* @returns {sap.ui.layout.FixFlex} Reference to this
in order to allow method chaining
*/
public setMinFlexSize(iMinFlexSize: number): sap.ui.layout.FixFlex;
/**
* Sets a new value for property {@link #getVertical vertical}.
*
* Determines the direction of the layout of child elements. True for vertical and false for horizontal layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVertical - New value for property vertical
* @returns {sap.ui.layout.FixFlex} Reference to this
in order to allow method chaining
*/
public setVertical(bVertical: boolean): sap.ui.layout.FixFlex;
}
/**
*/
namespace form {
/**
* A Form
control arranges labels and fields (like input fields) into groups and rows. There are different ways to visualize forms for different screen sizes.
*
* A Form
is structured into FormContainers
. Each FormContainer
consists of FormElements
.
* The FormElements
consists of a label and the form fields.
* A Form
doesn't render its content by itself. The rendering is done by the assigned FormLayout
.
* This is so that the rendering can be adopted to new UI requirements without changing the Form
itself.
*
* For the content of a Form
, VariantLayoutData
are supported to allow simple switching of the FormLayout
.
* LayoutData
on the content can be used to overwrite the default layout of the Form
.
*
* The Form
(and its sub-controls) automatically add label and field assignment to enable screen reader support.
* It also adds keyboard support to navigate between the fields and groups inside the form.
*
* Note: Do not put any layout controls into the FormElements
. This could destroy the visual layout,
* keyboard support and screen-reader support.
*/
export class Form extends sap.ui.core.Control {
/**
* Constructor for a new sap.ui.layout.form.Form.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.layout.form.Form} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.layout.form.Form;
/**
* Adds some formContainer to the aggregation {@link #getFormContainers formContainers}.
* @param {sap.ui.layout.form.FormContainer} oFormContainer - the formContainer to add; if empty, nothing is inserted
* @returns {sap.ui.layout.form.Form} Reference to this
in order to allow method chaining
*/
public addFormContainer(oFormContainer: sap.ui.layout.form.FormContainer): sap.ui.layout.form.Form;
/**
* Destroys all the formContainers in the aggregation {@link #getFormContainers formContainers}.
* @returns {sap.ui.layout.form.Form} Reference to this
in order to allow method chaining
*/
public destroyFormContainers(): sap.ui.layout.form.Form;
/**
* Destroys the layout in the aggregation {@link #getLayout layout}.
* @returns {sap.ui.layout.form.Form} Reference to this
in order to allow method chaining
*/
public destroyLayout(): sap.ui.layout.form.Form;
/**
* Destroys the title in the aggregation {@link #getTitle title}.
* @returns {sap.ui.layout.form.Form} Reference to this
in order to allow method chaining
*/
public destroyTitle(): sap.ui.layout.form.Form;
/**
* Destroys the toolbar in the aggregation {@link #getToolbar toolbar}.
* @returns {sap.ui.layout.form.Form} Reference to this
in order to allow method chaining
*/
public destroyToolbar(): sap.ui.layout.form.Form;
/**
* Creates a new subclass of class sap.ui.layout.form.Form with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEditable editable}.
*
* Applies a device-specific and theme-specific line-height to the form rows if the form has editable content.
* If set, all (not only the editable) rows of the form will get the line height of editable fields.
*
* The accessibility aria-readonly
attribute is set according to this property.
*
* Note: The setting of the property has no influence on the editable functionality of the form's content.
*
* Default value is false
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets content of aggregation {@link #getFormContainers formContainers}.
*
* Containers with the content of the form. A FormContainer
represents a group inside the Form
.
* @returns {sap.ui.layout.form.FormContainer[]}
*/
public getFormContainers(): sap.ui.layout.form.FormContainer[];
/**
* Gets content of aggregation {@link #getLayout layout}.
*
* Layout of the Form
. The assigned Layout
renders the Form
.
* We recommend using the ResponsiveGridLayout
for rendering a Form
,
* as its responsiveness allows the available space to be used in the best way possible.
* @returns {sap.ui.layout.form.FormLayout}
*/
public getLayout(): sap.ui.layout.form.FormLayout;
/**
* Returns a metadata object for class sap.ui.layout.form.Form.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getTitle title}.
*
* Title of the Form
. Can either be a Title
element or a string.
* If a Title
element it used, the style of the title can be set.
*
* Note: If a Toolbar
is used, the Title
is ignored.
* @returns {sap.ui.core.Title|string}
*/
public getTitle(): sap.ui.core.Title|string;
/**
* Gets content of aggregation {@link #getToolbar toolbar}.
*
* Toolbar of the Form
.
*
* Note: If a Toolbar
is used, the Title
is ignored.
* If a title is needed inside the Toolbar
it must be added at content to the Toolbar
.
* In this case add the Title
to the ariaLabelledBy
association.
* @returns {sap.ui.core.Toolbar}
*/
public getToolbar(): sap.ui.core.Toolbar;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the Form
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.layout.form.FormContainer
in the aggregation {@link #getFormContainers formContainers}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.layout.form.FormContainer} oFormContainer - The formContainer whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfFormContainer(oFormContainer: sap.ui.layout.form.FormContainer): number;
/**
* Inserts a formContainer into the aggregation {@link #getFormContainers formContainers}.
* @param {sap.ui.layout.form.FormContainer} oFormContainer - the formContainer to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the formContainer should be inserted at; for a negative value of iIndex
, the formContainer is inserted at position 0; for a value greater than the current size of the aggregation, the formContainer is inserted at the last position
* @returns {sap.ui.layout.form.Form} Reference to this
in order to allow method chaining
*/
public insertFormContainer(oFormContainer: sap.ui.layout.form.FormContainer, iIndex: number): sap.ui.layout.form.Form;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getFormContainers formContainers}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.layout.form.FormContainer[]} An array of the removed elements (might be empty)
*/
public removeAllFormContainers(): sap.ui.layout.form.FormContainer[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a formContainer from the aggregation {@link #getFormContainers formContainers}.
* @param {number|string|sap.ui.layout.form.FormContainer} vFormContainer - The formContainer to remove or its index or id
* @returns {sap.ui.layout.form.FormContainer} The removed formContainer or null
*/
public removeFormContainer(vFormContainer: number|string|sap.ui.layout.form.FormContainer): sap.ui.layout.form.FormContainer;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Applies a device-specific and theme-specific line-height to the form rows if the form has editable content.
* If set, all (not only the editable) rows of the form will get the line height of editable fields.
*
* The accessibility aria-readonly
attribute is set according to this property.
*
* Note: The setting of the property has no influence on the editable functionality of the form's content.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.ui.layout.form.Form} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.ui.layout.form.Form;
/**
* Sets the aggregated {@link #getLayout layout}.
* @param {sap.ui.layout.form.FormLayout} oLayout - The layout to set
* @returns {sap.ui.layout.form.Form} Reference to this
in order to allow method chaining
*/
public setLayout(oLayout: sap.ui.layout.form.FormLayout): sap.ui.layout.form.Form;
/**
* Sets the aggregated {@link #getTitle title}.
* @param {sap.ui.core.Title|string} vTitle - The title to set
* @returns {sap.ui.layout.form.Form} Reference to this
in order to allow method chaining
*/
public setTitle(vTitle: sap.ui.core.Title|string): sap.ui.layout.form.Form;
/**
* Sets the aggregated {@link #getToolbar toolbar}.
* @param {sap.ui.core.Toolbar} oToolbar - The toolbar to set
* @returns {sap.ui.layout.form.Form} Reference to this
in order to allow method chaining
*/
public setToolbar(oToolbar: sap.ui.core.Toolbar): sap.ui.layout.form.Form;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of the Form
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.layout.form.Form} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.layout.form.Form;
}
/**
* A FormContainer
represents a group inside a Form
. It consists of FormElements
.
* The rendering of the FormContainer
is done by the FormLayout
assigned to the Form
.
*/
export class FormContainer extends sap.ui.core.Element {
/**
* Constructor for a new sap.ui.layout.form.FormContainer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.layout.form.FormContainer} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.layout.form.FormContainer;
/**
* Adds some formElement to the aggregation {@link #getFormElements formElements}.
* @param {sap.ui.layout.form.FormElement} oFormElement - the formElement to add; if empty, nothing is inserted
* @returns {sap.ui.layout.form.FormContainer} Reference to this
in order to allow method chaining
*/
public addFormElement(oFormElement: sap.ui.layout.form.FormElement): sap.ui.layout.form.FormContainer;
/**
* Destroys all the formElements in the aggregation {@link #getFormElements formElements}.
* @returns {sap.ui.layout.form.FormContainer} Reference to this
in order to allow method chaining
*/
public destroyFormElements(): sap.ui.layout.form.FormContainer;
/**
* Destroys the title in the aggregation {@link #getTitle title}.
* @returns {sap.ui.layout.form.FormContainer} Reference to this
in order to allow method chaining
*/
public destroyTitle(): sap.ui.layout.form.FormContainer;
/**
* Destroys the toolbar in the aggregation {@link #getToolbar toolbar}.
* @returns {sap.ui.layout.form.FormContainer} Reference to this
in order to allow method chaining
*/
public destroyToolbar(): sap.ui.layout.form.FormContainer;
/**
* Creates a new subclass of class sap.ui.layout.form.FormContainer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getExpandable expandable}.
*
* Defines if the FormContainer
is expandable.
*
* Note: The expander icon will only be shown if a title
is set for the FormContainer
.
*
* Default value is false
.
* @returns {boolean} Value of property expandable
*/
public getExpandable(): boolean;
/**
* Gets current value of property {@link #getExpanded expanded}.
*
* Container is expanded.
*
* Note: This property only works if expandable
is set to true
.
*
* Default value is true
.
* @returns {boolean} Value of property expanded
*/
public getExpanded(): boolean;
/**
* Gets content of aggregation {@link #getFormElements formElements}.
*
* The FormElements
contain the content (labels and fields) of the FormContainers
.
* @returns {sap.ui.layout.form.FormElement[]}
*/
public getFormElements(): sap.ui.layout.form.FormElement[];
/**
* Returns a metadata object for class sap.ui.layout.form.FormContainer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getTitle title}.
*
* Title of the FormContainer
. Can either be a Title
element or a string.
* If a Title
element is used, the style of the title can be set.
*
* Note: If a Toolbar
is used, the Title
is ignored.
* @returns {sap.ui.core.Title|string}
*/
public getTitle(): sap.ui.core.Title|string;
/**
* Gets content of aggregation {@link #getToolbar toolbar}.
*
* Toolbar of the FormContainer
.
*
* Note: If a Toolbar
is used, the Title
is ignored.
* If a title is needed inside the Toolbar
it must be added at content to the Toolbar
.
* In this case add the Title
to the ariaLabelledBy
association.
* @returns {sap.ui.core.Toolbar}
*/
public getToolbar(): sap.ui.core.Toolbar;
/**
* Gets current value of property {@link #getVisible visible}.
*
* If set to false
, the FormContainer
is not rendered.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Checks for the provided sap.ui.layout.form.FormElement
in the aggregation {@link #getFormElements formElements}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.layout.form.FormElement} oFormElement - The formElement whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfFormElement(oFormElement: sap.ui.layout.form.FormElement): number;
/**
* Inserts a formElement into the aggregation {@link #getFormElements formElements}.
* @param {sap.ui.layout.form.FormElement} oFormElement - the formElement to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the formElement should be inserted at; for a negative value of iIndex
, the formElement is inserted at position 0; for a value greater than the current size of the aggregation, the formElement is inserted at the last position
* @returns {sap.ui.layout.form.FormContainer} Reference to this
in order to allow method chaining
*/
public insertFormElement(oFormElement: sap.ui.layout.form.FormElement, iIndex: number): sap.ui.layout.form.FormContainer;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getFormElements formElements}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.layout.form.FormElement[]} An array of the removed elements (might be empty)
*/
public removeAllFormElements(): sap.ui.layout.form.FormElement[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a formElement from the aggregation {@link #getFormElements formElements}.
* @param {number|string|sap.ui.layout.form.FormElement} vFormElement - The formElement to remove or its index or id
* @returns {sap.ui.layout.form.FormElement} The removed formElement or null
*/
public removeFormElement(vFormElement: number|string|sap.ui.layout.form.FormElement): sap.ui.layout.form.FormElement;
/**
* Sets a new value for property {@link #getExpandable expandable}.
*
* Defines if the FormContainer
is expandable.
*
* Note: The expander icon will only be shown if a title
is set for the FormContainer
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bExpandable - New value for property expandable
* @returns {sap.ui.layout.form.FormContainer} Reference to this
in order to allow method chaining
*/
public setExpandable(bExpandable: boolean): sap.ui.layout.form.FormContainer;
/**
* Sets a new value for property {@link #getExpanded expanded}.
*
* Container is expanded.
*
* Note: This property only works if expandable
is set to true
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bExpanded - New value for property expanded
* @returns {sap.ui.layout.form.FormContainer} Reference to this
in order to allow method chaining
*/
public setExpanded(bExpanded: boolean): sap.ui.layout.form.FormContainer;
/**
* Sets the aggregated {@link #getTitle title}.
* @param {sap.ui.core.Title|string} vTitle - The title to set
* @returns {sap.ui.layout.form.FormContainer} Reference to this
in order to allow method chaining
*/
public setTitle(vTitle: sap.ui.core.Title|string): sap.ui.layout.form.FormContainer;
/**
* Sets the aggregated {@link #getToolbar toolbar}.
* @param {sap.ui.core.Toolbar} oToolbar - The toolbar to set
* @returns {sap.ui.layout.form.FormContainer} Reference to this
in order to allow method chaining
*/
public setToolbar(oToolbar: sap.ui.core.Toolbar): sap.ui.layout.form.FormContainer;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* If set to false
, the FormContainer
is not rendered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.ui.layout.form.FormContainer} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.layout.form.FormContainer;
}
/**
* A FormElement
represents a row in a FormContainer
.
* A FormElement
is a combination of one label and different controls associated to this label.
*/
export class FormElement extends sap.ui.core.Element {
/**
* Constructor for a new sap.ui.layout.form.FormElement.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some field to the aggregation {@link #getFields fields}.
* @param {sap.ui.core.Control} oField - the field to add; if empty, nothing is inserted
* @returns {sap.ui.layout.form.FormElement} Reference to this
in order to allow method chaining
*/
public addField(oField: sap.ui.core.Control): sap.ui.layout.form.FormElement;
/**
* Destroys all the fields in the aggregation {@link #getFields fields}.
* @returns {sap.ui.layout.form.FormElement} Reference to this
in order to allow method chaining
*/
public destroyFields(): sap.ui.layout.form.FormElement;
/**
* Destroys the label in the aggregation {@link #getLabel label}.
* @returns {sap.ui.layout.form.FormElement} Reference to this
in order to allow method chaining
*/
public destroyLabel(): sap.ui.layout.form.FormElement;
/**
* Creates a new subclass of class sap.ui.layout.form.FormElement with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getFields fields}.
*
* Formular controls that belong together to be displayed in one row of a Form
.
*
* Note: Do not put any layout controls in here. This could destroy the visual layout,
* keyboard support and screen-reader support.
* @returns {sap.ui.core.Control[]}
*/
public getFields(): sap.ui.core.Control[];
/**
* Gets content of aggregation {@link #getLabel label}.
*
* Label of the fields. Can either be a Label
control or a string.
* If a Label
control is used, the properties of the Label
can be set.
* If no assignment between Label
and the fields is set via (labelFor
property of the Label
), it will be done automatically by the
* FormElement
. In this case the Label
is assigned to the fields of the FormElement
.
* @returns {sap.ui.core.Label|string}
*/
public getLabel(): sap.ui.core.Label|string;
/**
* Returns the Label
of the FormElement
, even if the Label
is assigned as string.
* The FormLayout
needs the information of the label to render the Form
.
* @returns {sap.ui.core.Label} Label
control used to render the label
*/
public getLabelControl(): sap.ui.core.Label;
/**
* Returns a metadata object for class sap.ui.layout.form.FormElement.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getVisible visible}.
*
* If set to false
, the FormElement
is not rendered.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getFields fields}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oField - The field whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfField(oField: sap.ui.core.Control): number;
/**
* Inserts a field into the aggregation {@link #getFields fields}.
* @param {sap.ui.core.Control} oField - the field to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the field should be inserted at; for a negative value of iIndex
, the field is inserted at position 0; for a value greater than the current size of the aggregation, the field is inserted at the last position
* @returns {sap.ui.layout.form.FormElement} Reference to this
in order to allow method chaining
*/
public insertField(oField: sap.ui.core.Control, iIndex: number): sap.ui.layout.form.FormElement;
/**
* Removes all the controls from the aggregation {@link #getFields fields}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllFields(): sap.ui.core.Control[];
/**
* Removes a field from the aggregation {@link #getFields fields}.
* @param {number|string|sap.ui.core.Control} vField - The field to remove or its index or id
* @returns {sap.ui.core.Control} The removed field or null
*/
public removeField(vField: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets the aggregated {@link #getLabel label}.
* @param {sap.ui.core.Label|string} vLabel - The label to set
* @returns {sap.ui.layout.form.FormElement} Reference to this
in order to allow method chaining
*/
public setLabel(vLabel: sap.ui.core.Label|string): sap.ui.layout.form.FormElement;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* If set to false
, the FormElement
is not rendered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.ui.layout.form.FormElement} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.layout.form.FormElement;
}
/**
* Base layout to render a Form
.
* Other layouts to render a Form
must inherit from this one.
*
* Note: This control must not be used to render a Form
in productive applications as it does not fulfill any
* design guidelines and usability standards.
*/
export class FormLayout extends sap.ui.core.Control {
/**
* Constructor for a new sap.ui.layout.form.FormLayout.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.layout.form.FormLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getBackgroundDesign backgroundDesign}.
*
* Specifies the background color of the Form
content.
*
* Note: The visualization of the different options depends on the theme used.
*
* Default value is Translucent
.
* @returns {sap.ui.layout.BackgroundDesign} Value of property backgroundDesign
*/
public getBackgroundDesign(): sap.ui.layout.BackgroundDesign;
/**
* Returns a metadata object for class sap.ui.layout.form.FormLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
*
* Specifies the background color of the Form
content.
*
* Note: The visualization of the different options depends on the theme used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Translucent
.
* @param {sap.ui.layout.BackgroundDesign} sBackgroundDesign - New value for property backgroundDesign
* @returns {sap.ui.layout.form.FormLayout} Reference to this
in order to allow method chaining
*/
public setBackgroundDesign(sBackgroundDesign: sap.ui.layout.BackgroundDesign): sap.ui.layout.form.FormLayout;
}
/**
* The GridLayout
-specific layout data for FormContainers
.
*/
export class GridContainerData extends sap.ui.core.LayoutData {
/**
* Constructor for a new sap.ui.layout.form.GridContainerData.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.layout.form.GridContainerData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.LayoutData.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getHalfGrid halfGrid}.
*
* If set, the container takes half the width of the Form
(8 cells), if not it takes the full width (16 cells).
* If the GridLayout
is set to singleColumn
, the full width of the grid is only 8 cells. So containers are rendered only once per row.
*
* Default value is false
.
* @returns {boolean} Value of property halfGrid
*/
public getHalfGrid(): boolean;
/**
* Returns a metadata object for class sap.ui.layout.form.GridContainerData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets a new value for property {@link #getHalfGrid halfGrid}.
*
* If set, the container takes half the width of the Form
(8 cells), if not it takes the full width (16 cells).
* If the GridLayout
is set to singleColumn
, the full width of the grid is only 8 cells. So containers are rendered only once per row.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bHalfGrid - New value for property halfGrid
* @returns {sap.ui.layout.form.GridContainerData} Reference to this
in order to allow method chaining
*/
public setHalfGrid(bHalfGrid: boolean): sap.ui.layout.form.GridContainerData;
}
/**
* A string that defines the number of used cells in a GridLayout
. This can be a number from 1 to 16, "auto" or "full".
* If set to "auto" the size is determined by the number of fields and the available cells. For labels the auto size is 3 cells.
* If set to "full" only one field is allowed within the FormElement
. It gets the full width of the row and the label is displayed above. Note: For labels full size has no effect.
*/
export type GridElementCells = string;
/**
* The GridLayout
-specific layout data for FormElement
fields.
*/
export class GridElementData extends sap.ui.core.LayoutData {
/**
* Constructor for a new sap.ui.layout.form.GridElementData.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.layout.form.GridElementData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.LayoutData.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getHCells hCells}.
*
* Number of cells in horizontal direction.
*
* If set to auto
, the size is determined by the number of fields and the available cells. For labels the auto size is 3 cells.
*
* If set to full
, only one field is allowed within the FormElement
. It gets the full width of the row and the label is displayed above.
*
* Note: For labels, the full size setting has no effect.
*
* Default value is auto
.
* @returns {sap.ui.layout.form.GridElementCells} Value of property hCells
*/
public getHCells(): sap.ui.layout.form.GridElementCells;
/**
* Returns a metadata object for class sap.ui.layout.form.GridElementData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getVCells vCells}.
*
* Number of cells in vertical direction.
*
* Note: This property has no effect on labels.
*
* Default value is 1
.
* @returns {number} Value of property vCells
*/
public getVCells(): number;
/**
* Sets a new value for property {@link #getHCells hCells}.
*
* Number of cells in horizontal direction.
*
* If set to auto
, the size is determined by the number of fields and the available cells. For labels the auto size is 3 cells.
*
* If set to full
, only one field is allowed within the FormElement
. It gets the full width of the row and the label is displayed above.
*
* Note: For labels, the full size setting has no effect.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.layout.form.GridElementCells} sHCells - New value for property hCells
* @returns {sap.ui.layout.form.GridElementData} Reference to this
in order to allow method chaining
*/
public setHCells(sHCells: sap.ui.layout.form.GridElementCells): sap.ui.layout.form.GridElementData;
/**
* Sets a new value for property {@link #getVCells vCells}.
*
* Number of cells in vertical direction.
*
* Note: This property has no effect on labels.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} iVCells - New value for property vCells
* @returns {sap.ui.layout.form.GridElementData} Reference to this
in order to allow method chaining
*/
public setVCells(iVCells: number): sap.ui.layout.form.GridElementData;
}
/**
* This FormLayout
renders a Form
using an HTML-table based grid.
* This can be a 16 column grid or an 8 column grid. The grid is stable, so the alignment of the fields is the same for all screen sizes or widths of the Form
.
* Only the width of the single grid columns depends on the available width.
*
* To adjust the appearance inside the GridLayout
, you can use GridContainerData
for FormContainers
* and GridElementData
for content fields.
*
* Note: If content fields have a width
property this will be ignored, as the width of the controls is set by the grid cells.
*
* This control cannot be used stand-alone, it just renders a Form
, so it must be assigned to a Form
using the layout
aggregation.
*/
export class GridLayout extends sap.ui.layout.form.FormLayout {
/**
* Constructor for a new sap.ui.layout.form.GridLayout.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.layout.form.GridLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.form.FormLayout.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.layout.form.GridLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSingleColumn singleColumn}.
*
* If set, the grid renders only one FormContainer
per column. That means one FormContainer
is below the other. The whole grid has 8 cells per row.
*
* If not set, FormContainer
can use the full width of the grid or two FormContainers
can be placed beside each other. In this case the whole grid has 16 cells per row.
*
* Default value is false
.
* @returns {boolean} Value of property singleColumn
*/
public getSingleColumn(): boolean;
/**
* Sets a new value for property {@link #getSingleColumn singleColumn}.
*
* If set, the grid renders only one FormContainer
per column. That means one FormContainer
is below the other. The whole grid has 8 cells per row.
*
* If not set, FormContainer
can use the full width of the grid or two FormContainers
can be placed beside each other. In this case the whole grid has 16 cells per row.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSingleColumn - New value for property singleColumn
* @returns {sap.ui.layout.form.GridLayout} Reference to this
in order to allow method chaining
*/
public setSingleColumn(bSingleColumn: boolean): sap.ui.layout.form.GridLayout;
}
/**
* The ResponsiveGridLayout
control renders a Form
using a responsive grid. Internally the Grid
control is used for rendering.
* Using this layout, the Form
is rendered in a responsive way.
* Depending on the available space, the FormContainers
are rendered in one or different columns and the labels are rendered in the same row as the fields or above the fields.
* This behavior can be influenced by the properties of this layout control.
*
* On the FormContainers
, labels and content fields, GridData
can be used to change the default rendering.
* GridData
is not supported for FormElements
.
*
* Note: If GridData
is used, this may result in a much more complex layout than the default one.
* This means that in some cases, the calculation for the other content may not bring the expected result.
* In such cases, GridData
should be used for all content controls to disable the default behavior.
*
* This control cannot be used stand-alone, it just renders a Form
, so it must be assigned to a Form
using the layout
aggregation.
*/
export class ResponsiveGridLayout extends sap.ui.layout.form.FormLayout {
/**
* Constructor for a new sap.ui.layout.form.ResponsiveGridLayout
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.layout.form.ResponsiveGridLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.form.FormLayout.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAdjustLabelSpan adjustLabelSpan}.
*
* If set, the usage of labelSpanL
and labelSpanM
are dependent on the number of FormContainers
in one row.
* If only one FormContainer
is displayed in one row, labelSpanM
is used to define the size of the label.
* This is the same for medium and large Forms
.
* This is done to align the labels on forms where full-size FormContainers
and multiple-column rows are used in the same Form
* (because every FormContainer
has its own Grid
inside).
*
* If not set, the usage of labelSpanL
and labelSpanM
are dependent on the Form
size.
* The number of FormContainers
doesn't matter in this case.
*
* Default value is true
.
* @returns {boolean} Value of property adjustLabelSpan
*/
public getAdjustLabelSpan(): boolean;
/**
* Gets current value of property {@link #getBreakpointL breakpointL}.
*
* Breakpoint (in pixel) between Medium size and Large size.
*
* Default value is 1024
.
* @returns {number} Value of property breakpointL
*/
public getBreakpointL(): number;
/**
* Gets current value of property {@link #getBreakpointM breakpointM}.
*
* Breakpoint (in pixel) between Small size and Medium size.
*
* Default value is 600
.
* @returns {number} Value of property breakpointM
*/
public getBreakpointM(): number;
/**
* Gets current value of property {@link #getBreakpointXL breakpointXL}.
*
* Breakpoint (in pixel) between large size and extra large (XL) size.
*
* Default value is 1440
.
* @returns {number} Value of property breakpointXL
*/
public getBreakpointXL(): number;
/**
* Gets current value of property {@link #getColumnsL columnsL}.
*
* Number of columns for large size.
*
* The number of columns for large size must not be smaller than the number of columns for medium size.
*
* Default value is 2
.
* @returns {number} Value of property columnsL
*/
public getColumnsL(): number;
/**
* Gets current value of property {@link #getColumnsM columnsM}.
*
* Number of columns for medium size.
*
* Default value is 1
.
* @returns {number} Value of property columnsM
*/
public getColumnsM(): number;
/**
* Gets current value of property {@link #getColumnsXL columnsXL}.
*
* Number of columns for extra large size.
*
* The number of columns for extra large size must not be smaller than the number of columns for large size.
* Note: If the default value -1 is not overwritten with the meaningful one then the columnsL
value is used (from the backward compatibility reasons).
*
* Default value is -1
.
* @returns {number} Value of property columnsXL
*/
public getColumnsXL(): number;
/**
* Gets current value of property {@link #getEmptySpanL emptySpanL}.
*
* Number of grid cells that are empty at the end of each line on large size.
*
* Default value is 0
.
* @returns {number} Value of property emptySpanL
*/
public getEmptySpanL(): number;
/**
* Gets current value of property {@link #getEmptySpanM emptySpanM}.
*
* Number of grid cells that are empty at the end of each line on medium size.
*
* Default value is 0
.
* @returns {number} Value of property emptySpanM
*/
public getEmptySpanM(): number;
/**
* Gets current value of property {@link #getEmptySpanS emptySpanS}.
*
* Number of grid cells that are empty at the end of each line on small size.
*
* Default value is 0
.
* @returns {number} Value of property emptySpanS
*/
public getEmptySpanS(): number;
/**
* Gets current value of property {@link #getEmptySpanXL emptySpanXL}.
*
* Number of grid cells that are empty at the end of each line on extra large size.
*
* Note: If the default value -1 is not overwritten with the meaningful one then the emptySpanL
value is used.
*
* Default value is -1
.
* @returns {number} Value of property emptySpanXL
*/
public getEmptySpanXL(): number;
/**
* Gets current value of property {@link #getLabelSpanL labelSpanL}.
*
* Default span for labels in large size.
*
* Note: If adjustLabelSpanThis
is set, this property is only used if more than 1 FormContainer
is in one line. If only 1 FormContainer
is in the line, then the labelSpanM
value is used.
*
* Default value is 4
.
* @returns {number} Value of property labelSpanL
*/
public getLabelSpanL(): number;
/**
* Gets current value of property {@link #getLabelSpanM labelSpanM}.
*
* Default span for labels in medium size.
*
* Note: If adjustLabelSpanThis
is set this property is used for full-size FormContainers
. If more than one FormContainer
is in one line, labelSpanL
is used.
*
* Default value is 2
.
* @returns {number} Value of property labelSpanM
*/
public getLabelSpanM(): number;
/**
* Gets current value of property {@link #getLabelSpanS labelSpanS}.
*
* Default span for labels in small size.
*
* Default value is 12
.
* @returns {number} Value of property labelSpanS
*/
public getLabelSpanS(): number;
/**
* Gets current value of property {@link #getLabelSpanXL labelSpanXL}.
*
* Default span for labels in extra large size.
*
* Note: If the default value -1 is not overwritten with the meaningful one then the labelSpanL
value is used.
*
* Default value is -1
.
* @returns {number} Value of property labelSpanXL
*/
public getLabelSpanXL(): number;
/**
* Returns a metadata object for class sap.ui.layout.form.ResponsiveGridLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSingleContainerFullSize singleContainerFullSize}.
*
* If the Form
contains only one single FormContainer
and this property is set,
* the FormContainer
is displayed using the full size of the Form
.
* In this case the properties columnsXL
, columnsL
and columnsM
are ignored.
*
* In all other cases the FormContainer
is displayed in the size of one column.
*
* Default value is true
.
* @returns {boolean} Value of property singleContainerFullSize
*/
public getSingleContainerFullSize(): boolean;
/**
* Sets a new value for property {@link #getAdjustLabelSpan adjustLabelSpan}.
*
* If set, the usage of labelSpanL
and labelSpanM
are dependent on the number of FormContainers
in one row.
* If only one FormContainer
is displayed in one row, labelSpanM
is used to define the size of the label.
* This is the same for medium and large Forms
.
* This is done to align the labels on forms where full-size FormContainers
and multiple-column rows are used in the same Form
* (because every FormContainer
has its own Grid
inside).
*
* If not set, the usage of labelSpanL
and labelSpanM
are dependent on the Form
size.
* The number of FormContainers
doesn't matter in this case.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bAdjustLabelSpan - New value for property adjustLabelSpan
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setAdjustLabelSpan(bAdjustLabelSpan: boolean): sap.ui.layout.form.ResponsiveGridLayout;
/**
* Sets a new value for property {@link #getBreakpointL breakpointL}.
*
* Breakpoint (in pixel) between Medium size and Large size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1024
.
* @param {number} iBreakpointL - New value for property breakpointL
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setBreakpointL(iBreakpointL: number): sap.ui.layout.form.ResponsiveGridLayout;
/**
* Sets a new value for property {@link #getBreakpointM breakpointM}.
*
* Breakpoint (in pixel) between Small size and Medium size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 600
.
* @param {number} iBreakpointM - New value for property breakpointM
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setBreakpointM(iBreakpointM: number): sap.ui.layout.form.ResponsiveGridLayout;
/**
* Sets a new value for property {@link #getBreakpointXL breakpointXL}.
*
* Breakpoint (in pixel) between large size and extra large (XL) size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1440
.
* @param {number} iBreakpointXL - New value for property breakpointXL
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setBreakpointXL(iBreakpointXL: number): sap.ui.layout.form.ResponsiveGridLayout;
/**
* Sets a new value for property {@link #getColumnsL columnsL}.
*
* Number of columns for large size.
*
* The number of columns for large size must not be smaller than the number of columns for medium size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 2
.
* @param {number} iColumnsL - New value for property columnsL
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setColumnsL(iColumnsL: number): sap.ui.layout.form.ResponsiveGridLayout;
/**
* Sets a new value for property {@link #getColumnsM columnsM}.
*
* Number of columns for medium size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} iColumnsM - New value for property columnsM
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setColumnsM(iColumnsM: number): sap.ui.layout.form.ResponsiveGridLayout;
/**
* Sets a new value for property {@link #getColumnsXL columnsXL}.
*
* Number of columns for extra large size.
*
* The number of columns for extra large size must not be smaller than the number of columns for large size.
* Note: If the default value -1 is not overwritten with the meaningful one then the columnsL
value is used (from the backward compatibility reasons).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {number} iColumnsXL - New value for property columnsXL
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setColumnsXL(iColumnsXL: number): sap.ui.layout.form.ResponsiveGridLayout;
/**
* Sets a new value for property {@link #getEmptySpanL emptySpanL}.
*
* Number of grid cells that are empty at the end of each line on large size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iEmptySpanL - New value for property emptySpanL
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setEmptySpanL(iEmptySpanL: number): sap.ui.layout.form.ResponsiveGridLayout;
/**
* Sets a new value for property {@link #getEmptySpanM emptySpanM}.
*
* Number of grid cells that are empty at the end of each line on medium size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iEmptySpanM - New value for property emptySpanM
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setEmptySpanM(iEmptySpanM: number): sap.ui.layout.form.ResponsiveGridLayout;
/**
* Sets a new value for property {@link #getEmptySpanS emptySpanS}.
*
* Number of grid cells that are empty at the end of each line on small size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iEmptySpanS - New value for property emptySpanS
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setEmptySpanS(iEmptySpanS: number): sap.ui.layout.form.ResponsiveGridLayout;
/**
* Sets a new value for property {@link #getEmptySpanXL emptySpanXL}.
*
* Number of grid cells that are empty at the end of each line on extra large size.
*
* Note: If the default value -1 is not overwritten with the meaningful one then the emptySpanL
value is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {number} iEmptySpanXL - New value for property emptySpanXL
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setEmptySpanXL(iEmptySpanXL: number): sap.ui.layout.form.ResponsiveGridLayout;
/**
* Sets a new value for property {@link #getLabelSpanL labelSpanL}.
*
* Default span for labels in large size.
*
* Note: If adjustLabelSpanThis
is set, this property is only used if more than 1 FormContainer
is in one line. If only 1 FormContainer
is in the line, then the labelSpanM
value is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 4
.
* @param {number} iLabelSpanL - New value for property labelSpanL
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setLabelSpanL(iLabelSpanL: number): sap.ui.layout.form.ResponsiveGridLayout;
/**
* Sets a new value for property {@link #getLabelSpanM labelSpanM}.
*
* Default span for labels in medium size.
*
* Note: If adjustLabelSpanThis
is set this property is used for full-size FormContainers
. If more than one FormContainer
is in one line, labelSpanL
is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 2
.
* @param {number} iLabelSpanM - New value for property labelSpanM
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setLabelSpanM(iLabelSpanM: number): sap.ui.layout.form.ResponsiveGridLayout;
/**
* Sets a new value for property {@link #getLabelSpanS labelSpanS}.
*
* Default span for labels in small size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 12
.
* @param {number} iLabelSpanS - New value for property labelSpanS
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setLabelSpanS(iLabelSpanS: number): sap.ui.layout.form.ResponsiveGridLayout;
/**
* Sets a new value for property {@link #getLabelSpanXL labelSpanXL}.
*
* Default span for labels in extra large size.
*
* Note: If the default value -1 is not overwritten with the meaningful one then the labelSpanL
value is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {number} iLabelSpanXL - New value for property labelSpanXL
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setLabelSpanXL(iLabelSpanXL: number): sap.ui.layout.form.ResponsiveGridLayout;
/**
* Sets a new value for property {@link #getSingleContainerFullSize singleContainerFullSize}.
*
* If the Form
contains only one single FormContainer
and this property is set,
* the FormContainer
is displayed using the full size of the Form
.
* In this case the properties columnsXL
, columnsL
and columnsM
are ignored.
*
* In all other cases the FormContainer
is displayed in the size of one column.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bSingleContainerFullSize - New value for property singleContainerFullSize
* @returns {sap.ui.layout.form.ResponsiveGridLayout} Reference to this
in order to allow method chaining
*/
public setSingleContainerFullSize(bSingleContainerFullSize: boolean): sap.ui.layout.form.ResponsiveGridLayout;
}
/**
* The ResponsiveLayout
renders a Form
with a responsive layout. Internally the ResponsiveFlowLayout
is used.
* The responsiveness of this layout tries to best use the available space. This means that the order of the FormContainers
, labels and fields depends on the available space.
*
* On the FormContainers
, FormElements
, labels and content fields, ResponsiveFlowLayoutData
can be used to change the default rendering.
*
* We suggest using the ResponsiveGridLayout
instead of this layout because this is easier to consume and brings more stable responsive output.
*
* Note: If ResponsiveFlowLayoutData
are used this may result in a much more complex layout than the default one. This means that in some cases, the calculation for the other content may not bring the expected result.
* In such cases, ResponsiveFlowLayoutData
should be used for all content controls to disable the default behavior.
*
* This control cannot be used stand-alone, it just renders a Form
, so it must be assigned to a Form
using the layout
aggregation.
*/
export class ResponsiveLayout extends sap.ui.layout.form.FormLayout {
/**
* Constructor for a new sap.ui.layout.form.ResponsiveLayout.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.layout.form.ResponsiveLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.layout.form.FormLayout.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.layout.form.ResponsiveLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* The SimpleForm
provides an easy-to-use API to create simple forms.
* Inside a SimpleForm
, a Form
control is created along with its FormContainers
and FormElements
, but the complexity in the API is removed.
*
* - A new
Title
or Toolbar
starts a new group (FormContainer
) in the form.
* - A new
Label
starts a new row (FormElement
) in the form.
* - All other controls will be assigned to the row (
FormElement
) that started with the last label.
*
* Use LayoutData
to influence the layout for special cases in the Input/Display controls.
*
* Note: If a more complex form is needed, use Form
instead.
*/
export class SimpleForm extends sap.ui.core.Control {
/**
* Constructor for a new sap.ui.layout.form.SimpleForm.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.layout.form.SimpleForm;
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Element} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Element): sap.ui.layout.form.SimpleForm;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.layout.form.SimpleForm;
/**
* Destroys the title in the aggregation {@link #getTitle title}.
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public destroyTitle(): sap.ui.layout.form.SimpleForm;
/**
* Destroys the toolbar in the aggregation {@link #getToolbar toolbar}.
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public destroyToolbar(): sap.ui.layout.form.SimpleForm;
/**
* Creates a new subclass of class sap.ui.layout.form.SimpleForm with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAdjustLabelSpan adjustLabelSpan}.
*
* If set, the usage of labelSpanL
and labelSpanM
are dependent on the number of FormContainers
in one row.
* If only one FormContainer
is displayed in one row, labelSpanM
is used to define the size of the label.
* This is the same for medium and large Forms
.
* This is done to align the labels on forms where full-size FormContainers
and multiple-column rows are used in the same Form
* (because every FormContainer
has its own grid inside).
*
* If not set, the usage of labelSpanL
and labelSpanM
are dependent on the Form
size.
* The number of FormContainers
doesn't matter in this case.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* Default value is true
.
* @returns {boolean} Value of property adjustLabelSpan
*/
public getAdjustLabelSpan(): boolean;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getBackgroundDesign backgroundDesign}.
*
* Specifies the background color of the SimpleForm
content.
*
* The visualization of the different options depends on the used theme.
*
* Default value is Translucent
.
* @returns {sap.ui.layout.BackgroundDesign} Value of property backgroundDesign
*/
public getBackgroundDesign(): sap.ui.layout.BackgroundDesign;
/**
* Gets current value of property {@link #getBreakpointL breakpointL}.
*
* Breakpoint between Medium size and Large size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* Default value is 1024
.
* @returns {number} Value of property breakpointL
*/
public getBreakpointL(): number;
/**
* Gets current value of property {@link #getBreakpointM breakpointM}.
*
* Breakpoint between Small size and Medium size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* Default value is 600
.
* @returns {number} Value of property breakpointM
*/
public getBreakpointM(): number;
/**
* Gets current value of property {@link #getBreakpointXL breakpointXL}.
*
* Breakpoint between Medium size and Large size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* Default value is 1440
.
* @returns {number} Value of property breakpointXL
*/
public getBreakpointXL(): number;
/**
* Gets current value of property {@link #getColumnsL columnsL}.
*
* Form columns for large size.
* The number of columns for large size must not be smaller than the number of columns for medium size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* Default value is 2
.
* @returns {number} Value of property columnsL
*/
public getColumnsL(): number;
/**
* Gets current value of property {@link #getColumnsM columnsM}.
*
* Form columns for medium size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* Default value is 1
.
* @returns {number} Value of property columnsM
*/
public getColumnsM(): number;
/**
* Gets current value of property {@link #getColumnsXL columnsXL}.
*
* Form columns for extra large size.
* The number of columns for extra large size must not be smaller than the number of columns for large size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.If the default value -1 is not overwritten with the meaningful one then the columnsL
value is used (from the backward compatibility reasons).
*
* Default value is -1
.
* @returns {number} Value of property columnsXL
*/
public getColumnsXL(): number;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content of the form is structured in the following way:
*
* - Add a
Title
or Toolbar
control to start a new group (FormContainer
).
* - Add a
Label
control to start a new row (FormElement
).
* - Add controls as input fields, text fields or other as needed.
* - Use
LayoutData
to influence the layout for special cases in the single controls.
* For example, if a ResponsiveLayout
is used as a layout, the form content is weighted using weight 3 for the labels and weight 5 for the fields part. By default the label column is 192 pixels wide.
* If your input controls should influence their width, you can add sap.ui.layout.ResponsiveFlowLayoutData
to them via setLayoutData
method.
* Ensure that the sum of the weights in the ResponsiveFlowLayoutData
is not more than 5, as this is the total width of the input control part of each form row.
*
* Example for a row where the Input
weight 4 and the second Input
weight 1 (using ResponsiveLayout
):
*
* new sap.m.Label({text:"Label"});
* new sap.m.Input({value:"Weight 4", layoutData: new sap.ui.layout.ResponsiveFlowLayoutData({weight:4})}),
* new sap.m.Input({value:"Weight 1", layoutData: new sap.ui.layout.ResponsiveFlowLayoutData({weight:1})}),
*
*
* For example, if a ResponsiveGridLayout
is used as a layout, there are 12 cells in one row. Depending on the screen size the labels use the defined labelSpan
.
* The remaining cells are used for the fields (and emptySpan
if defined). The available cells are distributed to all fields in the row. If one field should use a fixed number of cells
* you can add sap.ui.layout.GridData
to them via setLayoutData
method.
* If there are additional fields in the row they will get the remaining cells.
*
* Example for a row with two Input
controls where one uses four cells on small screens, one cell on medium screens and 2 cells on larger screens (using ResponsiveGridLayout
):
*
* new sap.m.Label({text:"Label"});
* new sap.m.Input({value:"auto size"}),
* new sap.m.Input({value:"fix size", layoutData: new sap.ui.layout.GridData({span: "XL1 L1 M2 S4"})}),
*
*
* Note: Do not put any layout controls in here. This could destroy the visual layout,
* keyboard support and screen-reader support.
* @returns {sap.ui.core.Element[]}
*/
public getContent(): sap.ui.core.Element[];
/**
* Gets current value of property {@link #getEditable editable}.
*
* Applies a device-specific and theme-specific line-height to the form rows if the form has editable content.
* If set, all (not only the editable) rows of the form will get the line height of editable fields.
*
* The accessibility aria-readonly
attribute is set according to this property.
*
* Note: The setting of the property has no influence on the editable functionality of the form's content.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEmptySpanL emptySpanL}.
*
* Number of grid cells that are empty at the end of each line on large size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* Default value is 0
.
* @returns {number} Value of property emptySpanL
*/
public getEmptySpanL(): number;
/**
* Gets current value of property {@link #getEmptySpanM emptySpanM}.
*
* Number of grid cells that are empty at the end of each line on medium size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* Default value is 0
.
* @returns {number} Value of property emptySpanM
*/
public getEmptySpanM(): number;
/**
* Gets current value of property {@link #getEmptySpanS emptySpanS}.
*
* Number of grid cells that are empty at the end of each line on small size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* Default value is 0
.
* @returns {number} Value of property emptySpanS
*/
public getEmptySpanS(): number;
/**
* Gets current value of property {@link #getEmptySpanXL emptySpanXL}.
*
* Number of grid cells that are empty at the end of each line on extra large size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout. If the default value -1 is not overwritten with the meaningful one then the emptySpanL
value is used (from the backward compatibility reasons).
*
* Default value is -1
.
* @returns {number} Value of property emptySpanXL
*/
public getEmptySpanXL(): number;
/**
* Gets current value of property {@link #getLabelMinWidth labelMinWidth}.
*
* Specifies the min-width in pixels of the label in all form rows.
*
* Note: This property is only used if a ResponsiveLayout
is used as a layout.
*
* Default value is 192
.
* @returns {number} Value of property labelMinWidth
*/
public getLabelMinWidth(): number;
/**
* Gets current value of property {@link #getLabelSpanL labelSpanL}.
*
* Default span for labels in large size.
*
* Note: If adjustLabelSpanThis
is set, this property is only used if more than 1 FormContainer
is in one line. If only 1 FormContainer
is in the line, then the labelSpanM
value is used.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* Default value is 4
.
* @returns {number} Value of property labelSpanL
*/
public getLabelSpanL(): number;
/**
* Gets current value of property {@link #getLabelSpanM labelSpanM}.
*
* Default span for labels in medium size.
*
* Note: If adjustLabelSpanThis
is set, this property is used for full-size FormContainers
. If more than one FormContainer
is in one line, labelSpanL
is used.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* Default value is 2
.
* @returns {number} Value of property labelSpanM
*/
public getLabelSpanM(): number;
/**
* Gets current value of property {@link #getLabelSpanS labelSpanS}.
*
* Default span for labels in small size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* Default value is 12
.
* @returns {number} Value of property labelSpanS
*/
public getLabelSpanS(): number;
/**
* Gets current value of property {@link #getLabelSpanXL labelSpanXL}.
*
* Default span for labels in extra large size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout. If the default value -1 is not overwritten with the meaningful one then the labelSpanL
value is used (from the backward compatibility reasons).
*
* Default value is -1
.
* @returns {number} Value of property labelSpanXL
*/
public getLabelSpanXL(): number;
/**
* Gets current value of property {@link #getLayout layout}.
*
* The FormLayout
that is used to render the SimpleForm
.
*
* We recommend using the ResponsiveGridLayout
for rendering a SimpleForm
, as its responsiveness uses the space available in the best way possible.
*
* Default value is ResponsiveLayout
.
* @returns {sap.ui.layout.form.SimpleFormLayout} Value of property layout
*/
public getLayout(): sap.ui.layout.form.SimpleFormLayout;
/**
* Gets current value of property {@link #getMaxContainerCols maxContainerCols}.
*
* The maximum amount of groups (FormContainers
) per row that is used before a new row is started.
*
* Note: If a ResponsiveGridLayout
is used as a layout
, this property is not used. Please use the properties ColumnsL
and ColumnsM
in this case.
*
* Default value is 2
.
* @returns {number} Value of property maxContainerCols
*/
public getMaxContainerCols(): number;
/**
* Returns a metadata object for class sap.ui.layout.form.SimpleForm.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinWidth minWidth}.
*
* The overall minimum width in pixels that is used for the SimpleForm
. If the available width is below the given minWidth
the SimpleForm
will create a new row for the next group (FormContainer
).
* The default value is -1, meaning that inner groups (FormContainers
) will be stacked until maxContainerCols
is reached, irrespective of whether a width
is reached or the available parents width is reached.
*
* Note: This property is only used if a ResponsiveLayout
is used as a layout.
*
* Default value is -1
.
* @returns {number} Value of property minWidth
*/
public getMinWidth(): number;
/**
* Gets current value of property {@link #getSingleContainerFullSize singleContainerFullSize}.
*
* If the Form
contains only one single FormContainer
and this property is set,
* the FormContainer
is displayed using the full size of the Form
.
* In this case the properties columnsL
and columnsM
are ignored.
*
* In all other cases the FormContainer
is displayed in the size of one column.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* Default value is true
.
* @returns {boolean} Value of property singleContainerFullSize
*/
public getSingleContainerFullSize(): boolean;
/**
* Gets content of aggregation {@link #getTitle title}.
*
* Title element of the SimpleForm
. Can either be a Title
element, or a string.
* @returns {sap.ui.core.Title|string}
*/
public getTitle(): sap.ui.core.Title|string;
/**
* Gets content of aggregation {@link #getToolbar toolbar}.
*
* Toolbar of the SimpleForm
.
*
* Note: If a Toolbar
is used, the Title
is ignored.
* If a title is needed inside the Toolbar
it must be added at content to the Toolbar
.
* In this case add the Title
to the ariaLabelledBy
association.
* @returns {sap.ui.core.Toolbar}
*/
public getToolbar(): sap.ui.core.Toolbar;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the form.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Element
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Element} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Element): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Element} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Element, iIndex: number): sap.ui.layout.form.SimpleForm;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Element[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Element[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Element} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Element} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Element): sap.ui.core.Element;
/**
* Sets a new value for property {@link #getAdjustLabelSpan adjustLabelSpan}.
*
* If set, the usage of labelSpanL
and labelSpanM
are dependent on the number of FormContainers
in one row.
* If only one FormContainer
is displayed in one row, labelSpanM
is used to define the size of the label.
* This is the same for medium and large Forms
.
* This is done to align the labels on forms where full-size FormContainers
and multiple-column rows are used in the same Form
* (because every FormContainer
has its own grid inside).
*
* If not set, the usage of labelSpanL
and labelSpanM
are dependent on the Form
size.
* The number of FormContainers
doesn't matter in this case.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bAdjustLabelSpan - New value for property adjustLabelSpan
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setAdjustLabelSpan(bAdjustLabelSpan: boolean): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
*
* Specifies the background color of the SimpleForm
content.
*
* The visualization of the different options depends on the used theme.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Translucent
.
* @param {sap.ui.layout.BackgroundDesign} sBackgroundDesign - New value for property backgroundDesign
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setBackgroundDesign(sBackgroundDesign: sap.ui.layout.BackgroundDesign): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getBreakpointL breakpointL}.
*
* Breakpoint between Medium size and Large size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1024
.
* @param {number} iBreakpointL - New value for property breakpointL
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setBreakpointL(iBreakpointL: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getBreakpointM breakpointM}.
*
* Breakpoint between Small size and Medium size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 600
.
* @param {number} iBreakpointM - New value for property breakpointM
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setBreakpointM(iBreakpointM: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getBreakpointXL breakpointXL}.
*
* Breakpoint between Medium size and Large size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1440
.
* @param {number} iBreakpointXL - New value for property breakpointXL
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setBreakpointXL(iBreakpointXL: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getColumnsL columnsL}.
*
* Form columns for large size.
* The number of columns for large size must not be smaller than the number of columns for medium size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 2
.
* @param {number} iColumnsL - New value for property columnsL
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setColumnsL(iColumnsL: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getColumnsM columnsM}.
*
* Form columns for medium size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} iColumnsM - New value for property columnsM
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setColumnsM(iColumnsM: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getColumnsXL columnsXL}.
*
* Form columns for extra large size.
* The number of columns for extra large size must not be smaller than the number of columns for large size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.If the default value -1 is not overwritten with the meaningful one then the columnsL
value is used (from the backward compatibility reasons).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {number} iColumnsXL - New value for property columnsXL
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setColumnsXL(iColumnsXL: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Applies a device-specific and theme-specific line-height to the form rows if the form has editable content.
* If set, all (not only the editable) rows of the form will get the line height of editable fields.
*
* The accessibility aria-readonly
attribute is set according to this property.
*
* Note: The setting of the property has no influence on the editable functionality of the form's content.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getEmptySpanL emptySpanL}.
*
* Number of grid cells that are empty at the end of each line on large size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iEmptySpanL - New value for property emptySpanL
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setEmptySpanL(iEmptySpanL: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getEmptySpanM emptySpanM}.
*
* Number of grid cells that are empty at the end of each line on medium size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iEmptySpanM - New value for property emptySpanM
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setEmptySpanM(iEmptySpanM: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getEmptySpanS emptySpanS}.
*
* Number of grid cells that are empty at the end of each line on small size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iEmptySpanS - New value for property emptySpanS
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setEmptySpanS(iEmptySpanS: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getEmptySpanXL emptySpanXL}.
*
* Number of grid cells that are empty at the end of each line on extra large size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout. If the default value -1 is not overwritten with the meaningful one then the emptySpanL
value is used (from the backward compatibility reasons).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {number} iEmptySpanXL - New value for property emptySpanXL
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setEmptySpanXL(iEmptySpanXL: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getLabelMinWidth labelMinWidth}.
*
* Specifies the min-width in pixels of the label in all form rows.
*
* Note: This property is only used if a ResponsiveLayout
is used as a layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 192
.
* @param {number} iLabelMinWidth - New value for property labelMinWidth
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setLabelMinWidth(iLabelMinWidth: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getLabelSpanL labelSpanL}.
*
* Default span for labels in large size.
*
* Note: If adjustLabelSpanThis
is set, this property is only used if more than 1 FormContainer
is in one line. If only 1 FormContainer
is in the line, then the labelSpanM
value is used.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 4
.
* @param {number} iLabelSpanL - New value for property labelSpanL
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setLabelSpanL(iLabelSpanL: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getLabelSpanM labelSpanM}.
*
* Default span for labels in medium size.
*
* Note: If adjustLabelSpanThis
is set, this property is used for full-size FormContainers
. If more than one FormContainer
is in one line, labelSpanL
is used.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 2
.
* @param {number} iLabelSpanM - New value for property labelSpanM
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setLabelSpanM(iLabelSpanM: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getLabelSpanS labelSpanS}.
*
* Default span for labels in small size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 12
.
* @param {number} iLabelSpanS - New value for property labelSpanS
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setLabelSpanS(iLabelSpanS: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getLabelSpanXL labelSpanXL}.
*
* Default span for labels in extra large size.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout. If the default value -1 is not overwritten with the meaningful one then the labelSpanL
value is used (from the backward compatibility reasons).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {number} iLabelSpanXL - New value for property labelSpanXL
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setLabelSpanXL(iLabelSpanXL: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getLayout layout}.
*
* The FormLayout
that is used to render the SimpleForm
.
*
* We recommend using the ResponsiveGridLayout
for rendering a SimpleForm
, as its responsiveness uses the space available in the best way possible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is ResponsiveLayout
.
* @param {sap.ui.layout.form.SimpleFormLayout} sLayout - New value for property layout
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setLayout(sLayout: sap.ui.layout.form.SimpleFormLayout): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getMaxContainerCols maxContainerCols}.
*
* The maximum amount of groups (FormContainers
) per row that is used before a new row is started.
*
* Note: If a ResponsiveGridLayout
is used as a layout
, this property is not used. Please use the properties ColumnsL
and ColumnsM
in this case.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 2
.
* @param {number} iMaxContainerCols - New value for property maxContainerCols
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setMaxContainerCols(iMaxContainerCols: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getMinWidth minWidth}.
*
* The overall minimum width in pixels that is used for the SimpleForm
. If the available width is below the given minWidth
the SimpleForm
will create a new row for the next group (FormContainer
).
* The default value is -1, meaning that inner groups (FormContainers
) will be stacked until maxContainerCols
is reached, irrespective of whether a width
is reached or the available parents width is reached.
*
* Note: This property is only used if a ResponsiveLayout
is used as a layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {number} iMinWidth - New value for property minWidth
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setMinWidth(iMinWidth: number): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getSingleContainerFullSize singleContainerFullSize}.
*
* If the Form
contains only one single FormContainer
and this property is set,
* the FormContainer
is displayed using the full size of the Form
.
* In this case the properties columnsL
and columnsM
are ignored.
*
* In all other cases the FormContainer
is displayed in the size of one column.
*
* Note: This property is only used if a ResponsiveGridLayout
is used as a layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bSingleContainerFullSize - New value for property singleContainerFullSize
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setSingleContainerFullSize(bSingleContainerFullSize: boolean): sap.ui.layout.form.SimpleForm;
/**
* Sets the aggregated {@link #getTitle title}.
* @param {sap.ui.core.Title|string} vTitle - The title to set
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setTitle(vTitle: sap.ui.core.Title|string): sap.ui.layout.form.SimpleForm;
/**
* Sets the aggregated {@link #getToolbar toolbar}.
* @param {sap.ui.core.Toolbar} oToolbar - The toolbar to set
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setToolbar(oToolbar: sap.ui.core.Toolbar): sap.ui.layout.form.SimpleForm;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of the form.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.layout.form.SimpleForm} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.layout.form.SimpleForm;
}
/**
* Available FormLayouts
used to render a SimpleForm
.
*/
export enum SimpleFormLayout {
/**
* Uses the GridLayout
to render the SimpleForm
*/
GridLayout = "GridLayout",
/**
* Uses the ResponsiveGridLayout
to render the SimpleForm
*/
ResponsiveGridLayout = "ResponsiveGridLayout",
/**
* Uses the ResponsiveLayout
to render the SimpleForm
*/
ResponsiveLayout = "ResponsiveLayout",
}
}
/**
* The Grid control is a layout which positions its child controls in a 12 column flow layout. Its children can be specified to take on a variable amount of columns depending on available screen size. With this control it is possible to achieve flexible layouts and line-breaks for extra large-, large-, medium- and small-sized screens, such as large desktop, desktop, tablet, and mobile. The Grid control's width can be percentage- or pixel-based and the spacing between its columns can be set to various pre-defined values.
*/
export class Grid extends sap.ui.core.Control {
/**
* Constructor for a new Grid.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.layout.Grid} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.layout.Grid;
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.layout.Grid} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.layout.Grid;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.layout.Grid} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.layout.Grid;
/**
* Creates a new subclass of class sap.ui.layout.Grid with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getContainerQuery containerQuery}.
*
* If true then not the media Query ( device screen size), but the size of the container surrounding the grid defines the current range (large, medium or small).
*
* Default value is false
.
* @returns {boolean} Value of property containerQuery
*/
public getContainerQuery(): boolean;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Controls that are placed into Grid layout.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getDefaultIndent defaultIndent}.
*
* Optional. Defines default for the whole Grid numbers of empty columns before the current span begins. It can be defined for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 0 to 11 that the container has to take, for example: "L2 M4 S6", "M11", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small.
*
* Default value is XL0 L0 M0 S0
.
* @returns {sap.ui.layout.GridIndent} Value of property defaultIndent
*/
public getDefaultIndent(): sap.ui.layout.GridIndent;
/**
* Gets current value of property {@link #getDefaultSpan defaultSpan}.
*
* Optional. A string type that represents Grid's default span values for large, medium and small screens for the whole Grid. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small.
*
* Default value is XL3 L3 M6 S12
.
* @returns {sap.ui.layout.GridSpan} Value of property defaultSpan
*/
public getDefaultSpan(): sap.ui.layout.GridSpan;
/**
* Gets current value of property {@link #getHSpacing hSpacing}.
*
* Optional. Horizontal spacing between the content in the Grid. In rem, allowed values are 0, 0.5 , 1 or 2.
*
* Default value is 1
.
* @returns {number} Value of property hSpacing
*/
public getHSpacing(): number;
/**
* Returns a metadata object for class sap.ui.layout.Grid.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPosition position}.
*
* Optional. Position of the Grid in the window or surrounding container. Possible values are "Center", "Left" and "Right".
*
* Default value is Left
.
* @returns {sap.ui.layout.GridPosition} Value of property position
*/
public getPosition(): sap.ui.layout.GridPosition;
/**
* Gets current value of property {@link #getVSpacing vSpacing}.
*
* Optional. Vertical spacing between the rows in the Grid. In rem, allowed values are 0, 0.5, 1 and 2.
*
* Default value is 1
.
* @returns {number} Value of property vSpacing
*/
public getVSpacing(): number;
/**
* Gets current value of property {@link #getWidth width}.
*
* Optional. Width of the Grid. If not specified, then 100%.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.layout.Grid} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.layout.Grid;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getContainerQuery containerQuery}.
*
* If true then not the media Query ( device screen size), but the size of the container surrounding the grid defines the current range (large, medium or small).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bContainerQuery - New value for property containerQuery
* @returns {sap.ui.layout.Grid} Reference to this
in order to allow method chaining
*/
public setContainerQuery(bContainerQuery: boolean): sap.ui.layout.Grid;
/**
* Sets a new value for property {@link #getDefaultIndent defaultIndent}.
*
* Optional. Defines default for the whole Grid numbers of empty columns before the current span begins. It can be defined for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 0 to 11 that the container has to take, for example: "L2 M4 S6", "M11", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is XL0 L0 M0 S0
.
* @param {sap.ui.layout.GridIndent} sDefaultIndent - New value for property defaultIndent
* @returns {sap.ui.layout.Grid} Reference to this
in order to allow method chaining
*/
public setDefaultIndent(sDefaultIndent: sap.ui.layout.GridIndent): sap.ui.layout.Grid;
/**
* Sets a new value for property {@link #getDefaultSpan defaultSpan}.
*
* Optional. A string type that represents Grid's default span values for large, medium and small screens for the whole Grid. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is XL3 L3 M6 S12
.
* @param {sap.ui.layout.GridSpan} sDefaultSpan - New value for property defaultSpan
* @returns {sap.ui.layout.Grid} Reference to this
in order to allow method chaining
*/
public setDefaultSpan(sDefaultSpan: sap.ui.layout.GridSpan): sap.ui.layout.Grid;
/**
* Sets a new value for property {@link #getHSpacing hSpacing}.
*
* Optional. Horizontal spacing between the content in the Grid. In rem, allowed values are 0, 0.5 , 1 or 2.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} fHSpacing - New value for property hSpacing
* @returns {sap.ui.layout.Grid} Reference to this
in order to allow method chaining
*/
public setHSpacing(fHSpacing: number): sap.ui.layout.Grid;
/**
* Sets a new value for property {@link #getPosition position}.
*
* Optional. Position of the Grid in the window or surrounding container. Possible values are "Center", "Left" and "Right".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Left
.
* @param {sap.ui.layout.GridPosition} sPosition - New value for property position
* @returns {sap.ui.layout.Grid} Reference to this
in order to allow method chaining
*/
public setPosition(sPosition: sap.ui.layout.GridPosition): sap.ui.layout.Grid;
/**
* Sets a new value for property {@link #getVSpacing vSpacing}.
*
* Optional. Vertical spacing between the rows in the Grid. In rem, allowed values are 0, 0.5, 1 and 2.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} fVSpacing - New value for property vSpacing
* @returns {sap.ui.layout.Grid} Reference to this
in order to allow method chaining
*/
public setVSpacing(fVSpacing: number): sap.ui.layout.Grid;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Optional. Width of the Grid. If not specified, then 100%.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.layout.Grid} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.layout.Grid;
}
/**
* Grid layout data
*/
export class GridData extends sap.ui.core.LayoutData {
/**
* Constructor for a new GridData.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.layout.GridData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.LayoutData.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getIndent indent}.
*
* A string type that represents Grid's span values for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small.
* @returns {sap.ui.layout.GridIndent} Value of property indent
*/
public getIndent(): sap.ui.layout.GridIndent;
/**
* Gets current value of property {@link #getIndentL indentL}.
*
* Optional. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "indent".
* @returns {number} Value of property indentL
*/
public getIndentL(): number;
/**
* Gets current value of property {@link #getIndentLarge indentLarge}.
*
* Deprecated. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "indent".
* @returns {number} Value of property indentLarge
*/
public getIndentLarge(): number;
/**
* Gets current value of property {@link #getIndentM indentM}.
*
* Optional. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "indent".
* @returns {number} Value of property indentM
*/
public getIndentM(): number;
/**
* Gets current value of property {@link #getIndentMedium indentMedium}.
*
* Deprecated. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "indent".
* @returns {number} Value of property indentMedium
*/
public getIndentMedium(): number;
/**
* Gets current value of property {@link #getIndentS indentS}.
*
* Optional. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "indent".
* @returns {number} Value of property indentS
*/
public getIndentS(): number;
/**
* Gets current value of property {@link #getIndentSmall indentSmall}.
*
* Deprecated. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "indent".
* @returns {number} Value of property indentSmall
*/
public getIndentSmall(): number;
/**
* Gets current value of property {@link #getIndentXL indentXL}.
*
* Optional. Defines a span value for extra large screens. This value overwrites the value for extra large screens defined in the parameter "indent".
* @returns {number} Value of property indentXL
*/
public getIndentXL(): number;
/**
* Gets current value of property {@link #getLinebreak linebreak}.
*
* Optional. If this property is set to true, the control on all-size screens causes a line break within the Grid and becomes the first within the next line.
*
* Default value is false
.
* @returns {boolean} Value of property linebreak
*/
public getLinebreak(): boolean;
/**
* Gets current value of property {@link #getLinebreakL linebreakL}.
*
* Optional. If this property is set to true, the control on large screens causes a line break within the Grid and becomes the first within the next line.
*
* Default value is false
.
* @returns {boolean} Value of property linebreakL
*/
public getLinebreakL(): boolean;
/**
* Gets current value of property {@link #getLinebreakM linebreakM}.
*
* Optional. If this property is set to true, the control on medium sized screens causes a line break within the Grid and becomes the first within the next line.
*
* Default value is false
.
* @returns {boolean} Value of property linebreakM
*/
public getLinebreakM(): boolean;
/**
* Gets current value of property {@link #getLinebreakS linebreakS}.
*
* Optional. If this property is set to true, the control on small screens causes a line break within the Grid and becomes the first within the next line.
*
* Default value is false
.
* @returns {boolean} Value of property linebreakS
*/
public getLinebreakS(): boolean;
/**
* Gets current value of property {@link #getLinebreakXL linebreakXL}.
*
* Optional. If this property is set to true, the control on extra large screens causes a line break within the Grid and becomes the first within the next line.
*
* Default value is false
.
* @returns {boolean} Value of property linebreakXL
*/
public getLinebreakXL(): boolean;
/**
* Returns a metadata object for class sap.ui.layout.GridData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMoveBackwards moveBackwards}.
*
* Optional. Moves a cell backwards so many columns as specified.
* @returns {sap.ui.layout.GridIndent} Value of property moveBackwards
*/
public getMoveBackwards(): sap.ui.layout.GridIndent;
/**
* Gets current value of property {@link #getMoveForward moveForward}.
*
* Optional. Moves a cell forwards so many columns as specified.
* @returns {sap.ui.layout.GridIndent} Value of property moveForward
*/
public getMoveForward(): sap.ui.layout.GridIndent;
/**
* Gets current value of property {@link #getSpan span}.
*
* A string type that represents Grid's span values for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small.
* @returns {sap.ui.layout.GridSpan} Value of property span
*/
public getSpan(): sap.ui.layout.GridSpan;
/**
* Gets current value of property {@link #getSpanL spanL}.
*
* Optional. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "span".
* @returns {number} Value of property spanL
*/
public getSpanL(): number;
/**
* Gets current value of property {@link #getSpanLarge spanLarge}.
*
* Deprecated. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "span".
* @returns {number} Value of property spanLarge
*/
public getSpanLarge(): number;
/**
* Gets current value of property {@link #getSpanM spanM}.
*
* Optional. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "span".
* @returns {number} Value of property spanM
*/
public getSpanM(): number;
/**
* Gets current value of property {@link #getSpanMedium spanMedium}.
*
* Deprecated. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "span".
* @returns {number} Value of property spanMedium
*/
public getSpanMedium(): number;
/**
* Gets current value of property {@link #getSpanS spanS}.
*
* Optional. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "span".
* @returns {number} Value of property spanS
*/
public getSpanS(): number;
/**
* Gets current value of property {@link #getSpanSmall spanSmall}.
*
* Deprecated. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "span".
* @returns {number} Value of property spanSmall
*/
public getSpanSmall(): number;
/**
* Gets current value of property {@link #getSpanXL spanXL}.
*
* Optional. Defines a span value for extra large screens. This value overwrites the value for extra large screens defined in the parameter "span".
* @returns {number} Value of property spanXL
*/
public getSpanXL(): number;
/**
* Gets current value of property {@link #getVisibleL visibleL}.
*
* Defines if this Control is visible on Large screens.
*
* Default value is true
.
* @returns {boolean} Value of property visibleL
*/
public getVisibleL(): boolean;
/**
* Gets current value of property {@link #getVisibleM visibleM}.
*
* Defines if this Control is visible on Medium size screens.
*
* Default value is true
.
* @returns {boolean} Value of property visibleM
*/
public getVisibleM(): boolean;
/**
* Gets current value of property {@link #getVisibleOnLarge visibleOnLarge}.
*
* Deprecated. Defines if this Control is visible on Large screens.
*
* Default value is true
.
* @returns {boolean} Value of property visibleOnLarge
*/
public getVisibleOnLarge(): boolean;
/**
* Gets current value of property {@link #getVisibleOnMedium visibleOnMedium}.
*
* Deprecated. Defines if this Control is visible on Medium size screens.
*
* Default value is true
.
* @returns {boolean} Value of property visibleOnMedium
*/
public getVisibleOnMedium(): boolean;
/**
* Gets current value of property {@link #getVisibleOnSmall visibleOnSmall}.
*
* Deprecated. Defines if this Control is visible on small screens.
*
* Default value is true
.
* @returns {boolean} Value of property visibleOnSmall
*/
public getVisibleOnSmall(): boolean;
/**
* Gets current value of property {@link #getVisibleS visibleS}.
*
* Defines if this Control is visible on small screens.
*
* Default value is true
.
* @returns {boolean} Value of property visibleS
*/
public getVisibleS(): boolean;
/**
* Gets current value of property {@link #getVisibleXL visibleXL}.
*
* Defines if this Control is visible on XL - extra Large screens.
*
* Default value is true
.
* @returns {boolean} Value of property visibleXL
*/
public getVisibleXL(): boolean;
/**
* Sets a new value for property {@link #getIndent indent}.
*
* A string type that represents Grid's span values for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.layout.GridIndent} sIndent - New value for property indent
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setIndent(sIndent: sap.ui.layout.GridIndent): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getIndentL indentL}.
*
* Optional. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "indent".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iIndentL - New value for property indentL
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setIndentL(iIndentL: number): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getIndentLarge indentLarge}.
*
* Deprecated. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "indent".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iIndentLarge - New value for property indentLarge
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setIndentLarge(iIndentLarge: number): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getIndentM indentM}.
*
* Optional. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "indent".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iIndentM - New value for property indentM
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setIndentM(iIndentM: number): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getIndentMedium indentMedium}.
*
* Deprecated. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "indent".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iIndentMedium - New value for property indentMedium
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setIndentMedium(iIndentMedium: number): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getIndentS indentS}.
*
* Optional. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "indent".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iIndentS - New value for property indentS
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setIndentS(iIndentS: number): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getIndentSmall indentSmall}.
*
* Deprecated. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "indent".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iIndentSmall - New value for property indentSmall
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setIndentSmall(iIndentSmall: number): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getIndentXL indentXL}.
*
* Optional. Defines a span value for extra large screens. This value overwrites the value for extra large screens defined in the parameter "indent".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iIndentXL - New value for property indentXL
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setIndentXL(iIndentXL: number): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getLinebreak linebreak}.
*
* Optional. If this property is set to true, the control on all-size screens causes a line break within the Grid and becomes the first within the next line.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bLinebreak - New value for property linebreak
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setLinebreak(bLinebreak: boolean): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getLinebreakL linebreakL}.
*
* Optional. If this property is set to true, the control on large screens causes a line break within the Grid and becomes the first within the next line.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bLinebreakL - New value for property linebreakL
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setLinebreakL(bLinebreakL: boolean): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getLinebreakM linebreakM}.
*
* Optional. If this property is set to true, the control on medium sized screens causes a line break within the Grid and becomes the first within the next line.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bLinebreakM - New value for property linebreakM
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setLinebreakM(bLinebreakM: boolean): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getLinebreakS linebreakS}.
*
* Optional. If this property is set to true, the control on small screens causes a line break within the Grid and becomes the first within the next line.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bLinebreakS - New value for property linebreakS
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setLinebreakS(bLinebreakS: boolean): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getLinebreakXL linebreakXL}.
*
* Optional. If this property is set to true, the control on extra large screens causes a line break within the Grid and becomes the first within the next line.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bLinebreakXL - New value for property linebreakXL
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setLinebreakXL(bLinebreakXL: boolean): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getMoveBackwards moveBackwards}.
*
* Optional. Moves a cell backwards so many columns as specified.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.layout.GridIndent} sMoveBackwards - New value for property moveBackwards
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setMoveBackwards(sMoveBackwards: sap.ui.layout.GridIndent): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getMoveForward moveForward}.
*
* Optional. Moves a cell forwards so many columns as specified.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.layout.GridIndent} sMoveForward - New value for property moveForward
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setMoveForward(sMoveForward: sap.ui.layout.GridIndent): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getSpan span}.
*
* A string type that represents Grid's span values for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.layout.GridSpan} sSpan - New value for property span
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setSpan(sSpan: sap.ui.layout.GridSpan): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getSpanL spanL}.
*
* Optional. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "span".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iSpanL - New value for property spanL
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setSpanL(iSpanL: number): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getSpanLarge spanLarge}.
*
* Deprecated. Defines a span value for large screens. This value overwrites the value for large screens defined in the parameter "span".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iSpanLarge - New value for property spanLarge
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setSpanLarge(iSpanLarge: number): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getSpanM spanM}.
*
* Optional. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "span".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iSpanM - New value for property spanM
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setSpanM(iSpanM: number): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getSpanMedium spanMedium}.
*
* Deprecated. Defines a span value for medium size screens. This value overwrites the value for medium screens defined in the parameter "span".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iSpanMedium - New value for property spanMedium
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setSpanMedium(iSpanMedium: number): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getSpanS spanS}.
*
* Optional. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "span".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iSpanS - New value for property spanS
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setSpanS(iSpanS: number): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getSpanSmall spanSmall}.
*
* Deprecated. Defines a span value for small screens. This value overwrites the value for small screens defined in the parameter "span".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iSpanSmall - New value for property spanSmall
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setSpanSmall(iSpanSmall: number): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getSpanXL spanXL}.
*
* Optional. Defines a span value for extra large screens. This value overwrites the value for extra large screens defined in the parameter "span".
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iSpanXL - New value for property spanXL
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setSpanXL(iSpanXL: number): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getVisibleL visibleL}.
*
* Defines if this Control is visible on Large screens.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisibleL - New value for property visibleL
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setVisibleL(bVisibleL: boolean): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getVisibleM visibleM}.
*
* Defines if this Control is visible on Medium size screens.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisibleM - New value for property visibleM
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setVisibleM(bVisibleM: boolean): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getVisibleOnLarge visibleOnLarge}.
*
* Deprecated. Defines if this Control is visible on Large screens.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisibleOnLarge - New value for property visibleOnLarge
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setVisibleOnLarge(bVisibleOnLarge: boolean): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getVisibleOnMedium visibleOnMedium}.
*
* Deprecated. Defines if this Control is visible on Medium size screens.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisibleOnMedium - New value for property visibleOnMedium
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setVisibleOnMedium(bVisibleOnMedium: boolean): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getVisibleOnSmall visibleOnSmall}.
*
* Deprecated. Defines if this Control is visible on small screens.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisibleOnSmall - New value for property visibleOnSmall
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setVisibleOnSmall(bVisibleOnSmall: boolean): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getVisibleS visibleS}.
*
* Defines if this Control is visible on small screens.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisibleS - New value for property visibleS
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setVisibleS(bVisibleS: boolean): sap.ui.layout.GridData;
/**
* Sets a new value for property {@link #getVisibleXL visibleXL}.
*
* Defines if this Control is visible on XL - extra Large screens.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisibleXL - New value for property visibleXL
* @returns {sap.ui.layout.GridData} Reference to this
in order to allow method chaining
*/
public setVisibleXL(bVisibleXL: boolean): sap.ui.layout.GridData;
}
/**
* A string type that represents Grid's indent values for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 11 that the container has to take, for example: "L2 M4 S6", "M11", "s10" or "l4 m4". Note that the parameters have to be provided in the order large medium small.
*/
export type GridIndent = string;
/**
* The position of the Grid. Can be "Left", "Center" or "Right". "Left" is default.
*/
export enum GridPosition {
/**
* Grid is centered on the screen.
*/
Center = "Center",
/**
* Grid is aligned left.
*/
Left = "Left",
/**
* Grid is aligned to the right.
*/
Right = "Right",
}
/**
* A string type that represents Grid's span values for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters have to be provided in the order large medium small.
*/
export type GridSpan = string;
/**
* A layout that provides support for horizontal alignment of controls
*/
export class HorizontalLayout extends sap.ui.core.Control {
/**
* Constructor for a new HorizontalLayout.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.layout.HorizontalLayout} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.layout.HorizontalLayout;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.layout.HorizontalLayout} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.layout.HorizontalLayout;
/**
* Creates a new subclass of class sap.ui.layout.HorizontalLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets current value of property {@link #getAllowWrapping allowWrapping}.
*
* Specifies whether the content inside the Layout shall be line-wrapped in the case that there is less horizontal space available than required.
*
* Default value is false
.
* @returns {boolean} Value of property allowWrapping
*/
public getAllowWrapping(): boolean;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The controls inside this layout
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.ui.layout.HorizontalLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.layout.HorizontalLayout} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.layout.HorizontalLayout;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getAllowWrapping allowWrapping}.
*
* Specifies whether the content inside the Layout shall be line-wrapped in the case that there is less horizontal space available than required.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bAllowWrapping - New value for property allowWrapping
* @returns {sap.ui.layout.HorizontalLayout} Reference to this
in order to allow method chaining
*/
public setAllowWrapping(bAllowWrapping: boolean): sap.ui.layout.HorizontalLayout;
}
/**
* PaneContainer is an abstraction of Splitter
* Could be used as an aggregation of ResponsiveSplitter or other PaneContainers.
*/
export class PaneContainer extends sap.ui.core.Element {
/**
* Constructor for a new PaneContainer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some pane to the aggregation {@link #getPanes panes}.
* @param {sap.ui.core.Element} oPane - the pane to add; if empty, nothing is inserted
* @returns {sap.ui.layout.PaneContainer} Reference to this
in order to allow method chaining
*/
public addPane(oPane: sap.ui.core.Element): sap.ui.layout.PaneContainer;
/**
* Destroys all the panes in the aggregation {@link #getPanes panes}.
* @returns {sap.ui.layout.PaneContainer} Reference to this
in order to allow method chaining
*/
public destroyPanes(): sap.ui.layout.PaneContainer;
/**
* Creates a new subclass of class sap.ui.layout.PaneContainer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.layout.PaneContainer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getOrientation orientation}.
*
* The orientation of the Splitter
*
* Default value is Horizontal
.
* @returns {sap.ui.core.Orientation} Value of property orientation
*/
public getOrientation(): sap.ui.core.Orientation;
/**
* Gets content of aggregation {@link #getPanes panes}.
*
* The Pane that will be shown when there is no suitable pane for ResponsiveSplitter's current width.
* @returns {sap.ui.core.Element[]}
*/
public getPanes(): sap.ui.core.Element[];
/**
* Checks for the provided sap.ui.core.Element
in the aggregation {@link #getPanes panes}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Element} oPane - The pane whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfPane(oPane: sap.ui.core.Element): number;
/**
* Pane insertion
* @param {any} oObject
* @param {any} iIndex
* @returns {sap.ui.base.ManagedObject}
*/
public insertPane(oObject: any, iIndex: any): sap.ui.base.ManagedObject;
/**
* Removes all the controls from the aggregation {@link #getPanes panes}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Element[]} An array of the removed elements (might be empty)
*/
public removeAllPanes(): sap.ui.core.Element[];
/**
* Removes a pane from the aggregation {@link #getPanes panes}.
* @param {number|string|sap.ui.core.Element} vPane - The pane to remove or its index or id
* @returns {sap.ui.core.Element} The removed pane or null
*/
public removePane(vPane: number|string|sap.ui.core.Element): sap.ui.core.Element;
/**
* Setter for property layoutData.
* @param {sap.ui.core.LayoutData} oLayoutData - The LayoutData object.
*/
public setLayoutData(oLayoutData: sap.ui.core.LayoutData): void;
/**
* Setter for property orientation.
* Default value is sap.ui.core.Orientation.Horizontal
* @param {sap.ui.core.Orientation} sOrientation - The Orientation type.
* @returns {sap.ui.layout.PaneContainer} this to allow method chaining.
*/
public setOrientation(sOrientation: sap.ui.core.Orientation): sap.ui.layout.PaneContainer;
}
/**
* This is a layout where several controls can be added. These controls are blown up to fit in an entire row. If the window resizes, the controls are moved between the rows and resized again.
*/
export class ResponsiveFlowLayout extends sap.ui.core.Control {
/**
* Constructor for a new ResponsiveFlowLayout.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.layout.ResponsiveFlowLayout} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.layout.ResponsiveFlowLayout;
/**
* Adds content.
* This function needs to be overridden to prevent any rendering while some
* content is still being added.
* @param {sap.ui.core.Control} oContent - The content that should be added to the layout
*/
public addContent(oContent: sap.ui.core.Control): void;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.layout.ResponsiveFlowLayout} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.layout.ResponsiveFlowLayout;
/**
* Creates a new subclass of class sap.ui.layout.ResponsiveFlowLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets content of aggregation {@link #getContent content}.
*
* Added content that should be positioned. Every content item should have a ResponsiveFlowLayoutData attached, or otherwise, the default values are used.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.ui.layout.ResponsiveFlowLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getResponsive responsive}.
*
* If set to false, all added controls will keep their width, or otherwise, the controls will be stretched to the possible width of a row.
*
* Default value is true
.
* @returns {boolean} Value of property responsive
*/
public getResponsive(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts content.
* This function needs to be overridden to prevent any rendering while some
* content is still being added.
* @param {sap.ui.core.Control} oContent - The content that should be inserted to the layout
* @param {number} iIndex - The index where the content should be inserted into
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): void;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes content.
* This function needs to be overridden to prevent any rendering while some
* content is still being added.
* @param {number|string|sap.ui.core.Control} oContent - The content that should be removed from the layout
* @returns {sap.ui.core.Control} The this
pointer for chaining
*/
public removeContent(oContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getResponsive responsive}.
*
* If set to false, all added controls will keep their width, or otherwise, the controls will be stretched to the possible width of a row.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bResponsive - New value for property responsive
* @returns {sap.ui.layout.ResponsiveFlowLayout} Reference to this
in order to allow method chaining
*/
public setResponsive(bResponsive: boolean): sap.ui.layout.ResponsiveFlowLayout;
}
/**
* This is a LayoutData element that can be added to a control if this control is used within a ResponsiveFlowLayout.
*/
export class ResponsiveFlowLayoutData extends sap.ui.core.LayoutData {
/**
* Constructor for a new ResponsiveFlowLayoutData.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.layout.ResponsiveFlowLayoutData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.LayoutData.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getLinebreak linebreak}.
*
* If this property is set, the control in which the LayoutData is added, will always cause a line break within the ResponsiveFlowLayout.
*
* Default value is false
.
* @returns {boolean} Value of property linebreak
*/
public getLinebreak(): boolean;
/**
* Gets current value of property {@link #getLinebreakable linebreakable}.
*
* Shows if an element can be wrapped into a new row. If this value is set to false, the min-width will be set to 0 and the wrapping is up to the previous element.
*
* Default value is true
.
* @returns {boolean} Value of property linebreakable
*/
public getLinebreakable(): boolean;
/**
* Gets current value of property {@link #getMargin margin}.
*
* Prevents any margin of the element if set to false.
*
* Default value is true
.
* @returns {boolean} Value of property margin
*/
public getMargin(): boolean;
/**
* Returns a metadata object for class sap.ui.layout.ResponsiveFlowLayoutData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinWidth minWidth}.
*
* Defines the minimal size in px of a ResponsiveFlowLayout element. The element will be shrunk down to this value.
*
* Default value is 100
.
* @returns {number} Value of property minWidth
*/
public getMinWidth(): number;
/**
* Gets current value of property {@link #getWeight weight}.
*
* Defines the weight of the element, that influences the resulting width. If there are several elements within a row of the ResponsiveFlowLayout, each element could have another weight. The bigger the weight of a single element, the wider it will be stretched, i.e. a bigger weight results in a larger width.
*
* Default value is 1
.
* @returns {number} Value of property weight
*/
public getWeight(): number;
/**
* Sets a new value for property {@link #getLinebreak linebreak}.
*
* If this property is set, the control in which the LayoutData is added, will always cause a line break within the ResponsiveFlowLayout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bLinebreak - New value for property linebreak
* @returns {sap.ui.layout.ResponsiveFlowLayoutData} Reference to this
in order to allow method chaining
*/
public setLinebreak(bLinebreak: boolean): sap.ui.layout.ResponsiveFlowLayoutData;
/**
* Sets a new value for property {@link #getLinebreakable linebreakable}.
*
* Shows if an element can be wrapped into a new row. If this value is set to false, the min-width will be set to 0 and the wrapping is up to the previous element.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bLinebreakable - New value for property linebreakable
* @returns {sap.ui.layout.ResponsiveFlowLayoutData} Reference to this
in order to allow method chaining
*/
public setLinebreakable(bLinebreakable: boolean): sap.ui.layout.ResponsiveFlowLayoutData;
/**
* Sets a new value for property {@link #getMargin margin}.
*
* Prevents any margin of the element if set to false.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bMargin - New value for property margin
* @returns {sap.ui.layout.ResponsiveFlowLayoutData} Reference to this
in order to allow method chaining
*/
public setMargin(bMargin: boolean): sap.ui.layout.ResponsiveFlowLayoutData;
/**
* Sets a new value for property {@link #getMinWidth minWidth}.
*
* Defines the minimal size in px of a ResponsiveFlowLayout element. The element will be shrunk down to this value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100
.
* @param {number} iMinWidth - New value for property minWidth
* @returns {sap.ui.layout.ResponsiveFlowLayoutData} Reference to this
in order to allow method chaining
*/
public setMinWidth(iMinWidth: number): sap.ui.layout.ResponsiveFlowLayoutData;
/**
* Sets a new value for property {@link #getWeight weight}.
*
* Defines the weight of the element, that influences the resulting width. If there are several elements within a row of the ResponsiveFlowLayout, each element could have another weight. The bigger the weight of a single element, the wider it will be stretched, i.e. a bigger weight results in a larger width.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} iWeight - New value for property weight
* @returns {sap.ui.layout.ResponsiveFlowLayoutData} Reference to this
in order to allow method chaining
*/
public setWeight(iWeight: number): sap.ui.layout.ResponsiveFlowLayoutData;
}
/**
* ResponsiveSplitter is a control that enables responsiveness of normal Splitter.
* ResponsiveSplitter consists of PaneContainers that further agregate other PaneContainers and SplitPanes.
* SplitPanes can be moved to the pagination when a minimum width of their parent is reached.
*/
export class ResponsiveSplitter extends sap.ui.core.Control {
/**
* Constructor for a new ResponsiveSplitter.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Destroys the rootPaneContainer in the aggregation {@link #getRootPaneContainer rootPaneContainer}.
* @returns {sap.ui.layout.ResponsiveSplitter} Reference to this
in order to allow method chaining
*/
public destroyRootPaneContainer(): sap.ui.layout.ResponsiveSplitter;
/**
* Creates a new subclass of class sap.ui.layout.ResponsiveSplitter with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* ID of the element which is the current target of the association {@link #getDefaultPane defaultPane}, or null
.
* @returns {sap.ui.core.ID}
*/
public getDefaultPane(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getHeight height}.
*
* The height of the control
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.layout.ResponsiveSplitter.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getRootPaneContainer rootPaneContainer}.
*
* The root PaneContainer of the ResponsiveSplitter
* @returns {sap.ui.layout.PaneContainer}
*/
public getRootPaneContainer(): sap.ui.layout.PaneContainer;
/**
* Gets current value of property {@link #getWidth width}.
*
* The width of the control
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets the associated {@link #getDefaultPane defaultPane}.
* @param {sap.ui.core.ID|sap.ui.layout.SplitPane} oDefaultPane - ID of an element which becomes the new target of this defaultPane association; alternatively, an element instance may be given
* @returns {sap.ui.layout.ResponsiveSplitter} Reference to this
in order to allow method chaining
*/
public setDefaultPane(oDefaultPane: sap.ui.core.ID|sap.ui.layout.SplitPane): sap.ui.layout.ResponsiveSplitter;
/**
* Sets a new value for property {@link #getHeight height}.
*
* The height of the control
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.layout.ResponsiveSplitter} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.layout.ResponsiveSplitter;
/**
* Sets the aggregated {@link #getRootPaneContainer rootPaneContainer}.
* @param {sap.ui.layout.PaneContainer} oRootPaneContainer - The rootPaneContainer to set
* @returns {sap.ui.layout.ResponsiveSplitter} Reference to this
in order to allow method chaining
*/
public setRootPaneContainer(oRootPaneContainer: sap.ui.layout.PaneContainer): sap.ui.layout.ResponsiveSplitter;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The width of the control
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.layout.ResponsiveSplitter} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.layout.ResponsiveSplitter;
}
/**
* Types of the DynamicSideContent FallDown options
*/
export enum SideContentFallDown {
/**
* Side content falls down on breakpoints below L
*/
BelowL = "BelowL",
/**
* Side content falls down on breakpoints below M
*/
BelowM = "BelowM",
/**
* Side content falls down on breakpoints below XL
*/
BelowXL = "BelowXL",
/**
* Side content falls down on breakpoint M and the minimum width for the side content
*/
OnMinimumWidth = "OnMinimumWidth",
}
/**
* The position of the side content - End (default) and Begin.
*/
export enum SideContentPosition {
/**
* The side content is on the left side of the main container in left-to-right mode and on the right side in right-to-left mode.
*/
Begin = "Begin",
/**
* The side content is on the right side of the main container in left-to-right mode and on the left side in right-to-left mode.
*/
End = "End",
}
/**
* Types of the DynamicSideContent Visibility options
*/
export enum SideContentVisibility {
/**
* Show the side content on any breakpoint
*/
AlwaysShow = "AlwaysShow",
/**
* Don't show the side content on any breakpoints
*/
NeverShow = "NeverShow",
/**
* Show the side content on XL breakpoint
*/
ShowAboveL = "ShowAboveL",
/**
* Show the side content on L and XL breakpoints
*/
ShowAboveM = "ShowAboveM",
/**
* Show the side content on M, L and XL breakpoints
*/
ShowAboveS = "ShowAboveS",
}
/**
* SplitPane is a container of a single control.
* Could be used as an aggregation of a PaneContainer.
*/
export class SplitPane extends sap.ui.core.Element {
/**
* Constructor for a new SplitPane.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Destroys the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.layout.SplitPane} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.layout.SplitPane;
/**
* Creates a new subclass of class sap.ui.layout.SplitPane with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Content of the SplitPane
* @returns {sap.ui.core.Control}
*/
public getContent(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getDemandPane demandPane}.
*
* Determines whether the pane will be moved to the pagination
*
* Default value is true
.
* @returns {boolean} Value of property demandPane
*/
public getDemandPane(): boolean;
/**
* Returns a metadata object for class sap.ui.layout.SplitPane.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRequiredParentWidth requiredParentWidth}.
*
* Determines the minimum width of the ResponsiveSplitter(in pixels). When it is reached the pane will be hidden from the screen.
*
* Default value is 800
.
* @returns {number} Value of property requiredParentWidth
*/
public getRequiredParentWidth(): number;
/**
* Sets the aggregated {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - The content to set
* @returns {sap.ui.layout.SplitPane} Reference to this
in order to allow method chaining
*/
public setContent(oContent: sap.ui.core.Control): sap.ui.layout.SplitPane;
/**
* Sets a new value for property {@link #getDemandPane demandPane}.
*
* Determines whether the pane will be moved to the pagination
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bDemandPane - New value for property demandPane
* @returns {sap.ui.layout.SplitPane} Reference to this
in order to allow method chaining
*/
public setDemandPane(bDemandPane: boolean): sap.ui.layout.SplitPane;
/**
* Sets a new value for property {@link #getRequiredParentWidth requiredParentWidth}.
*
* Determines the minimum width of the ResponsiveSplitter(in pixels). When it is reached the pane will be hidden from the screen.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 800
.
* @param {number} iRequiredParentWidth - New value for property requiredParentWidth
* @returns {sap.ui.layout.SplitPane} Reference to this
in order to allow method chaining
*/
public setRequiredParentWidth(iRequiredParentWidth: number): sap.ui.layout.SplitPane;
}
/**
* A layout that contains several content areas. The content that is added to the splitter should contain LayoutData of the type SplitterLayoutData that defines its size and size contraints.
*
* By adding or changing SplitterLayoutData to the controls that make up the content areas, the size can be changed programatically. Additionally the contents can be made non-resizable individually and a minimal size (in px) can be set.
*
* The orientation of the splitter can be set to horizontal (default) or vertical. All content areas of the splitter will be arranged in that way. In order to split vertically and horizontally at the same time, Splitters need to be nested.
*
* The splitter bars can be focused to enable resizing of the content areas via keyboard. The contents size can be manipulated when the splitter bar is focused and Shift-Left/Down/Right/Up are pressed. When Shift-Home/End are pressed, the contents are set their minimum or maximum size (keep in mind though, that resizing an auto-size content-area next to another auto-size one might lead to the effect that the former does not take its maximum size but only the maximum size before recalculating auto sizes).
*
* The splitter bars used for resizing the contents by the user can be set to different widths (or heights in vertical mode) and the splitter will automatically resize the other contents accordingly. In case the splitter bar is resized after the splitter has rendered, a manual resize has to be triggered by invoking triggerResize() on the Splitter.
*/
export class Splitter extends sap.ui.core.Control {
/**
* Constructor for a new Splitter.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some contentArea to the aggregation {@link #getContentAreas contentAreas}.
* @param {sap.ui.core.Control} oContentArea - the contentArea to add; if empty, nothing is inserted
* @returns {sap.ui.layout.Splitter} Reference to this
in order to allow method chaining
*/
public addContentArea(oContentArea: sap.ui.core.Control): sap.ui.layout.Splitter;
/**
* Attaches event handler fnFunction
to the {@link #event:resize resize} event of this sap.ui.layout.Splitter
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.layout.Splitter
itself.
*
* Event is fired when contents are resized.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.layout.Splitter
itself
* @returns {sap.ui.layout.Splitter} Reference to this
in order to allow method chaining
*/
public attachResize(fnFunction: Function, oListener?: any): sap.ui.layout.Splitter;
/**
* Attaches event handler fnFunction
to the {@link #event:resize resize} event of this sap.ui.layout.Splitter
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.layout.Splitter
itself.
*
* Event is fired when contents are resized.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.layout.Splitter
itself
* @returns {sap.ui.layout.Splitter} Reference to this
in order to allow method chaining
*/
public attachResize(oData: any, fnFunction: Function, oListener?: any): sap.ui.layout.Splitter;
/**
* Destroys all the contentAreas in the aggregation {@link #getContentAreas contentAreas}.
* @returns {sap.ui.layout.Splitter} Reference to this
in order to allow method chaining
*/
public destroyContentAreas(): sap.ui.layout.Splitter;
/**
* Detaches event handler fnFunction
from the {@link #event:resize resize} event of this sap.ui.layout.Splitter
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.layout.Splitter} Reference to this
in order to allow method chaining
*/
public detachResize(fnFunction: Function, oListener: any): sap.ui.layout.Splitter;
/**
* Disables the resize handler for this control, this leads to an automatic resize of
* the contents whenever the control changes its size. The resize handler is enabled
* in every control instance by default.
* For performance reasons this behavior can be disabled by calling disableAutoResize()
* @param {boolean} bTemporarily - Only disable autoResize temporarily (used for live resize), so that the previous status can be restored afterwards
*/
protected disableAutoResize(bTemporarily?: boolean): void;
/**
* Disables the resizing of the Splitter contents via keyboard. This changes the Splitter bars
* to non-focussable elements.
*/
protected disableKeyboardSupport(): void;
/**
* Disables recalculation and resize of the splitter contents while dragging the splitter bar.
* This means that the contents are resized only once after moving the splitter bar.
*/
protected disableLiveResize(): void;
/**
* Enables the resize handler for this control, this leads to an automatic resize of
* the contents whenever the control changes its size. The resize handler is enabled
* in every control instance by default.
* For performance reasons this behavior can be disabled by calling disableAutoResize()
* @param {boolean} bTemporarily - Only enables autoResize if it was previously disabled temporarily (used for live resize)
*/
protected enableAutoResize(bTemporarily?: boolean): void;
/**
* Enables the resizing of the Splitter contents via keyboard. This makes the Splitter bars
* focussable elements.
*/
protected enableKeyboardSupport(): void;
/**
* Enables recalculation and resize of the splitter contents while dragging the splitter bar.
* This means that the contents are resized several times per second when moving the splitter bar.
*/
protected enableLiveResize(): void;
/**
* Creates a new subclass of class sap.ui.layout.Splitter with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:resize resize} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.layout.Splitter} Reference to this
in order to allow method chaining
*/
protected fireResize(mParameters?: any): sap.ui.layout.Splitter;
/**
* Returns the current actual content sizes as pixel value - these values can change with every
* resize.
* @returns {number[]} Array of px values that correspond to the content area sizes
*/
protected getCalculatedSizes(): number[];
/**
* Gets content of aggregation {@link #getContentAreas contentAreas}.
*
* The content areas to be split. The control will show n-1 splitter bars between n controls in this aggregation.
* @returns {sap.ui.core.Control[]}
*/
public getContentAreas(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getHeight height}.
*
* The height of the control
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.layout.Splitter.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getOrientation orientation}.
*
* Whether to split the contents horizontally (default) or vertically.
*
* Default value is Horizontal
.
* @returns {sap.ui.core.Orientation} Value of property orientation
*/
public getOrientation(): sap.ui.core.Orientation;
/**
* Gets current value of property {@link #getWidth width}.
*
* The width of the control
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContentAreas contentAreas}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContentArea - The contentArea whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContentArea(oContentArea: sap.ui.core.Control): number;
/**
* Inserts a contentArea into the aggregation {@link #getContentAreas contentAreas}.
* @param {sap.ui.core.Control} oContentArea - the contentArea to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the contentArea should be inserted at; for a negative value of iIndex
, the contentArea is inserted at position 0; for a value greater than the current size of the aggregation, the contentArea is inserted at the last position
* @returns {sap.ui.layout.Splitter} Reference to this
in order to allow method chaining
*/
public insertContentArea(oContentArea: sap.ui.core.Control, iIndex: number): sap.ui.layout.Splitter;
/**
* Removes all the controls from the aggregation {@link #getContentAreas contentAreas}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContentAreas(): sap.ui.core.Control[];
/**
* Removes a contentArea from the aggregation {@link #getContentAreas contentAreas}.
* @param {number|string|sap.ui.core.Control} vContentArea - The contentArea to remove or its index or id
* @returns {sap.ui.core.Control} The removed contentArea or null
*/
public removeContentArea(vContentArea: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getHeight height}.
*
* The height of the control
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.layout.Splitter} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.layout.Splitter;
/**
* Sets a new value for property {@link #getOrientation orientation}.
*
* Whether to split the contents horizontally (default) or vertically.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Horizontal
.
* @param {sap.ui.core.Orientation} sOrientation - New value for property orientation
* @returns {sap.ui.layout.Splitter} Reference to this
in order to allow method chaining
*/
public setOrientation(sOrientation: sap.ui.core.Orientation): sap.ui.layout.Splitter;
/**
* Sets a new value for property {@link #getWidth width}.
*
* The width of the control
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.layout.Splitter} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.layout.Splitter;
/**
* This method triggers a resize on the Splitter - meaning it forces the Splitter to recalculate
* all sizes.
* This method should only be used in rare cases, for example when the CSS that defines the sizes
* of the splitter bars changes without triggering a rerendering of the splitter.
* @param {boolean} forceDirectly - Do not delay the resize, trigger it right now.
*/
public triggerResize(forceDirectly?: boolean): void;
}
/**
* Holds layout data for the splitter contents.
* Allowed size values are numeric values ending in "px" and "%" and the
* special case "auto".
* (The CSS value "auto" is used internally to recalculate the size of the content
* dynamically and is not directly set as style property.)
*/
export class SplitterLayoutData extends sap.ui.core.LayoutData {
/**
* Constructor for a new SplitterLayoutData.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.layout.SplitterLayoutData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.LayoutData.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.layout.SplitterLayoutData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinSize minSize}.
*
* Sets the minimum size of the splitter content in px.
*
* Default value is 0
.
* @returns {number} Value of property minSize
*/
public getMinSize(): number;
/**
* Gets current value of property {@link #getResizable resizable}.
*
* Determines whether the control in the splitter can be resized or not.
*
* Default value is true
.
* @returns {boolean} Value of property resizable
*/
public getResizable(): boolean;
/**
* Gets current value of property {@link #getSize size}.
*
* Sets the size of the splitter content.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property size
*/
public getSize(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getMinSize minSize}.
*
* Sets the minimum size of the splitter content in px.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iMinSize - New value for property minSize
* @returns {sap.ui.layout.SplitterLayoutData} Reference to this
in order to allow method chaining
*/
public setMinSize(iMinSize: number): sap.ui.layout.SplitterLayoutData;
/**
* Sets a new value for property {@link #getResizable resizable}.
*
* Determines whether the control in the splitter can be resized or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bResizable - New value for property resizable
* @returns {sap.ui.layout.SplitterLayoutData} Reference to this
in order to allow method chaining
*/
public setResizable(bResizable: boolean): sap.ui.layout.SplitterLayoutData;
/**
* Sets a new value for property {@link #getSize size}.
*
* Sets the size of the splitter content.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.core.CSSSize} sSize - New value for property size
* @returns {sap.ui.layout.SplitterLayoutData} Reference to this
in order to allow method chaining
*/
public setSize(sSize: sap.ui.core.CSSSize): sap.ui.layout.SplitterLayoutData;
}
/**
* In this layout the content controls are rendered one below the other.
*/
export class VerticalLayout extends sap.ui.core.Control {
/**
* Constructor for a new VerticalLayout.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.layout.VerticalLayout} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.layout.VerticalLayout;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.layout.VerticalLayout} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.layout.VerticalLayout;
/**
* Creates a new subclass of class sap.ui.layout.VerticalLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {any}
*/
protected getAccessibilityInfo(): any;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Content controls within the layout.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* If not enabled, all controls inside are not enabled automatically.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Returns a metadata object for class sap.ui.layout.VerticalLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the VerticalLayout
. If no width is set, the width of the content is used.
* If the content of the layout has a larger width than the layout, it is cut off.
* There is no scrolling inside the layout.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.layout.VerticalLayout} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.layout.VerticalLayout;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* If not enabled, all controls inside are not enabled automatically.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.layout.VerticalLayout} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.layout.VerticalLayout;
}
}
/**
* The SAPUI5 Data Binding API.
*
* The default binding mode for model implementations (if not implemented otherwise) is two way and the supported binding modes by the model
* are one way, two way and one time. The default binding mode can be changed by the application for each model instance.
* A model implementation should specify its supported binding modes and set the default binding mode accordingly
* (e.g. if the model supports only one way binding the default binding mode should also be set to one way).
*
* The default size limit for models is 100. The size limit determines the number of entries used for the list bindings.
*/
namespace model {
/**
* FormatException class
*
* This exception is thrown, when an error occurs while trying to convert a value of the model to
* a specific property value in the UI.
*/
function FormatException(): void;
/**
* ParseException class
*
* This exception is thrown, when a parse error occurs while converting a
* string value to a specific property type in the model.
*/
function ParseException(): void;
/**
* ValidateException class
*
* This exception is thrown, when a validation error occurs while checking the
* defined constraints for a type.
*/
function ValidateException(): void;
/**
* Analytical Adapter for ODataModels
*/
namespace analytics {
/**
* If called on an instance of an (v1/v2) ODataModel it will enrich it with analytics capabilities.
*/
function ODataModelAdapter(): void;
/**
* Tree binding implementation for OData entity sets with aggregate semantics.
*
* Note on the handling of different count modes:
* The AnalyticalBinding always uses the OData $inlinecount system query option to determine the total
* count of matching entities. It ignores the default count mode set in the ODataModel instance and the
* count mode specified in the binding parameters. If the default count mode is None, a warning is added
* to the log to remind the application that OData requests generated by the AnalyticalBinding will include
* a $inlinecount. If a count mode has been specified in the binding parameters, an error message will be
* logged if it is None, because the binding will still add the $inlinecount to OData requests. If a
* binding count mode is set to Request or Both, a warning will be logged to remind the application that
* the OData requests generated by the AnalyticalBinding will include a $inlinecount.
*/
export class AnalyticalBinding extends sap.ui.model.TreeBinding {
/**
* @param {sap.ui.model.Model} oModel
* @param {string} sPath - the path pointing to the tree / array that should be bound
* @param {any} oContext - the context object for this data binding
* @param {any[]} aSorter - predefined sorter/s contained in an array
* @param {any[]} aFilters - predefined filter/s contained in an array
* @param {any} mParameters - additional control parameters. Supported parameters are: - entitySet: if set, it explicitly specifies the entity set addressed by the last segment of the given binding path
- useBatchRequests: if true, multiple OData requests will be wrapped into a single batch request, wherever possible
- provideGrandTotals: if true, grand total values will be provided for all bound measure properties
- provideTotalResultSize: if true, the total number of matching entries in the bound OData entity set will be provided
- reloadSingleUnitMeasures: if true, the binding will check aggregated entries with multi-unit occurrences, if some measure properties have a unique unit and will trigger separate OData requests to fetch them
*/
public constructor(oModel: sap.ui.model.Model, sPath: string, oContext?: any, aSorter?: any[], aFilters?: any[], mParameters?: any);
/**
* Creates a new subclass of class sap.ui.model.analytics.AnalyticalBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.TreeBinding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Sets filters for matching only a subset of the entities in the bound OData entity set.
*
* Invoking this function resets the state of the binding. Subsequent data requests such as calls to getNodeContexts() will
* need to trigger OData requests in order to fetch the data that are in line with these filters.
* @param {sap.ui.model.Filter[]|sap.ui.model.Filter} aFilter - an Array of sap.ui.model.Filter objects or a single Filter instance.
* @param {sap.ui.model.FilterType} sFilterType - Type of the filter which should be adjusted.
*/
public filter(aFilter: sap.ui.model.Filter[]|sap.ui.model.Filter, sFilterType?: sap.ui.model.FilterType): void;
/**
* Gets the analytical information for a column with a given name.
* @param {any} sColumnName - the column name.
* @returns {any} analytical information for the column; see {@link #updateAnalyticalInfo} for an explanation of the object structure
*/
public getAnalyticalInfoForColumn(sColumnName: any): any;
/**
* Gets analytical metadata for the bound OData entity set.
* @returns {sap.ui.model.analytics.odata4analytics.QueryResult} analytical metadata for the bound OData entity set
*/
public getAnalyticalQueryResult(): sap.ui.model.analytics.odata4analytics.QueryResult;
/**
* Gets details about the dimension properties included in the bound OData entity set.
* @returns {{ [key: string]: any }} details for every dimension property addressed by its name. The details object provides these properties: name of the dimension, keyPropertyName for the name of the property holding the dimension key, textPropertyName for the name of the property holding the text for the dimension, aAttributeName listing all properties holding dimension attributes, grouped as indicator whether or not this dimension is currently grouped, and analyticalInfo, which contains the binding information for this dimension passed from the AnalyticalBinding's consumer via call to function updateAnalyticalInfo.
*/
public getDimensionDetails(): { [key: string]: any };
/**
* Get a download URL with the specified format considering the
* sort/filter/custom parameters.
*
* The download URL also takes into account the selected dimensions and measures,
* depending on the given column definitions of the AnalyticalTable.
* This is based on the visible/inResult flags of the columns, as well as integrity dependencies,
* e.g. for mandatory Unit properties.
* @param {string} sFormat - Value for the $format Parameter
* @returns {string} URL which can be used for downloading
*/
public getDownloadUrl(sFormat: string): string;
/**
* Gets the names of the filterable properties in the bound OData entity set.
* @returns {any[]} names of properties that can be filtered.
*/
public getFilterablePropertyNames(): any[];
/**
* Gets a printable name for a group.
*
* The printable name follows the pattern is <label>:<key-value>[-<text-value>]
,
* where label
is the label of the dimension property used at the aggregation level for the group,
* key-value
is the key value of that dimension for the group, and text-value
is the
* value of the associated text property, if it is also used in the binding.
*
* Whenever a formatter function has been defined for a column displaying the key or text of this dimension, the return value
* of this function is applied for the group name instead of the respective key or text value.
* @param {sap.ui.model.Context} oContext - the parent context identifying the requested group.
* @param {number} iLevel - the level number of oContext (because the context might occur at multiple levels)
* @returns {string} a printable name for the group.
*/
public getGroupName(oContext: sap.ui.model.Context, iLevel: number): string;
/**
* Gets the total number of contexts contained in a group, if known.
*
* For a given group, be aware that the group size might vary over time. In principle, this can happen if the
* bound set of OData entities includes measure properties with amount or quantity values. The AnalyticalBinding
* recognizes situations where the OData service returns multiple entries for a single group entry due to the fact that a
* measure property cannot be aggregated properly, because an amount exists in multiple currencies or a quantity exists
* in multiple units. In such situations, the AnalyticalBinding substitutes these entries by a single representative, and
* the group size gets reduced by the count of duplicate entries. Finally, since the Binding does not always fetch all children of
* a group at once, but only a page with a certain range, such size changes might happen after every page access.
* @param {sap.ui.model.Context} oContext - the parent context identifying the requested group of child contexts.
* @param {number} iLevel - the level number of oContext (because the context might occur at multiple levels)
* @returns {number} The currently known group size, or -1, if not yet determined
*/
public getGroupSize(oContext: sap.ui.model.Context, iLevel: number): number;
/**
* Gets details about the measure properties included in the bound OData entity set.
* @returns {{ [key: string]: any }} details for every measure property addressed by its name. The details object provides these properties: name of the measure, rawValuePropertyName for the name of the property holding the raw value, unitPropertyName for the name of the property holding the related value unit or currency, if any, and analyticalInfo, which contains the binding information for this measure passed from the AnalyticalBinding's consumer via call to function updateAnalyticalInfo.
*/
public getMeasureDetails(): { [key: string]: any };
/**
* Returns a metadata object for class sap.ui.model.analytics.AnalyticalBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets child contexts for a specified parent context.
*
* Contexts are returned in a stable order imposed by the
* dimension property that defines this aggregation level beneath the parent context: Either a sort order has been specified for this property,
* or the entries are returned in ascending order of the values of this dimension property by default.
*
* If any of the requested data is missing, an OData request will be triggered to load it.
* @param {{ [key: string]: any }} mParameters - specifying the aggregation level for which contexts shall be fetched. Supported parameters are: - oContext: parent context identifying the requested group of child contexts
- level: level number for oContext, because it might occur at multiple levels; context with group ID
"/"
has level 0 - numberOfExpandedLevels: number of child levels that shall be fetched automatically
- startIndex: index of first child entry to return from the parent context (zero-based)
- length: number of entries to return; counting begins at the given start index
- threshold: number of additional entries that shall be locally available in the binding for subsequent accesses to child entries of the given parent context.
* @returns {any[]} Array containing the requested contexts of class sap.ui.model.Context, limited by the number of entries contained in the entity set at that aggregation level. The array will contain less than the requested number of contexts, if some are not locally available and an OData request is pending to fetch them. In this case, if the parameter numberOfExpandedLevels > 0, the array will be completely empty.
*/
public getNodeContexts(mParameters: { [key: string]: any }): any[];
/**
* Gets the metadata of a property with a given name.
* @param {string} sPropertyName - The property name.
* @returns {any} OData metadata of this property or null if it does not exist.
*/
public getProperty(sPropertyName: string): any;
/**
* Gets the label of a property with a given name.
* @param {string} sPropertyName - The property name.
* @returns {string} The heading maintained for this property or null if it does not exist.
*/
public getPropertyHeading(sPropertyName: string): string;
/**
* Gets the label of a property with a given name.
* @param {string} sPropertyName - The property name.
* @returns {string} The label maintained for this property or null if it does not exist.
*/
public getPropertyLabel(sPropertyName: string): string;
/**
* Gets the quick info of a property with a given name.
* @param {string} sPropertyName - The property name.
* @returns {string} The quick info maintained for this property or null if it does not exist.
*/
public getPropertyQuickInfo(sPropertyName: string): string;
/**
* Gets the context for the root aggregation level representing the grand total for all bound measure properties.
*
* The context is assigned to parent group ID null
. If the binding is configured not to provide a grand total,
* this context is empty. If data for this context is not locally available yet, an OData request will be triggered to load it.
*
* This function must be called whenever the bound set of OData entities changes, e.g., by changing selected dimensions,
* modifying filter conditions, etc.
* @param {{ [key: string]: any }} mParameters - specifying how the top-most aggregation level shall be fetched. Supported parameters are: - numberOfExpandedLevels: number of child levels that shall be fetched automatically
- startIndex: index of first entry to return from parent group ID
"/"
(zero-based) - length: number of entries to return at and after the given start index
- threshold: number of additional entries that shall be locally available in the binding for subsequent accesses to contexts of parent group ID
"/"
or below, if auto-expanding is selected
* @returns {any[]} Array with a single object of class sap.ui.model.Context for the root context, or an empty array if an OData request is pending to fetch requested contexts that are not yet locally available.
*/
public getRootContexts(mParameters: { [key: string]: any }): any[];
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public getRootContexts(...args: any[]): any;
/**
* Gets the names of the sortable properties in the bound OData entity set.
* @returns {any[]} names of properties that can be used for sorting the result entities.
*/
public getSortablePropertyNames(): any[];
/**
* Gets the total number of entities in the bound OData entity set.
*
* Counting takes place at the lowest aggregation level defined by the possible value combinations for the complete set of
* dimension properties included in the bound entity set. This means that intermediate aggregate entities with
* sub-totals at higher aggregation levels are not counted.
* @returns {number} the total number of addressed entities in the OData entity set
*/
public getTotalSize(): number;
/**
* Determines if the binding has the entries of a given aggregation level locally available.
*
* If so, no further OData request is required to fetch any of them.
* @param {sap.ui.model.Context} oContext - the parent context identifying the aggregation level.
* @param {number} iLevel - the level number of oContext (because the context might occur at multiple levels).
* @returns {boolean} property of sap.ui.model.analytics.AnalyticalBinding.ContextsAvailabilityStatus, indicating whether all, some, or none of the entries are locally available.
*/
public hasAvailableNodeContexts(oContext: sap.ui.model.Context, iLevel: number): boolean;
/**
* Determines if the contexts in a specified group have further children. If so,
* any of these group contexts can be a parent context of a nested sub-group in
* a subsequent aggregation level.
* @param {sap.ui.model.Context} oContext - the parent context identifying the requested group of child contexts.
* @param {{ [key: string]: any }} mParameters - The only supported parameter is level as the level number of oContext (because the context might occur at multiple levels)
* @returns {boolean} true if and only if the contexts in the specified group have further children.
*/
public hasChildren(oContext: sap.ui.model.Context, mParameters: { [key: string]: any }): boolean;
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public hasChildren(...args: any[]): any;
/**
* Determines if any of the properties included in the bound OData entity set is a measure property.
* @returns {boolean} true if and only one or more properties are measure properties.
*/
public hasMeasures(): boolean;
/**
* Determines if a given name refers to a measure property
* @param {string} sPropertyName - The property name.
* @returns {boolean} true if and only if the bound OData entity set includes a measure property with this name.
*/
public isMeasure(sPropertyName: string): boolean;
/**
* Loads child contexts of multiple groups.
* @param {{ [key: string]: any }} mGroupIdRanges - specifies index ranges of child contexts to be loaded for multiple groups identified by their ID. A group index range is given by an object consisting of startIndex, length, threshold. For every group ID, the map holds an array of such range objects.
*/
public loadGroups(mGroupIdRanges: { [key: string]: any }): void;
/**
* Determines if the binding has been configured to provide a grand total for the selected measure properties.
* @returns {boolean} true if and only if the binding provides a context for the grand totals of all selected measure properties.
*/
public providesGrandTotal(): boolean;
/**
* Refreshes the binding, check whether the model data has been changed and fire change event if this is the case. For service side models this should refetch
* the data from the service. To update a control, even if no data has been changed, e.g. to reset a control after failed validation, please use the parameter
* bForceUpdate.
* @param {boolean} bForceUpdate - Update the bound control even if no data has been changed
*/
public refresh(bForceUpdate?: boolean): void;
/**
* Sets sorters for retrieving the entities in the bound OData entity set in a specific order.
*
* Invoking this function resets the state of the binding. Subsequent data requests such as calls to getNodeContexts() will
* need to trigger OData requests in order to fetch the data that are in line with these sorters.
* @param {sap.ui.model.Sorter|sap.ui.model.Sorter[]} aSorter - a sorter object or an array of sorter objects which define the sort order.
*/
public sort(aSorter: sap.ui.model.Sorter|sap.ui.model.Sorter[]): void;
/**
* Updates the binding's structure with new analytical information.
*
* Analytical information is the mapping of UI columns to properties in the bound OData entity set. Every column object contains
* the name of the bound property and in addition:
*
* - A column bound to a dimension property has further boolean properties:
*
* - grouped: dimension will be used for building groups
* - visible: if the column is visible, values for the related property will be fetched from the OData service
* - inResult: if the column is not visible, but declared to be part of the result, values for the related property
* will also be fetched from the OData service
*
*
* - A column bound to a measure property has further boolean properties:
*
* - total: totals and sub-totals will be provided for the measure at all aggregation levels
*
*
*
*
* Invoking this function resets the state of the binding and subsequent data requests such as calls to getNodeContexts() will
* need to trigger OData requests in order to fetch the data that are in line with this analytical information.
*
* Please be aware that a call of this function might lead to additional back-end requests, as well as a control re-rendering later on.
* Whenever possible use the API of the analytical control, instead of relying on the binding.
* @param {any[]} aColumns - an array with objects holding the analytical information for every column, from left to right.
*/
protected updateAnalyticalInfo(aColumns: any[]): void;
}
/**
*/
export class AnalyticalTreeBindingAdapter {
/**
* Adapter for TreeBindings to add the ListBinding functionality and use the
* tree structure in list based controls.
*/
protected constructor();
/**
* Retrieves the currently set number of expanded levels from the Binding (commonly an AnalyticalBinding).
* @returns {number} the number of expanded levels
*/
protected getNumberOfExpandedLevels(): number;
/**
* Checks if the AnalyticalBinding has totaled measures available.
* Used for rendering sum rows.
* @returns {boolean} wether the binding has totaled measures or not
*/
public hasTotaledMeasures(): boolean;
/**
* Sets the number of expanded levels on the TreeBinding (commonly an AnalyticalBinding).
* This is NOT the same as AnalyticalTreeBindingAdapter#collapse or AnalyticalTreeBindingAdapter#expand.
* Setting the number of expanded levels leads to different requests.
* This function is used by the AnalyticalTable for the ungroup/ungroup-all feature.
* @param {number} iLevels - the number of levels which should be expanded, minimum is 0
*/
protected setNumberOfExpandedLevels(iLevels: number): void;
}
/**
* Simple Response Collection Component, collects the responses for each sub-request inside a bigger batch request.
*
* Also handles clean-up after all responses (either success or error) have been collected.
* Instantiated in AnalyticalBinding.prototype._executeBatchRequest()
*/
export class BatchResponseCollector {
/**
* Constructor for a batch response collecting component.
* @param {any} mParams - optional Setup-Parameter, @see BatchResponseCollector#setup
*/
public constructor(mParams?: any);
/**
* Collects responses of type BatchResponseCollector.TYPE_SUCCESS and BatchResponseCollector.TYPE_ERROR.
*
* Keeps track of all collected responses and fires the necessary events after all responses for the
* requests, given in the constructor, have returned.
* @param {any} oResponse - the response which should be collected
* @param {string} sResponseType - the type of the response, either BatchResponseCollector.TYPE_SUCCESS or BatchResponseCollector.TYPE_ERROR
*/
public collect(oResponse: any, sResponseType?: string): void;
/**
* Convenience function to collect an error response.
*
* Internally BatchResponseCollector#collect is called, the second parameter is set to BatchResponseCollector.TYPE_ERROR
* @param {any} oResponse - the erroneous response object
*/
public error(oResponse: any): void;
/**
* Setup-Function to initialize/reset the BatchResponseCollector.
* @param {any} mParams - optional Setup-Parameter
*/
public setup(mParams?: any): void;
/**
* Convenience function to collect a success response.
*
* Internally BatchResponseCollector#collect is called with second parameter BatchResponseCollector.TYPE_SUCCESS
* @param {any} oResponse - the successful response, which should be collected
*/
public success(oResponse: any): void;
}
/**
* The OData4Analytics API is purely experimental, not yet functionally complete
* and not meant for productive usage. At present, its only purpose is to
* demonstrate how easy analytical extensions of OData4SAP can be consumed.
*
* USE OBJECTS VIA METHODS ONLY - DO NOT ACCESS JAVASCRIPT OBJECT PROPERTIES DIRECTLY !
*
* Lazy initialization of attributes will cause unexpected values when you
* access object attributes directly.
*/
namespace odata4analytics {
/**
* Specify which components of the dimension shall be included in the value
* set.
* @param {any} bIncludeText - Indicator whether or not to include the dimension text (if available) in the value set.
* @param {any} bIncludeAttributes - Indicator whether or not to include all dimension attributes (if available) in the value set.
*/
function includeDimensionTextAttributes(bIncludeText: any, bIncludeAttributes: any): void;
/**
* Representation of a property annotated with
* sap:aggregation-role="dimension".
*/
export class Dimension {
/**
* Create a representation of a dimension provided by an analytic query. Do not create your own instances.
* @param {sap.ui.model.analytics.odata4analytics.QueryResult} oQueryResult - The query result containing this dimension
* @param {any} oProperty - The DataJS object object representing the dimension
*/
public constructor(oQueryResult: sap.ui.model.analytics.odata4analytics.QueryResult, oProperty: any);
/**
* Find attribute by name
* @param {string} sName - Attribute name
* @returns {sap.ui.model.analytics.odata4analytics.Dimension} The dimension attribute object with this name or null if it does not exist
*/
public findAttributeByName(sName: string): sap.ui.model.analytics.odata4analytics.Dimension;
/**
* Get the names of all attributes included in this dimension
* @returns {string[]} List of all attribute names
*/
public getAllAttributeNames(): string[];
/**
* Get all attributes of this dimension
* @returns {any} An object with individual JS properties for each attribute of this dimension. The JS object properties all are objects of type odata4analytics.DimensionAttribute. The names of the JS object properties are given by the OData entity type property names representing the dimension attribute keys.
*/
public getAllAttributes(): any;
/**
* Get query result containing this dimension
* @returns {sap.ui.model.analytics.odata4analytics.QueryResult} The query result object
*/
public getContainingQueryResult(): sap.ui.model.analytics.odata4analytics.QueryResult;
/**
* Get associated hierarchy
* @returns {any} The hierarchy object or null if there is none. It can be an instance of class odata4analytics.RecursiveHierarchy (TODO later: or a leveled hierarchy). Use methods isLeveledHierarchy and isRecursiveHierarchy to determine object type.
*/
public getHierarchy(): any;
/**
* Get the key property
* @returns {any} The DataJS object representing the property for the dimension key
*/
public getKeyProperty(): any;
/**
* Get label
* @returns {string} The (possibly language-dependent) label text for this dimension
*/
public getLabelText(): string;
/**
* Get master data entity set for this dimension
* @returns {sap.ui.model.analytics.odata4analytics.EntitySet} The master data entity set for this dimension, or null, if it does not exist
*/
public getMasterDataEntitySet(): sap.ui.model.analytics.odata4analytics.EntitySet;
/**
* Get the name of the dimension
* @returns {string} The name of this dimension, which is identical to the name of the dimension key property in the entity type
*/
public getName(): string;
/**
* Get super-ordinate dimension
* @returns {any} The super-ordinate dimension or null if there is none
*/
public getSuperOrdinateDimension(): any;
/**
* Get text property related to this dimension
* @returns {any} The DataJS object representing the text property or null if it does not exist
*/
public getTextProperty(): any;
/**
* Get indicator whether or not master data is available for this dimension
* @returns {boolean} True iff master data is available
*/
public hasMasterData(): boolean;
}
/**
* Representation of a dimension attribute.
*/
export class DimensionAttribute {
/**
* Create a representation of a dimension attribute provided by an analytic
* query. Do not create your own instances.
* @param {sap.ui.model.analytics.odata4analytics.QueryResult} oQueryResult - The query result containing this dimension attribute
* @param {any} oProperty - The DataJS object object representing the dimension attribute
*/
public constructor(oQueryResult: sap.ui.model.analytics.odata4analytics.QueryResult, oProperty: any);
/**
* Get dimension
* @returns {sap.ui.model.analytics.odata4analytics.Dimension} The dimension object containing this attribute
*/
public getDimension(): sap.ui.model.analytics.odata4analytics.Dimension;
/**
* Get the key property
* @returns {any} The DataJS object representing the property for the key of this dimension attribute
*/
public getKeyProperty(): any;
/**
* Get label
* @returns {string} The (possibly language-dependent) label text for this dimension attribute
*/
public getLabelText(): string;
/**
* Get the name of the dimension attribute
* @returns {string} The name of the dimension attribute, which is identical to the name of the property in the entity type holding the attribute value
*/
public getName(): string;
/**
* Get text property related to this dimension attribute
* @returns {any} The DataJS object representing the text property or null if it does not exist
*/
public getTextProperty(): any;
}
/**
* Creation of URIs for fetching a query dimension value set.
*/
export class DimensionMemberSetRequest {
/**
* Create a request object for interaction with a dimension value help. Such a
* value help is served by either the query result entity set, in which case the
* returned dimension members are limited to those also used in the query result
* data. Or, the value help is populated by a master data entity set, if made
* available by the service. In this case, the result will include all valid
* members for that dimension.
* @param {sap.ui.model.analytics.odata4analytics.Dimension} oDimension - Description of a dimension
* @param {sap.ui.model.analytics.odata4analytics.ParameterizationRequest} oParameterizationRequest - (optional) Request object for interactions with the parameterization of the query result or (not yet supported) master data entity set Such an object is required if the entity set holding the dimension members includes parameters.
* @param {boolean} bUseMasterData - (optional) Indicates use of master data for determining the dimension members.
*/
public constructor(oDimension: sap.ui.model.analytics.odata4analytics.Dimension, oParameterizationRequest: sap.ui.model.analytics.odata4analytics.ParameterizationRequest, bUseMasterData: boolean);
/**
* Get the filter expression for this request.
*
* Expressions are represented by separate objects. If none exists so far, a
* new expression object gets created.
* @returns {sap.ui.model.analytics.odata4analytics.FilterExpression} The filter object associated to this request.
*/
public getFilterExpression(): sap.ui.model.analytics.odata4analytics.FilterExpression;
/**
* Returns the current page boundaries as object with properties
* start
and end
. If the end of the page is
* unbounded, end
is null.
* @returns {Object} the current page boundaries as object
*/
public getResultPageBoundaries(): Object;
/**
* Get the sort expression for this request.
*
* Expressions are represented by separate objects. If none exists so far, a
* new expression object gets created.
* @returns {sap.ui.model.analytics.odata4analytics.SortExpression} The sort object associated to this request.
*/
public getSortExpression(): sap.ui.model.analytics.odata4analytics.SortExpression;
/**
* Get the value of a query option for the OData request URI corresponding
* to this request.
* @param {string} sQueryOptionName - Identifies the query option: $select, $filter,... or any custom query option
* @returns {string} The value of the requested query option or null, if this option is not used for the OData request.
*/
public getURIQueryOptionValue(sQueryOptionName: string): string;
/**
* Get the URI to locate the entity set for the dimension memebers.
* @param {string} sServiceRootURI - (optional) Identifies the root of the OData service
* @returns {string} The resource path of the URI pointing to the entity set. It is a relative URI unless a service root is given, which would then prefixed in order to return a complete URL.
*/
public getURIToDimensionMemberEntitySet(sServiceRootURI: string): string;
/**
* Get the unescaped URI to fetch the dimension members, optionally
* augmented by text and attributes.
* @param {string} sServiceRootURI - (optional) Identifies the root of the OData service
* @returns {string} The unescaped URI that contains the OData resource path and OData system query options to express the request for the parameter value set..
*/
public getURIToDimensionMemberEntries(sServiceRootURI: string): string;
/**
* Set the filter expression for this request.
*
* Expressions are represented by separate objects. Calling this method
* replaces the filter object maintained by this request.
* @param {sap.ui.model.analytics.odata4analytics.FilterExpression} oFilter - The filter object to be associated with this request.
*/
public setFilterExpression(oFilter: sap.ui.model.analytics.odata4analytics.FilterExpression): void;
/**
* Set the parameterization request required for retrieving dimension
* members directly from the query result, if it is parameterized.
* @param {any} oParameterizationRequest - Request object for interactions with the parameterization of this query result
*/
public setParameterizationRequest(oParameterizationRequest: any): void;
/**
* Set further options to be applied for the OData request
* @param {boolean} bIncludeCount - Indicates whether or not the result shall include a count for the returned entities. Default is not to include it. Pass null to keep current setting.
*/
public setRequestOptions(bIncludeCount: boolean): void;
/**
* Specify that only a page of the query result shall be returned. A page is
* described by its boundaries, that are row numbers for the first and last
* rows in the query result to be returned.
* @param {number} start - The first row of the query result to be returned. Numbering starts at 1. Passing null is equivalent to start with the first row.
* @param {number} end - The last row of the query result to be returned. Passing null is equivalent to get all rows up to the end of the query result.
*/
public setResultPageBoundaries(start: number, end: number): void;
/**
* Set the sort expression for this request.
*
* Expressions are represented by separate objects. Calling this method
* replaces the sort object maintained by this request.
* @param {sap.ui.model.analytics.odata4analytics.SortExpression} oSorter - The sort object to be associated with this request.
*/
public setSortExpression(oSorter: sap.ui.model.analytics.odata4analytics.SortExpression): void;
}
/**
* Representation of an OData entity set.
*/
export class EntitySet {
/**
* Create a representation of an OData entity set in the context of an analytic
* query. Do not create your own instances.
* @param {any} oModel - DataJS object for the OData model containing this entity set
* @param {any} oSchema - DataJS object for the schema surrounding the container of this entity set
* @param {any} oContainer - DataJS object for the container holding this entity set
* @param {any} oEntitySet - DataJS object for the entity set
* @param {any} oEntityType - DataJS object for the entity type
*/
public constructor(oModel: any, oSchema: any, oContainer: any, oEntitySet: any, oEntityType: any);
/**
* Get entity type used for this entity set
* @returns {any} The DataJS object representing the entity type
*/
public getEntityType(): any;
/**
* Get the fully qualified name for this entity type
* @returns {string} The fully qualified name
*/
public getQName(): string;
/**
* Get full description for this entity set
* @returns {any} The DataJS object representing the entity set
*/
public getSetDescription(): any;
/**
* Get names of properties in this entity set that can be updated
* @returns {any} An object with individual JS properties for each updatable property. For testing whether propertyName is the name of an updatable property, use getUpdatablePropertyNameSet()[propertyName]
. The included JS object properties are all set to true.
*/
public getUpdatablePropertyNameSet(): any;
}
/**
* Representation of an OData entity type.
*/
export class EntityType {
/**
* Create a representation of an OData entity type in the context of an analytic
* query. Do not create your own instances.
* @param {any} oModel - DataJS object for the OData model containing this entity type
* @param {any} oSchema - DataJS object for the schema containing this entity type
* @param {any} oEntityType - DataJS object for the entity type
*/
public constructor(oModel: any, oSchema: any, oEntityType: any);
/**
* Find property by name
* @param {string} sPropertyName - Property name
* @returns {any} The DataJS object representing the property or null if it does not exist
*/
public findPropertyByName(sPropertyName: string): any;
/**
* Get the names of all properties with an associated hierarchy
* @returns {string[]} List of all property names
*/
public getAllHierarchyPropertyNames(): string[];
/**
* Get names of properties that can be filtered, that is they can be used in
* $filter expressions
* @returns {string[]} Array with names of properties that can be filtered.
*/
public getFilterablePropertyNames(): string[];
/**
* Get heading of the property with specified name (identified by property
* metadata annotation sap:heading)
* @param {string} sPropertyName - Property name
* @returns {string} The heading string
*/
public getHeadingOfProperty(sPropertyName: string): string;
/**
* Get the hierarchy associated to a given property Based on the current
* specification, hierarchies are always recursive. TODO: Extend behavior
* when leveled hierarchies get in scope
* @param {string} sName - Parameter name
* @returns {sap.ui.model.analytics.odata4analytics.RecursiveHierarchy} The hierarchy object or null if it does not exist
*/
public getHierarchy(sName: string): sap.ui.model.analytics.odata4analytics.RecursiveHierarchy;
/**
* Get key properties of this type
* @returns {string[]} The list of key property names
*/
public getKeyProperties(): string[];
/**
* Get label of the property with specified name (identified by property
* metadata annotation sap:label)
* @param {string} sPropertyName - Property name
* @returns {string} The label string
*/
public getLabelOfProperty(sPropertyName: string): string;
/**
* Get all properties
* @returns {any} Object with (JavaScript) properties, one for each (OData entity type) property. These (JavaScript) properties hold the DataJS object representing the property
*/
public getProperties(): any;
/**
* Get properties for which filter restrictions have been specified
* @returns {any} Object with (JavaScript) properties, one for each (OData entity type) property. The property value is from odata4analytics.EntityType.propertyFilterRestriction and indicates the filter restriction for this property.
*/
public getPropertiesWithFilterRestrictions(): any;
/**
* Get the fully qualified name for this entity type
* @returns {string} The fully qualified name
*/
public getQName(): string;
/**
* Get quick info of the property with specified name (identified by property
* metadata annotation sap:quickinfo)
* @param {string} sPropertyName - Property name
* @returns {string} The quick info string
*/
public getQuickInfoOfProperty(sPropertyName: string): string;
/**
* Get names of properties that must be filtered, that is they must appear
* in every $filter expression
* @returns {string[]} Array with names of properties that must be filtered.
*/
public getRequiredFilterPropertyNames(): string[];
/**
* Get names of properties that can be sorted, that is they can be used in
* $orderby expressions
* @returns {string[]} Array with names of properties that can be sorted.
*/
public getSortablePropertyNames(): string[];
/**
* Get the super-ordinate property related to the property with specified
* name (identified by property metadata annotation sap:super-ordinate)
* @param {string} sPropertyName - Property name
* @returns {any} The DataJS object representing the super-ordinate property or null if it does not exist
*/
public getSuperOrdinatePropertyOfProperty(sPropertyName: string): any;
/**
* Get the text property related to the property with specified name
* (identified by property metadata annotation sap:text)
* @param {string} sPropertyName - Property name
* @returns {any} The DataJS object representing the text property or null if it does not exist
*/
public getTextPropertyOfProperty(sPropertyName: string): any;
/**
* Get full description for this entity type
* @returns {any} The DataJS object representing the entity type
*/
public getTypeDescription(): any;
}
/**
* Representation of a $filter expression for an OData entity type.
*/
export class FilterExpression {
/**
* Create a representation of a filter expression for a given entity type. It can be rendered as value for the $filter system
* query option.
* @param {any} oModel - DataJS object for the OData model containing this entity type
* @param {any} oSchema - DataJS object for the schema containing this entity type
* @param {sap.ui.model.analytics.odata4analytics.EntityType} oEntityType - object for the entity type
*/
public constructor(oModel: any, oSchema: any, oEntityType: sap.ui.model.analytics.odata4analytics.EntityType);
/**
* Add a condition to the filter expression.
*
* Multiple conditions on the same property are combined with a logical OR first, and in a second step conditions for
* different properties are combined with a logical AND.
* @param {string} sPropertyName - The name of the property bound in the condition
* @param {sap.ui.model.FilterOperator} sOperator - operator used for the condition
* @param {any} oValue - value to be used for this condition
* @param {any} oValue2 - (optional) as second value to be used for this condition
* @returns {sap.ui.model.analytics.odata4analytics.FilterExpression} This object for method chaining
*/
public addCondition(sPropertyName: string, sOperator: sap.ui.model.FilterOperator, oValue: any, oValue2: any): sap.ui.model.analytics.odata4analytics.FilterExpression;
/**
* Add a set condition to the filter expression.
*
* A set condition tests if the value of a property is included in a set of given values. It is a convenience method for
* this particular use case eliminating the need for multiple API calls.
* @param {string} sPropertyName - The name of the property bound in the condition
* @param {any[]} aValues - values defining the set
* @returns {sap.ui.model.analytics.odata4analytics.FilterExpression} This object for method chaining
*/
public addSetCondition(sPropertyName: string, aValues: any[]): sap.ui.model.analytics.odata4analytics.FilterExpression;
/**
* Add an array of UI5 filter conditions to the filter expression.
*
* The UI5 filter condition is combined with the other given conditions using a logical AND. This method
* is particularly useful for passing forward already created UI5 filter arrays.
* @param {sap.ui.model.Filter[]} aUI5Filter - Array of UI5 filter objects
* @returns {sap.ui.model.analytics.odata4analytics.FilterExpression} This object for method chaining
*/
public addUI5FilterConditions(aUI5Filter: sap.ui.model.Filter[]): sap.ui.model.analytics.odata4analytics.FilterExpression;
/**
* Check if request is compliant with basic filter constraints expressed in metadata:
*
* (a) all properties required in the filter expression have been referenced (b) the single-value filter restrictions have been obeyed
* @returns {boolean} The value true. In case the expression violates some of the rules, an exception with some explanatory message is thrown
*/
public checkValidity(): boolean;
/**
* Clear expression from any conditions that may have been set previously
*/
public clear(): void;
/**
* Get description for this entity type
* @returns {sap.ui.model.analytics.odata4analytics.EntityType} The object representing the entity type
*/
public getEntityType(): sap.ui.model.analytics.odata4analytics.EntityType;
/**
* Get an array of SAPUI5 Filter objects corresponding to this expression.
* @returns {sap.ui.model.Filter[]} List of filter objects representing this expression
*/
public getExpressionAsUI5FilterArray(): sap.ui.model.Filter[];
/**
* Get the value for the OData system query option $filter corresponding to this expression.
* @returns {string} The $filter value for the filter expression
*/
public getURIFilterOptionValue(): string;
/**
* Remove all conditions for some property from the filter expression.
*
* All previously set conditions for some property are removed from the filter expression.
* @param {string} sPropertyName - The name of the property bound in the condition
* @returns {sap.ui.model.analytics.odata4analytics.FilterExpression} This object for method chaining
*/
public removeConditions(sPropertyName: string): sap.ui.model.analytics.odata4analytics.FilterExpression;
}
/**
* Representation of a property annotated with
* sap:aggregation-role="measure".
*/
export class Measure {
/**
* Create a representation of a measure provided by an analytic query. Do not create your own instances.
* @param {sap.ui.model.analytics.odata4analytics.QueryResult} oQueryResult - The query result containing this measure
* @param {any} oProperty - The DataJS object object representing the measure
*/
public constructor(oQueryResult: sap.ui.model.analytics.odata4analytics.QueryResult, oProperty: any);
/**
* Get the text property associated to the raw value property holding the
* formatted value related to this measure
* @returns {any} The DataJS object representing the property holding the formatted value text of this measure or null if this measure does not have a unit
*/
public getFormattedValueProperty(): any;
/**
* Get label
* @returns {string} The (possibly language-dependent) label text for this measure
*/
public getLabelText(): string;
/**
* Get the name of the measure
* @returns {string} The name of the measure, which is identical to the name of the measure raw value property in the entity type
*/
public getName(): string;
/**
* Get the raw value property
* @returns {any} The DataJS object representing the property holding the raw value of this measure
*/
public getRawValueProperty(): any;
/**
* Get the unit property related to this measure
* @returns {any} The DataJS object representing the unit property or null if this measure does not have a unit
*/
public getUnitProperty(): any;
/**
* Get indicator whether or not the measure is updatable
* @returns {boolean} True iff the measure is updatable
*/
public isUpdatable(): boolean;
}
/**
* Representation of an OData model with analytical annotations defined
* by OData4SAP.
*/
export class Model {
/**
* Create a representation of the analytical semantics of OData service metadata
* @param {any} oModelReference - An instance of ReferenceByURI, ReferenceByModel or ReferenceWithWorkaround for locating the OData service.
* @param {any} mParameter - Additional parameters for controlling the model construction. Currently supported are: sAnnotationJSONDoc - A JSON document providing extra annotations to the elements of the structure of the given service modelVersion - Parameter to define which ODataModel version should be used, in you use 'odata4analytics.Model.ReferenceByURI': 1 (default), 2 see also: AnalyticalVersionInfo constants
*/
public constructor(oModelReference: any, mParameter?: any);
/**
* Find analytic query result by name
* @param {string} sName - Fully qualified name of query result entity set
* @returns {sap.ui.model.analytics.odata4analytics.QueryResult} The query result object with this name or null if it does not exist
*/
public findQueryResultByName(sName: string): sap.ui.model.analytics.odata4analytics.QueryResult;
/**
* Get the names of all query results (entity sets) offered by the model
* @returns {string[]} List of all query result names
*/
public getAllQueryResultNames(): string[];
/**
* Get all query results offered by the model
* @returns {any} An object with individual JS properties for each query result included in the model. The JS object properties all are objects of type odata4analytics.QueryResult. The names of the JS object properties are given by the entity set names representing the query results.
*/
public getAllQueryResults(): any;
/**
* Get underlying OData model provided by SAP UI5
* @returns {any} The SAP UI5 representation of the model.
*/
public getODataModel(): any;
}
namespace Model {
/**
* Handle to an already instantiated SAP UI5 OData model.
*/
export class ReferenceByModel {
/**
* Create a reference to an OData model already loaded elsewhere with the help
* of SAP UI5.
* @param {any} oModel - holding the OData model.
*/
public constructor(oModel: any);
}
/**
* Handle to an OData model by the URI pointing to it.
*/
export class ReferenceByURI {
/**
* Create a reference to an OData model by the URI of the related OData service.
* @param {string} sURI - holding the URI.
*/
public constructor(sURI: string);
}
/**
* Handle to an already instantiated SAP UI5 OData model.
*/
export class ReferenceWithWorkaround {
/**
* Create a reference to an OData model having certain workarounds activated. A
* workaround is an implementation that changes the standard behavior of the API
* to overcome some gap or limitation in the OData provider. The workaround
* implementation can be conditionally activated by passing the identifier in
* the constructor.
*
* Known workaround identifiers are:
*
* "CreateLabelsFromTechnicalNames" - If a property has no label text, it
* gets generated from the property name.
*
* "IdentifyTextPropertiesByName" -If a dimension property has no text and
* another property with the same name and an appended "Name", "Text" etc.
* exists, they are linked via annotation.
* @param {any} oModel - holding a reference to the OData model, obtained by odata4analytics.Model.ReferenceByModel or by sap.odata4analytics.Model.ReferenceByURI.
* @param {string[]} aWorkaroundID - listing all workarounds to be applied.
*/
public constructor(oModel: any, aWorkaroundID: string[]);
}
}
/**
* Representation of a property annotated with sap:parameter.
*/
export class Parameter {
/**
* Create a representation of a single parameter contained in a parameterization. Do not create your own instances.
* @param {sap.ui.model.analytics.odata4analytics.Parameterization} oParameterization - The parameterization containing this parameter
* @param {any} oProperty - The DataJS object object representing the text property
*/
public constructor(oParameterization: sap.ui.model.analytics.odata4analytics.Parameterization, oProperty: any);
/**
* Get parameterization containing this parameter
* @returns {sap.ui.model.analytics.odata4analytics.Parameterization} The parameterization object
*/
public getContainingParameterization(): sap.ui.model.analytics.odata4analytics.Parameterization;
/**
* Get label
* @returns {string} The (possibly language-dependent) label text for this parameter
*/
public getLabelText(): string;
/**
* Get the name of the parameter
* @returns {string} The name of the parameter, which is identical with the name of the property representing the parameter in the parameterization entity type
*/
public getName(): string;
/**
* Get property for the parameter representing the peer boundary of the same
* interval
* @returns {sap.ui.model.analytics.odata4analytics.Parameter} The parameter representing the peer boundary of the same interval. This means that if *this* parameter is a lower boundary, the returned object
*/
public getPeerIntervalBoundaryParameter(): sap.ui.model.analytics.odata4analytics.Parameter;
/**
* Get property
* @returns {any} The DataJS object representing the property of this parameter
*/
public getProperty(): any;
/**
* Get text property related to this parameter
* @returns {any} The DataJS object representing the text property or null if it does not exist
*/
public getTextProperty(): any;
/**
* Get the URI to locate the entity set holding the value set, if it is
* available.
* @param {string} sServiceRootURI - (optional) Identifies the root of the OData service
* @returns {any} The resource path of the URI pointing to the entity set. It is a relative URI unless a service root is given, which would then prefixed in order to return a complete URL.
*/
public getURIToValueEntitySet(sServiceRootURI: string): any;
/**
* Get indicator if the parameter represents an interval boundary
* @returns {boolean} True iff it represents an interval boundary, otherwise false
*/
public isIntervalBoundary(): boolean;
/**
* Get indicator if the parameter represents the lower boundary of an
* interval
* @returns {boolean} True iff it represents the lower boundary of an interval, otherwise false
*/
public isLowerIntervalBoundary(): boolean;
/**
* Get indicator whether or not the parameter is optional
* @returns {boolean} True iff the parameter is optional
*/
public isOptional(): boolean;
/**
* Get indicator if a set of values is available for this parameter.
* Typically, this is true for parameters with a finite set of known values
* such as products, business partners in different roles, organization
* units, and false for integer or date parameters
* @returns {boolean} True iff a value set is available, otherwise false
*/
public isValueSetAvailable(): boolean;
}
/**
* Representation of an entity type annotated with
* sap:semantics="parameters".
*/
export class Parameterization {
/**
* Create a representation of a parameterization for an analytic query. Do not create your own instances.
* @param {sap.ui.model.analytics.odata4analytics.EntityType} oEntityType - The OData entity type for this parameterization
* @param {sap.ui.model.analytics.odata4analytics.EntitySet} oEntitySet - The OData entity set for this parameterization offered by the OData service
*/
public constructor(oEntityType: sap.ui.model.analytics.odata4analytics.EntityType, oEntitySet: sap.ui.model.analytics.odata4analytics.EntitySet);
/**
* Find parameter by name
* @param {string} sName - Parameter name
* @returns {sap.ui.model.analytics.odata4analytics.Parameter} The parameter object with this name or null if it does not exist
*/
public findParameterByName(sName: string): sap.ui.model.analytics.odata4analytics.Parameter;
/**
* Get the names of all parameters part of the parameterization
* @returns {string[]} List of all parameter names
*/
public getAllParameterNames(): string[];
/**
* Get all parameters included in this parameterization
* @returns {any} An object with individual JS properties for each parameter included in the query result. The JS object properties all are objects of type odata4analytics.Parameter. The names of the JS object properties are given by the OData entity type property names representing the parameter keys.
*/
public getAllParameters(): any;
/**
* Get the entity set representing this query result in the OData model
* @returns {sap.ui.model.analytics.odata4analytics.EntitySet} The OData entity set representing this query result
*/
public getEntitySet(): sap.ui.model.analytics.odata4analytics.EntitySet;
/**
* Get the entity type defining the type of this query result in the OData
* model
* @returns {sap.ui.model.analytics.odata4analytics.EntityType} The OData entity type for this query result
*/
public getEntityType(): sap.ui.model.analytics.odata4analytics.EntityType;
/**
* Get the name of the parameter
* @returns {string} The name of the parameterization, which is identical with the name of the entity set representing the parameterization in the OData service
*/
public getName(): string;
/**
* Get navigation property to query result
* @returns {sap.ui.model.analytics.odata4analytics.QueryResult} The parameter object with this name or null if it does not exist
*/
public getNavigationPropertyToQueryResult(): sap.ui.model.analytics.odata4analytics.QueryResult;
}
/**
* Creation of URIs for query parameterizations.
*/
export class ParameterizationRequest {
/**
* Create a request object for interaction with a query parameterization.
* @param {sap.ui.model.analytics.odata4analytics.Parameterization} oParameterization - Description of a query parameterization
*/
public constructor(oParameterization: sap.ui.model.analytics.odata4analytics.Parameterization);
/**
* Get the description of the parameterization on which this request
* operates on
* @returns {sap.ui.model.analytics.odata4analytics.Parameterization} Description of a query parameterization
*/
public getParameterization(): sap.ui.model.analytics.odata4analytics.Parameterization;
/**
* Get the URI to locate the entity set for the query parameterization.
* @param {string} sServiceRootURI - (optional) Identifies the root of the OData service
* @returns {any} The resource path of the URI pointing to the entity set. It is a relative URI unless a service root is given, which would then prefixed in order to return a complete URL.
*/
public getURIToParameterizationEntitySet(sServiceRootURI: string): any;
/**
* Get the URI to locate the parameterization entity for the values assigned
* to all parameters beforehand. Notice that a value must be supplied for
* every parameter including those marked as optional. For optional
* parameters, assign the special value that the service provider uses as an
* "omitted" value. For example, for services based on BW Easy Queries, this
* would be an empty string.
* @param {string} sServiceRootURI - (optional) Identifies the root of the OData service
* @returns {any} The resource path of the URI pointing to the entity set. It is a relative URI unless a service root is given, which would then prefixed in order to return a complete URL.
*/
public getURIToParameterizationEntry(sServiceRootURI: string): any;
/**
* Assign a value to a parameter
* @param {string} sParameterName - Name of the parameter. In case of a range value, provide the name of the lower boundary parameter.
* @param {string} sValue - Assigned value. Pass null to remove a value assignment.
* @param {string} sToValue - Omit it or set it to null for single values. If set, it will be assigned to the upper boundary parameter
*/
public setParameterValue(sParameterName: string, sValue: string, sToValue: string): void;
}
/**
* Creation of URIs for fetching a query parameter value set.
*/
export class ParameterValueSetRequest {
/**
* Create a request object for interaction with a query parameter value help.
* @param {sap.ui.model.analytics.odata4analytics.Parameter} oParameter - Description of a query parameter
*/
public constructor(oParameter: sap.ui.model.analytics.odata4analytics.Parameter);
/**
* Get the filter expression for this request.
*
* Expressions are represented by separate objects. If none exists so far, a
* new expression object gets created.
* @returns {sap.ui.model.analytics.odata4analytics.FilterExpression} The filter object associated to this request.
*/
public getFilterExpression(): sap.ui.model.analytics.odata4analytics.FilterExpression;
/**
* Get the sort expression for this request.
*
* Expressions are represented by separate objects. If none exists so far, a
* new expression object gets created.
* @returns {sap.ui.model.analytics.odata4analytics.SortExpression} The sort object associated to this request.
*/
public getSortExpression(): sap.ui.model.analytics.odata4analytics.SortExpression;
/**
* Get the value of a query option for the OData request URI corresponding
* to this request.
* @param {string} sQueryOptionName - Identifies the query option: $select, $filter,... or any custom query option
* @returns {string} The value of the requested query option or null, if this option is not used for the OData request.
*/
public getURIQueryOptionValue(sQueryOptionName: string): string;
/**
* Get the unescaped URI to fetch the parameter value set.
* @param {string} sServiceRootURI - (optional) Identifies the root of the OData service
* @returns {string} The unescaped URI that contains the OData resource path and OData system query options to express the request for the parameter value set..
*/
public getURIToParameterValueSetEntries(sServiceRootURI: string): string;
/**
* Specify which components of the parameter shall be included in the value
* set.
* @param {any} bIncludeText - Indicator whether or not to include the parameter text (if available) in the value set. Pass null to keep current setting.
*/
public includeParameterText(bIncludeText: any): void;
/**
* Set the filter expression for this request.
*
* Expressions are represented by separate objects. Calling this method
* replaces the filter object maintained by this request.
* @param {sap.ui.model.analytics.odata4analytics.FilterExpression} oFilter - The filter object to be associated with this request.
*/
public setFilterExpression(oFilter: sap.ui.model.analytics.odata4analytics.FilterExpression): void;
/**
* Set the sort expression for this request.
*
* Expressions are represented by separate objects. Calling this method
* replaces the sort object maintained by this request.
* @param {sap.ui.model.analytics.odata4analytics.SortExpression} oSorter - The sort object to be associated with this request.
*/
public setSortExpression(oSorter: sap.ui.model.analytics.odata4analytics.SortExpression): void;
}
/**
* Representation of an entity type annotated with
* sap:semantics="aggregate".
*/
export class QueryResult {
/**
* Create a representation of an analytic query. Do not create your own instances.
* @param {sap.ui.model.analytics.odata4analytics.Model} oModel - The analytical model containing this query result entity set
* @param {sap.ui.model.analytics.odata4analytics.EntityType} oEntityType - The OData entity type for this query
* @param {sap.ui.model.analytics.odata4analytics.EntitySet} oEntitySet - The OData entity set for this query offered by the OData service
* @param {sap.ui.model.analytics.odata4analytics.Parameterization} oParameterization - The parameterization of this query, if any
*/
public constructor(oModel: sap.ui.model.analytics.odata4analytics.Model, oEntityType: sap.ui.model.analytics.odata4analytics.EntityType, oEntitySet: sap.ui.model.analytics.odata4analytics.EntitySet, oParameterization: sap.ui.model.analytics.odata4analytics.Parameterization);
/**
* Find dimension by name
* @param {string} sName - Dimension name
* @returns {sap.ui.model.analytics.odata4analytics.Dimension} The dimension object with this name or null if it does not exist
*/
public findDimensionByName(sName: string): sap.ui.model.analytics.odata4analytics.Dimension;
/**
* Find dimension by property name
* @param {string} sName - Property name
* @returns {sap.ui.model.analytics.odata4analytics.Dimension} The dimension object to which the given property name is related, because the property holds the dimension key, its text, or is an attribute of this dimension. If no such dimension exists, null is returned.
*/
public findDimensionByPropertyName(sName: string): sap.ui.model.analytics.odata4analytics.Dimension;
/**
* Find measure by name
* @param {string} sName - Measure name
* @returns {sap.ui.model.analytics.odata4analytics.Measure} The measure object with this name or null if it does not exist
*/
public findMeasureByName(sName: string): sap.ui.model.analytics.odata4analytics.Measure;
/**
* Find measure by property name
* @param {string} sName - Property name
* @returns {sap.ui.model.analytics.odata4analytics.Measure} The measure object to which the given property name is related, because the property holds the raw measure value or its formatted value. If no such measure exists, null is returned.
*/
public findMeasureByPropertyName(sName: string): sap.ui.model.analytics.odata4analytics.Measure;
/**
* Get the names of all dimensions included in the query result
* @returns {string[]} List of all dimension names
*/
public getAllDimensionNames(): string[];
/**
* Get all dimensions included in this query result
* @returns {any} An object with individual JS properties for each dimension included in the query result. The JS object properties all are objects of type odata4analytics.Dimension. The names of the JS object properties are given by the OData entity type property names representing the dimension keys.
*/
public getAllDimensions(): any;
/**
* Get the names of all measures included in the query result
* @returns {string[]} List of all measure names
*/
public getAllMeasureNames(): string[];
/**
* Get all measures included in this query result
* @returns {any} An object with individual JS properties for each measure included in the query result. The JS object properties all are objects of type odata4analytics.Measure. The names of the JS object properties are given by the OData entity type property names representing the measure raw values.
*/
public getAllMeasures(): any;
/**
* Get the entity set representing this query result in the OData model
* @returns {sap.ui.model.analytics.odata4analytics.EntitySet} The OData entity set representing this query result
*/
public getEntitySet(): sap.ui.model.analytics.odata4analytics.EntitySet;
/**
* Get the entity type defining the type of this query result in the OData
* model
* @returns {sap.ui.model.analytics.odata4analytics.EntityType} The OData entity type for this query result
*/
public getEntityType(): sap.ui.model.analytics.odata4analytics.EntityType;
/**
* Get the analytical model containing the entity set for this query result
* @returns {any} The analytical representation of the OData model
*/
public getModel(): any;
/**
* Get the name of the query result
* @returns {string} The fully qualified name of the query result, which is identical with the name of the entity set representing the query result in the OData service
*/
public getName(): string;
/**
* Get the parameterization of this query result
* @returns {sap.ui.model.analytics.odata4analytics.Parameterization} The object for the parameterization or null if the query result is not parameterized
*/
public getParameterization(): sap.ui.model.analytics.odata4analytics.Parameterization;
/**
* Get property holding the totaled property list
* @returns {any} The DataJS object representing this property
*/
public getTotaledPropertiesListProperty(): any;
}
/**
* Creation of URIs for fetching query results.
*/
export class QueryResultRequest {
/**
* Create a request object for interaction with a query result.
* @param {sap.ui.model.analytics.odata4analytics.QueryResult} oQueryResult - Description of a query parameterization
* @param {sap.ui.model.analytics.odata4analytics.ParameterizationRequest} oParameterizationRequest - Request object for interactions with the parameterization of this query. Only required if the query service includes parameters.
*/
public constructor(oQueryResult: sap.ui.model.analytics.odata4analytics.QueryResult, oParameterizationRequest?: sap.ui.model.analytics.odata4analytics.ParameterizationRequest);
/**
* Add one or more dimensions to the aggregation level
* @param {any} aDimensionName - Array of dimension names to be added to the already defined aggregation level.
*/
public addToAggregationLevel(aDimensionName: any): void;
/**
* Get the names of the dimensions included in the aggregation level
* @returns {any[]} The dimension names included in the aggregation level
*/
public getAggregationLevel(): any[];
/**
* Get details about a dimensions included in the aggregation level
* @param {any} sDImensionName - Name of a dimension included in the aggregation level of this request, for which details shall be returned
* @returns {any} An object with three properties named key and text, both with Boolean values indicating whether the key and text of this dimension are included in this request. The third property named attributes is an array of attribute names of this dimension included in this request, or null, if there are none.
*/
public getAggregationLevelDetails(sDImensionName: any): any;
/**
* Get the filter expression for this request.
*
* Expressions are represented by separate objects. If none exists so far, a
* new expression object gets created.
* @returns {sap.ui.model.analytics.odata4analytics.FilterExpression} The filter object associated to this request.
*/
public getFilterExpression(): sap.ui.model.analytics.odata4analytics.FilterExpression;
/**
* Get the names of the measures included in the query result request
* @returns {any[]} The measure names included in the query result request
*/
public getMeasureNames(): any[];
/**
* Retrieves the current parametrization request
* @returns {sap.ui.model.analytics.odata4analytics.ParameterizationRequest}
*/
public getParameterizationRequest(): sap.ui.model.analytics.odata4analytics.ParameterizationRequest;
/**
* Get the description of the query result on which this request operates on
* @returns {sap.ui.model.analytics.odata4analytics.QueryResult} Description of a query result
*/
public getQueryResult(): sap.ui.model.analytics.odata4analytics.QueryResult;
/**
* Returns the current page boundaries as object with properties
* start
and end
. If the end of the page is
* unbounded, end
is null.
* @returns {Object} the current page boundaries as object
*/
public getResultPageBoundaries(): Object;
/**
* Get the sort expression for this request.
*
* Expressions are represented by separate objects. If none exists so far, a
* new expression object gets created.
* @returns {sap.ui.model.analytics.odata4analytics.SortExpression} The sort object associated to this request.
*/
public getSortExpression(): sap.ui.model.analytics.odata4analytics.SortExpression;
/**
* Get the value of a query option for the OData request URI corresponding
* to this request.
* @param {string} sQueryOptionName - Identifies the query option: $select, $filter,$orderby ... or any custom query option
* @returns {string} The value of the requested query option or null, if this option is not used for the OData request.
*/
public getURIQueryOptionValue(sQueryOptionName: string): string;
/**
* Get the URI to locate the entity set for the query result.
* @param {string} sServiceRootURI - (optional) Identifies the root of the OData service
* @returns {string} The resource path of the URI pointing to the entity set. It is a relative URI unless a service root is given, which would then prefixed in order to return a complete URL.
*/
public getURIToQueryResultEntitySet(sServiceRootURI: string): string;
/**
* Get the unescaped URI to fetch the query result.
* @param {string} sServiceRootURI - (optional) Identifies the root of the OData service
* @param {string} sResourcePath - (optional) OData resource path to be considered. If provided, it overwrites any parameterization object that might have been specified separately.
* @returns {string} The unescaped URI that contains the OData resource path and OData system query options to express the aggregation level, filter expression and further options.
*/
public getURIToQueryResultEntries(sServiceRootURI: string, sResourcePath: string): string;
/**
* Specify which dimension components shall be included in the query result.
* The settings get applied to the currently defined aggregation level.
* @param {any} sDimensionName - Name of the dimension for which the settings get applied. Specify null to apply the settings to all dimensions in the aggregation level.
* @param {any} bIncludeKey - Indicator whether or not to include the dimension key in the query result. Pass null to keep current setting.
* @param {any} bIncludeText - Indicator whether or not to include the dimension text (if available) in the query result. Pass null to keep current setting.
* @param {any} aAttributeName - Array of dimension attribute names to be included in the result. Pass null to keep current setting. This argument is ignored if sDimensionName is null.
*/
public includeDimensionKeyTextAttributes(sDimensionName: any, bIncludeKey: any, bIncludeText: any, aAttributeName: any): void;
/**
* Specify which measure components shall be included in the query result.
* The settings get applied to the currently set measures.
* @param {any} sMeasureName - Name of the measure for which the settings get applied. Specify null to apply the settings to all currently set measures.
* @param {any} bIncludeRawValue - Indicator whether or not to include the raw value in the query result. Pass null to keep current setting.
* @param {any} bIncludeFormattedValue - Indicator whether or not to include the formatted value (if available) in the query result. Pass null to keep current setting.
* @param {any} bIncludeUnit - Indicator whether or not to include the unit (if available) in the query result. Pass null to keep current setting.
*/
public includeMeasureRawFormattedValueUnit(sMeasureName: any, bIncludeRawValue: any, bIncludeFormattedValue: any, bIncludeUnit: any): void;
/**
* Remove one or more dimensions from the aggregation level. The method also
* removed a potential sort expression on the dimension.
* @param {any} aDimensionName - Array of dimension names to be removed from the already defined aggregation level.
*/
public removeFromAggregationLevel(aDimensionName: any): void;
/**
* Set the aggregation level for the query result request. By default, the
* query result will include the properties holding the keys of the given
* dimensions. This setting can be changed using
* includeDimensionKeyTextAttributes.
* @param {any} aDimensionName - Array of dimension names to be part of the aggregation level. If null, the aggregation level includes all dimensions, if empty, no dimension is included.
*/
public setAggregationLevel(aDimensionName: any): void;
/**
* Set the filter expression for this request.
*
* Expressions are represented by separate objects. Calling this method
* replaces the filter object maintained by this request.
* @param {sap.ui.model.analytics.odata4analytics.FilterExpression} oFilter - The filter object to be associated with this request.
*/
public setFilterExpression(oFilter: sap.ui.model.analytics.odata4analytics.FilterExpression): void;
/**
* Set the measures to be included in the query result request. By default,
* the query result will include the properties holding the raw values of
* the given measures. This setting can be changed using
* includeMeasureRawFormattedValueUnit.
* @param {any} aMeasureName - Array of measure names to be part of the query result request. If null, the request includes all measures, if empty, no measure is included.
*/
public setMeasures(aMeasureName: any): void;
/**
* Set the parameterization request required for interactions with the query
* result of parameterized queries. This method provides an alternative way
* to assign a parameterization request to a query result request.
* @param {any} oParameterizationRequest - Request object for interactions with the parameterization of this query
*/
public setParameterizationRequest(oParameterizationRequest: any): void;
/**
* Set further options to be applied for the OData request to fetch the
* query result
* @param {boolean} bIncludeEntityKey - Indicates whether or not the entity key should be returned for every entry in the query result. Default is not to include it. Pass null to keep current setting.
* @param {boolean} bIncludeCount - Indicates whether or not the result shall include a count for the returned entities. Default is not to include it. Pass null to keep current setting.
* @param {boolean} bReturnNoEntities - Indicates whether or not the result shall be empty. This will translate to $top=0 in the OData request and override any setting done with setResultPageBoundaries. The default is not to suppress entities in the result. Pass null to keep current setting. The main use case for this option is to create a request with $inlinecount returning an entity count.
*/
public setRequestOptions(bIncludeEntityKey: boolean, bIncludeCount: boolean, bReturnNoEntities: boolean): void;
/**
* Set the resource path to be considered for the OData request URI of this
* query request object. This method provides an alternative way to assign a
* path comprising a parameterization. If a path is provided, it overwrites
* any parameterization object that might have been specified separately.
* @param {any} sResourcePath - Resource path pointing to the entity set of the query result. Must include a valid parameterization if query contains parameters.
*/
public setResourcePath(sResourcePath: any): void;
/**
* Specify that only a page of the query result shall be returned. A page is
* described by its boundaries, that are row numbers for the first and last
* rows in the query result to be returned.
* @param {number} start - The first row of the query result to be returned. Numbering starts at 1. Passing null is equivalent to start with the first row.
* @param {number} end - The last row of the query result to be returned. Passing null is equivalent to get all rows up to the end of the query result.
*/
public setResultPageBoundaries(start: number, end: number): void;
/**
* Set the sort expression for this request.
*
* Expressions are represented by separate objects. Calling this method
* replaces the sort object maintained by this request.
* @param {sap.ui.model.analytics.odata4analytics.SortExpression} oSorter - The sort object to be associated with this request.
*/
public setSortExpression(oSorter: sap.ui.model.analytics.odata4analytics.SortExpression): void;
}
/**
* Representation of a recursive hierarchy.
*/
export class RecursiveHierarchy {
/**
* Create a representation of a recursive hierarchy defined on one multiple
* properties in an OData entity type query. Do not create your own instances.
* @param {sap.ui.model.analytics.odata4analytics.EntityType} oEntityType - object for the entity type
* @param {any} oNodeIDProperty - DataJS object for the property holding the hierarchy node ID identifying the hierarchy node to which the OData entry belongs
* @param {any} oParentNodeIDProperty - DataJS object for the property holding the node ID of the parent of the hierarchy node pointed to by the value of oNodeIDProperty
* @param {any} oNodeLevelProperty - DataJS object for the property holding the level number for the of the hierarchy node pointed to by the value of oNodeIDProperty
* @param {any} oNodeValueProperty - DataJS object for the property holding the data value for the of the hierarchy node pointed to by the value of oNodeIDProperty
*/
public constructor(oEntityType: sap.ui.model.analytics.odata4analytics.EntityType, oNodeIDProperty: any, oParentNodeIDProperty: any, oNodeLevelProperty: any, oNodeValueProperty: any);
/**
* Get the property holding the node ID of the hierarchy node
* @returns {any} The DataJS object representing this property
*/
public getNodeIDProperty(): any;
/**
* Get the property holding the level of the hierarchy node
* @returns {any} The DataJS object representing this property
*/
public getNodeLevelProperty(): any;
/**
* Get the property holding the value that is structurally organized by the
* hierarchy
* @returns {any} The DataJS object representing this property
*/
public getNodeValueProperty(): any;
/**
* Get the property holding the parent node ID of the hierarchy node
* @returns {any} The DataJS object representing this property
*/
public getParentNodeIDProperty(): any;
/**
* Get indicator if this is a leveled hierarchy
* @returns {boolean} False
*/
public isLeveledHierarchy(): boolean;
/**
* Get indicator if this is a recursive hierarchy
* @returns {boolean} True
*/
public isRecursiveHierarchy(): boolean;
}
/**
* Representation of a $orderby expression for an OData entity type.
*/
export class SortExpression {
/**
* Create a representation of an order by expression for a given entity type. It
* can be rendered as value for the $orderby system query option.
* @param {any} oModel - DataJS object for the OData model containing this entity type
* @param {any} oSchema - DataJS object for the schema containing this entity type
* @param {sap.ui.model.analytics.odata4analytics.EntityType} oEntityType - object for the entity type
*/
public constructor(oModel: any, oSchema: any, oEntityType: sap.ui.model.analytics.odata4analytics.EntityType);
/**
* Add a condition to the order by expression. It replaces any previously specified
* sort order for the property.
* @param {string} sPropertyName - The name of the property bound in the condition
* @param {sap.ui.model.analytics.odata4analytics.SortOrder} sSortOrder - sorting order used for the condition
* @returns {sap.ui.model.analytics.odata4analytics.SortExpression} This object for method chaining
*/
public addSorter(sPropertyName: string, sSortOrder: sap.ui.model.analytics.odata4analytics.SortOrder): sap.ui.model.analytics.odata4analytics.SortExpression;
/**
* Clear expression from any sort conditions that may have been set
* previously
*/
public clear(): void;
/**
* Get description for this entity type
* @returns {sap.ui.model.analytics.odata4analytics.EntityType} The object representing the entity type
*/
public getEntityType(): sap.ui.model.analytics.odata4analytics.EntityType;
/**
* Get the first SAPUI5 Sorter object.
* @returns {sap.ui.model.Sorter} first sorter object or null if empty
*/
public getExpressionAsUI5Sorter(): sap.ui.model.Sorter;
/**
* Get an array of SAPUI5 Sorter objects corresponding to this expression.
* @returns {sap.ui.model.Sorter[]} List of sorter objects representing this expression
*/
public getExpressionsAsUI5SorterArray(): sap.ui.model.Sorter[];
/**
* Get the value for the OData system query option $orderby corresponding to
* this expression.
* @param {any} oSelectedPropertyNames - Object with properties requested for $select
* @returns {string} The $orderby value for the sort expressions
*/
public getURIOrderByOptionValue(oSelectedPropertyNames: any): string;
/**
* Removes the order by expression for the given property name from the list
* of order by expression. If no order by expression with this property name
* exists the method does nothing.
* @param {string} sPropertyName - The name of the property to be removed from the condition
*/
public removeSorter(sPropertyName: string): void;
}
/**
* Sort order of a property.
*/
export enum SortOrder {
/**
* Sort Order: ascending.
*/
Ascending = "Ascending",
/**
* Sort Order: descending.
*/
Descending = "Descending",
}
}
}
/**
* The Binding is the object, which holds the necessary information for a data binding,
* like the binding path and the binding context, and acts like an interface to the
* model for the control, so it is the event provider for changes in the data model
* and provides getters for accessing properties or lists.
*/
export class Binding extends sap.ui.base.EventProvider {
/**
* Constructor for Binding class.
* @param {sap.ui.model.Model} oModel - the model
* @param {string} sPath - the path
* @param {sap.ui.model.Context} oContext - the context object
* @param {any} mParameters
*/
public constructor(oModel: sap.ui.model.Model, sPath: string, oContext: sap.ui.model.Context, mParameters?: any);
/**
* Attach event-handler fnFunction
to the 'AggregatedDataStateChange' event of this sap.ui.model.Binding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected attachAggregatedDataStateChange(fnFunction: Function, oListener?: any): void;
/**
* Attach event-handler fnFunction
to the 'change' event of this sap.ui.model.Model
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
public attachChange(fnFunction: Function, oListener?: any): void;
/**
* Attach event-handler fnFunction
to the 'dataReceived' event of this sap.ui.model.Binding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
public attachDataReceived(fnFunction: Function, oListener?: any): void;
/**
* Attach event-handler fnFunction
to the 'dataRequested' event of this sap.ui.model.Binding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
public attachDataRequested(fnFunction: Function, oListener?: any): void;
/**
* Attach event-handler fnFunction
to the 'DataStateChange' event of this sap.ui.model.Binding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected attachDataStateChange(fnFunction: Function, oListener?: any): void;
/**
* Attach multiple events.
* @param {any} oEvents
*/
protected attachEvents(oEvents: any): void;
/**
* Attach event-handler fnFunction
to the 'refresh' event of this sap.ui.model.Binding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected attachRefresh(fnFunction: Function, oListener?: any): void;
/**
* Removes all control messages for this binding from the MessageManager in addition to the standard clean-up tasks.
*/
public destroy(): void;
/**
* Detach event-handler fnFunction
from the 'AggregatedDataStateChange' event of this sap.ui.model.Binding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected detachAggregatedDataStateChange(fnFunction: Function, oListener?: any): void;
/**
* Detach event-handler fnFunction
from the 'change' event of this sap.ui.model.Model
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
public detachChange(fnFunction: Function, oListener?: any): void;
/**
* Detach event-handler fnFunction
from the 'dataReceived' event of this sap.ui.model.Binding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
public detachDataReceived(fnFunction: Function, oListener?: any): void;
/**
* Detach event-handler fnFunction
from the 'dataRequested' event of this sap.ui.model.Binding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
public detachDataRequested(fnFunction: Function, oListener?: any): void;
/**
* Detach event-handler fnFunction
from the 'DataStateChange' event of this sap.ui.model.Binding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected detachDataStateChange(fnFunction: Function, oListener?: any): void;
/**
* Detach multiple events-
* @param {any} oEvents
*/
protected detachEvents(oEvents: any): void;
/**
* Detach event-handler fnFunction
from the 'refresh' event of this sap.ui.model.Binding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected detachRefresh(fnFunction: Function, oListener?: any): void;
/**
* Creates a new subclass of class sap.ui.model.Binding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event dataReceived to attached listeners. This event may also be fired when an error occured.
* @param {{ [key: string]: any }} mArguments - the arguments to pass along with the event.
*/
protected fireDataReceived(mArguments: { [key: string]: any }): void;
/**
* Fire event dataRequested to attached listeners.
* @param {{ [key: string]: any }} mArguments - the arguments to pass along with the event.
*/
protected fireDataRequested(mArguments: { [key: string]: any }): void;
/**
* Returns a metadata object for class sap.ui.model.Binding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Initialize the binding. The message should be called when creating a binding.
* The default implementation calls checkUpdate(true).
*/
protected initialize(): void;
/**
* Returns whether the binding is initial, which means it did not get an initial value yet
* @returns {boolean} whether binding is initial
*/
public isInitial(): boolean;
/**
* Returns whether the binding is relative, which means it did not start with a /
* @returns {boolean} whether binding is relative
*/
public isRelative(): boolean;
/**
* Returns true if the binding is suspended or false if not.
* @returns {boolean} whether binding is suspended
*/
public isSuspended(): boolean;
/**
* Refreshes the binding, check whether the model data has been changed and fire change event
* if this is the case. For server side models this should refetch the data from the server.
* To update a control, even if no data has been changed, e.g. to reset a control after failed
* validation, please use the parameter bForceUpdate.
* @param {boolean} bForceUpdate - Update the bound control even if no data has been changed
*/
public refresh(bForceUpdate: boolean): void;
/**
* Resumes the binding update. Change events will be fired again.
*
* When the binding is resumed, a change event will be fired immediately, if the data has changed while the binding
* was suspended. For serverside models, a request to the server will be triggered, if a refresh was requested
* while the binding was suspended.
*/
public resume(): void;
/**
* Suspends the binding update. No change events will be fired.
*
* A refresh call with bForceUpdate set to true will also update the binding and fire a change in suspended mode.
* Special operations on bindings, which require updates to work properly (as paging or filtering in list bindings)
* will also update and cause a change event although the binding is suspended.
*/
public suspend(): void;
/**
* Determines if the binding should be updated by comparing the current model against a specified model.
* @param {any} oModel - The model instance to compare against
* @returns {boolean} true if this binding should be updated
*/
protected updateRequired(oModel: any): boolean;
}
/**
* Binding type definitions.
*/
export enum BindingMode {
/**
* BindingMode default means that the binding mode of the model is used
*/
Default = "Default",
/**
* BindingMode one time means value is only read from the model once
*/
OneTime = "OneTime",
/**
* BindingMode one way means from model to view
*/
OneWay = "OneWay",
/**
* BindingMode two way means from model to view and vice versa
*/
TwoWay = "TwoWay",
}
/**
* Change Reason for Model/ListBinding/TreeBinding.
*/
namespace ChangeReason {
/**
* A context was added to a binding.
*/
var Add: any;
/**
* Binding changes a model property value
*/
var Binding: any;
/**
* The list has changed
*/
var Change: any;
/**
* The tree node was collapsed
*/
var Collapse: any;
/**
* The list context has changed
*/
var Context: any;
/**
* The tree node was expanded
*/
var Expand: any;
/**
* The List was filtered
*/
var Filter: any;
/**
* The list was refreshed
*/
var Refresh: any;
/**
* The list was sorted
*/
var Sort: any;
}
/**
* The ContextBinding is a specific binding for a setting context for the model
*/
export class ClientContextBinding extends sap.ui.model.ContextBinding {
/**
* Constructor for ClientContextBinding
* @param {sap.ui.model.Model} oModel
* @param {string} sPath
* @param {Object} oContext
* @param {Object} mParameters
*/
public constructor(oModel: sap.ui.model.Model, sPath: string, oContext: Object, mParameters?: Object);
/**
* Creates a new subclass of class sap.ui.model.ClientContextBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.ContextBinding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.ClientContextBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Model implementation for Client models
*/
export class ClientModel extends sap.ui.model.Model {
/**
* Constructor for a new ClientModel.
* @param {any} oData - URL where to load the data from
*/
public constructor(oData: any);
/**
*/
public destroy(): void;
/**
* Creates a new subclass of class sap.ui.model.ClientModel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Force no caching.
* @param {boolean} bForceNoCache - whether to force not to cache
*/
public forceNoCache(bForceNoCache?: boolean): void;
/**
* Returns the current data of the model.
* Be aware that the returned object is a reference to the model data so all changes to that data will also change the model data.
* @returns {any} the data object
*/
public getData(): any;
/**
* Returns a metadata object for class sap.ui.model.ClientModel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* update all bindings
* @param {boolean} bForceUpdate - true/false: Default = false. If set to false an update will only be done when the value of a binding changed.
*/
public updateBindings(bForceUpdate: boolean): void;
}
/**
*/
export class ClientTreeBindingAdapter {
/**
* Adapter for TreeBindings to add the ListBinding functionality and use the
* tree structure in list based controls.
*/
protected constructor();
}
/**
* The CompositeBinding is used to bundle multiple property bindings which are be used to provide a single binding against
* these property bindings.
*/
export class CompositeBinding extends sap.ui.model.PropertyBinding {
/**
* Constructor for CompositeBinding
*/
public constructor();
/**
* Attach event-handler fnFunction
to the 'AggregatedDataStateChange' event of this
* sap.ui.model.CompositeBinding
. The CombinedDataStateChange event is fired asynchronously, meaning
* that the datastate object given as parameter of the event contains all changes that were applied to the datastate
* in the running thread.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected attachAggregatedDataStateChange(fnFunction: Function, oListener?: any): void;
/**
* Attach event-handler fnFunction
to the '_change' event of this sap.ui.model.CompositeBinding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
public attachChange(fnFunction: Function, oListener?: any): void;
/**
* Attach event-handler fnFunction
to the 'DataStateChange' event of this sap.ui.model.CompositeBinding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected attachDataStateChange(fnFunction: Function, oListener?: any): void;
/**
* Detach event-handler fnFunction
from the 'AggregatedDataStateChange' event of this sap.ui.model.CompositeBinding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected detachAggregatedDataStateChange(fnFunction: Function, oListener?: any): void;
/**
* Detach event-handler fnFunction
from the '_change' event of this sap.ui.model.CompositeBinding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
public detachChange(fnFunction: Function, oListener?: any): void;
/**
* Detach event-handler fnFunction
from the 'DataStateChange' event of this sap.ui.model.CompositeBinding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected detachDataStateChange(fnFunction: Function, oListener?: any): void;
/**
* Creates a new subclass of class sap.ui.model.CompositeBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.PropertyBinding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the property bindings contained in this composite binding.
* @returns {any[]} the property bindings in this composite binding
*/
public getBindings(): any[];
/**
* Returns the current external value of the bound target which is formatted via a type or formatter function.
* @returns {any} the current value of the bound target
*/
public getExternalValue(): any;
/**
* Returns a metadata object for class sap.ui.model.CompositeBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the raw values of the property bindings in an array.
* @returns {any} the values of the internal property bindings in an array
*/
public getValue(): any;
/**
* Initialize the binding. The message should be called when creating a binding.
* The default implementation calls checkUpdate(true).
* Prevent checkUpdate to be triggered while initializing nestend bindings, it is
* sufficient to call checkUpdate when all nested bindings are initialized.
*/
protected initialize(): void;
/**
* Suspends the binding update. No change events will be fired.
*
* A refresh call with bForceUpdate set to true will also update the binding and fire a change in suspended mode.
* Special operations on bindings, which require updates to work properly (as paging or filtering in list bindings)
* will also update and cause a change event although the binding is suspended.
*/
public resume(): void;
/**
* Sets the external value of a composite binding. If no CompositeType is assigned to the binding, the default
* implementation assumes a space separated list of values. This will cause the setValue to be called for each
* nested binding, except for undefined values in the array.
* @param {any} oValue - the value to set for this binding
*/
public setExternalValue(oValue: any): void;
/**
* Sets the optional type and internal type for the binding. The type and internal type are used to do the parsing/formatting correctly.
* The internal type is the property type of the element which the value is formatted to.
* @param {sap.ui.model.CompositeType} oType - the type for the binding
* @param {string} sInternalType - the internal type of the element property which this binding is bound against.
*/
public setType(oType: sap.ui.model.CompositeType, sInternalType: string): void;
/**
* Sets the values. This will cause the setValue to be called for each nested binding, except
* for undefined values in the array.
* @param {any[]} aValues - the values to set for this binding
*/
public setValue(aValues: any[]): void;
/**
* Suspends the binding update. No change events will be fired.
*
* A refresh call with bForceUpdate set to true will also update the binding and fire a change in suspended mode.
* Special operations on bindings, which require updates to work properly (as paging or filtering in list bindings)
* will also update and cause a change event although the binding is suspended.
*/
public suspend(): void;
/**
* Determines if the property bindings in the composite binding should be updated by calling updateRequired on all property bindings with the specified model.
* @param {any} oModel - The model instance to compare against
* @returns {boolean} true if this binding should be updated
*/
protected updateRequired(oModel: any): boolean;
}
/**
* Provides and update the status data of a binding.
* Depending on the models state and controls state changes, the data state is used to propagated changes to a control.
* The control can react on these changes by implementing the refreshDataState
method for the control.
* Here the the data state object is passed as a parameter.
*
* Using the {@link #getChanges getChanges} method the control can determine the changed properties and their old and new value.
*
* //sample implementation to handle message changes
* myControl.prototype.refreshDataState = function(oDataState) {
* var aMessages = oDataState.getChanges().messages;
* if (aMessages) {
* for (var i = 0; i < aMessages.length; i++) {
* console.log(aMessages.message);
* }
* }
* }
*
* //sample implementation to handle laundering state
* myControl.prototype.refreshDataState = function(oDataState) {
* var bLaundering = oDataState.getChanges().laundering || false;
* this.setBusy(bLaundering);
* }
*
* //sample implementation to handle dirty state
* myControl.prototype.refreshDataState = function(oDataState) {
* if (oDataState.isDirty()) console.log("Control " + this.getId() + " is now dirty");
* }
*
*
* Using the {@link #getProperty getProperty} method the control can read the properties of the data state. The properties are
*
* value
The value formatted by the formatter of the binding
* originalValue
The original value of the model formatted by the formatter of the binding
* invalidValue
The control value that was tried to be applied to the model but was rejected by a type validation
* modelMessages
The messages that were applied to the binding by the sap.ui.model.MessageModel
* controlMessages
The messages that were applied due to type validation errors
* messages
All messages of the data state
* dirty
true if the value was not yet confirmed by the server
*
*/
export class CompositeDataState extends sap.ui.model.DataState {
/**
*/
public constructor();
/**
* Returns or sets whether the data state is changed.
* As long as changed was not set to false the data state is dirty
* and the corresponding binding will fire data state change events.
* @param {boolean} bNewState - the optional new state
* @returns {boolean} whether the data state was changed.
*/
protected changed(bNewState?: boolean): boolean;
/**
* Creates a new subclass of class sap.ui.model.CompositeDataState with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.DataState.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the changes of the data state in a map that the control can use in the
* refreshDataState
method.
* The changed property's name is the key in the map. Each element in the map contains an object of below structure.
*
* {
* oldValue : The old value of the property,
* value : The new value of the property
* }
*
* The map only contains the changed properties.
* @returns {{ [key: string]: any }} the changed of the data state
*/
public getChanges(): { [key: string]: any };
/**
* Sets an array of control state messages.
* @param {sap.ui.core.Message[]} the - control messages
* @returns {sap.ui.core.Message[]} this
to allow method chaining
*/
public getControlMessages(the: sap.ui.core.Message[]): sap.ui.core.Message[];
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public getControlMessages(...args: any[]): any;
/**
* Returns an array of the properties set on the inner datastates
* @returns {any}
*/
protected getInternalProperty(): any;
/**
* Returns the dirty value of a binding that was rejected by a type validation.
* This value was of an incorrect type and could not be applied to the model. If the
* value was not rejected it will return null. In this case the current
* model value can be accessed using the getValue
method.
* @returns {any} the value that was rejected or null
*/
public getInvalidValue(): any;
/**
* Returns the array of all state messages or null.
* This combines the model and control messages.
* @returns {sap.ui.core.Message[]} the array of all messages or null if no {link:sap.ui.core.messages.ModelManager ModelManager} is used.
*/
public getMessages(): sap.ui.core.Message[];
/**
* Returns a metadata object for class sap.ui.model.CompositeDataState.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the array of state messages of the model or undefined
* @returns {sap.ui.core.Message[]} the array of messages of the model or null if no {link:sap.ui.core.messages.ModelManager ModelManager} is used.
*/
public getModelMessages(): sap.ui.core.Message[];
/**
* Returns whether the data state is dirty in the UI control.
* A data state is dirty in the UI control if the entered value did not yet pass the type validation.
* @returns {boolean} true if the data state is dirty
*/
public isControlDirty(): boolean;
/**
* Returns whether the data state is dirty.
* A data state is dirty if the value was changed
* but is not yet confirmed by a server or the entered value did not yet pass the type validation.
* @returns {boolean} true if the data state is dirty
*/
public isDirty(): boolean;
/**
* Returns whether the data state is in laundering.
* If data is send to the server the data state becomes laundering until the
* data was accepted or rejected.
* @returns {boolean} true if the data is laundering
*/
public isLaundering(): boolean;
}
/**
* This is an abstract base class for composite types. Composite types have multiple input values and know
* how to merge/split them upon formatting/parsing the value. Typical use case a currency or amount values.
*
* Subclasses of CompositeTypes can define boolean properties in the constructor:
* - bUseRawValues: the format and parse method will handle raw model values, types of embedded bindings are ignored
* - bParseWithValues: the parse method call will include the current binding values as a third parameter
*/
export class CompositeType extends sap.ui.model.SimpleType {
/**
* Constructor for a new CompositeType.
* @param {any} oFormatOptions - options as provided by concrete subclasses
* @param {any} oConstraints - constraints as supported by concrete subclasses
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.CompositeType with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.SimpleType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Format the given set of values in model representation to an output value in the given
* internal type. This happens according to the format options, if target type is 'string'.
* If aValues is not defined or null, null will be returned.
* @param {any[]} aValues - the values to be formatted
* @param {string} sInternalType - the target type
* @returns {any} the formatted output value
*/
public formatValue(aValues: any[], sInternalType: string): any;
/**
* Returns a metadata object for class sap.ui.model.CompositeType.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Parse a value of an internal type to the expected set of values of the model type.
* @param {any} oValue - the value to be parsed
* @param {string} sInternalType - the source type
* @param {any[]} aCurrentValues - the current values of all binding parts
* @returns {any[]} the parse result array
*/
public parseValue(oValue: any, sInternalType: string, aCurrentValues: any[]): any[];
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public parseValue(...args: any[]): any;
/**
* Validate whether a given value in model representation is valid and meets the
* defined constraints (if any).
* @param {any[]} aValues - the set of values to be validated
*/
public validateValue(aValues: any[]): void;
}
/**
* The Context is a pointer to an object in the model data, which is used to
* allow definition of relative bindings, which are resolved relative to the
* defined object.
* Context elements are created either by the ListBinding for each list entry
* or by using createBindingContext.
*/
export class Context extends sap.ui.base.Object {
/**
* Constructor for Context class.
* @param {sap.ui.model.Model} oModel - the model
* @param {string} sPath - the binding path
*/
public constructor(oModel: sap.ui.model.Model, sPath: string);
/**
* Creates a new subclass of class sap.ui.model.Context with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.Context.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Getter for model
* @returns {sap.ui.model.Model} the model
*/
public getModel(): sap.ui.model.Model;
/**
* Gets the (model dependent) object the context points to or the object with the given relative binding path
* @param {string} sPath - the binding path
* @param {any} mParameters - additional model specific parameters (optional)
* @returns {any} the context object
*/
public getObject(sPath?: string, mParameters?: any): any;
/**
* Getter for path of the context itself or a subpath
* @param {string} sPath - the binding path
* @returns {string} the binding path
*/
public getPath(sPath: string): string;
/**
* Gets the property with the given relative binding path
* @param {string} sPath - the binding path
* @returns {any} the property value
*/
public getProperty(sPath: string): any;
}
/**
* The ContextBinding is a specific binding for a setting context for the model
*/
export class ContextBinding extends sap.ui.model.Binding {
/**
* Constructor for ContextBinding
* @param {sap.ui.model.Model} oModel
* @param {string} sPath
* @param {Object} oContext
* @param {Object} mParameters
* @param {Object} oEvents - object defining event handlers
*/
public constructor(oModel: sap.ui.model.Model, sPath: string, oContext: Object, mParameters?: Object, oEvents?: Object);
/**
* Creates a new subclass of class sap.ui.model.ContextBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.Binding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.ContextBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Control-based DataBinding
*/
namespace control {
}
/**
* Provides and update the status data of a binding.
* Depending on the models state and controls state changes, the data state is used to propagated changes to a control.
* The control can react on these changes by implementing the refreshDataState
method for the control.
* Here the the data state object is passed as a parameter.
*
* Using the {@link #getChanges getChanges} method the control can determine the changed properties and their old and new value.
*
* //sample implementation to handle message changes
* myControl.prototype.refreshDataState = function(oDataState) {
* var aMessages = oDataState.getChanges().messages;
* if (aMessages) {
* for (var i = 0; i < aMessages.length; i++) {
* console.log(aMessages.message);
* }
* }
* }
*
* //sample implementation to handle laundering state
* myControl.prototype.refreshDataState = function(oDataState) {
* var bLaundering = oDataState.getChanges().laundering || false;
* this.setBusy(bLaundering);
* }
*
* //sample implementation to handle dirty state
* myControl.prototype.refreshDataState = function(oDataState) {
* if (oDataState.isDirty()) console.log("Control " + this.getId() + " is now dirty");
* }
*
*
* Using the {@link #getProperty getProperty} method the control can read the properties of the data state. The properties are
*
* value
The value formatted by the formatter of the binding
* originalValue
The original value of the model formatted by the formatter of the binding
* invalidValue
The control value that was tried to be applied to the model but was rejected by a type validation
* modelMessages
The messages that were applied to the binding by the sap.ui.model.MessageModel
* controlMessages
The messages that were applied due to type validation errors
* messages
All messages of the data state
* dirty
true if the value was not yet confirmed by the server
*
*/
export class DataState extends sap.ui.base.Object {
/**
*/
public constructor();
/**
* Returns or sets whether the data state is changed.
* As long as changed was not set to false the data state is dirty
* and the corresponding binding will fire data state change events.
* @param {boolean} bNewState - the optional new state
* @returns {boolean} whether the data state was changed.
*/
protected changed(bNewState?: boolean): boolean;
/**
* Creates a new subclass of class sap.ui.model.DataState with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the changes of the data state in a map that the control can use in the
* refreshDataState
method.
* The changed property's name is the key in the map. Each element in the map contains an object of below structure.
*
* {
* oldValue : The old value of the property,
* value : The new value of the property
* }
*
* The map only contains the changed properties.
* @returns {{ [key: string]: any }} the changed of the data state
*/
public getChanges(): { [key: string]: any };
/**
* Returns the array of state messages of the control or undefined.
* @returns {sap.ui.core.Message[]} the array of messages of the control or null if no {link:sap.ui.core.messages.ModelManager ModelManager} is used.
*/
public getControlMessages(): sap.ui.core.Message[];
/**
* Returns the dirty value of a binding that was rejected by a type validation.
* This value was of an incorrect type and could not be applied to the model. If the
* value was not rejected it will return null. In this case the current
* model value can be accessed using the getValue
method.
* @returns {any} the value that was rejected or null
*/
public getInvalidValue(): any;
/**
* Returns the array of all state messages or null.
* This combines the model and control messages.
* @returns {sap.ui.core.Message[]} the array of all messages or null if no {link:sap.ui.core.messages.ModelManager ModelManager} is used.
*/
public getMessages(): sap.ui.core.Message[];
/**
* Returns a metadata object for class sap.ui.model.DataState.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the array of state messages of the model or undefined
* @returns {sap.ui.core.Message[]} the array of messages of the model or null if no {link:sap.ui.core.messages.ModelManager ModelManager} is used.
*/
public getModelMessages(): sap.ui.core.Message[];
/**
* Returns the formatted original value of the data.
* The original value is the last confirmed value.
* @returns {any} the original confirmed value of the server
*/
public getOriginalValue(): any;
/**
* Returns the formatted value of the data state.
* @returns {any} The value of the data.
*/
public getValue(): any;
/**
* Returns whether the data state is dirty in the UI control.
* A data state is dirty in the UI control if the entered value did not yet pass the type validation.
* @returns {boolean} true if the data state is dirty
*/
public isControlDirty(): boolean;
/**
* Returns whether the data state is dirty.
* A data state is dirty if the value was changed
* but is not yet confirmed by a server or the entered value did not yet pass the type validation.
* @returns {boolean} true if the data state is dirty
*/
public isDirty(): boolean;
/**
* Returns whether the data state is in laundering.
* If data is send to the server the data state becomes laundering until the
* data was accepted or rejected.
* @returns {boolean} true if the data is laundering
*/
public isLaundering(): boolean;
/**
* Sets an array of control state messages.
* @param {sap.ui.core.Message[]} the - control messages
* @returns {sap.ui.model.DataState} this
to allow method chaining
*/
protected setControlMessages(the: sap.ui.core.Message[]): sap.ui.model.DataState;
/**
* Sets the dirty value that was rejected by the type validation.
* @param {any} vInvalidValue - the value that was rejected by the type validation or null if the value was valid
* @returns {sap.ui.model.DataState} this
to allow method chaining
*/
protected setInvalidValue(vInvalidValue: any): sap.ui.model.DataState;
/**
* Sets the laundering state of the data state.
* @param {boolean} bLaundering - true if the state is laundering
* @returns {sap.ui.model.DataState} this
to allow method chaining
*/
protected setLaundering(bLaundering: boolean): sap.ui.model.DataState;
/**
* Sets an array of model state messages.
* @param {any[]} the - model messages for this data state.
* @returns {sap.ui.model.DataState} this
to allow method chaining
*/
public setModelMessages(the: any[]): sap.ui.model.DataState;
/**
* Sets the formatted original value of the data.
* @param {boolean} vOriginalValue - the original value
* @returns {sap.ui.model.DataState} this
to allow method chaining
*/
protected setOriginalValue(vOriginalValue: boolean): sap.ui.model.DataState;
/**
* Sets the formatted value of the data state,
* @param {any} vValue - the value
* @returns {sap.ui.model.DataState} this
to allow method chaining
*/
protected setValue(vValue: any): sap.ui.model.DataState;
}
/**
* Filter for the list binding.
*/
export class Filter extends sap.ui.base.Object {
/**
* Constructor for Filter.
*
* You either pass a single object literal with the filter parameters or use the individual constructor arguments.
* No matter which variant is used, only certain combinations of parameters are supported
* (the following list uses the names from the object literal):
*
* - A
path
, operator
and one or two values (value1
, value2
), depending on the operator
* - A
path
and a custom filter function test
* - An array of other filters named
filters
and a Boolean flag and
that specifies whether to combine
* the filters with an AND (true
) or an OR (false
) operator.
*
* An error will be logged to the console if an invalid combination of parameters is provided.
* Please note that a model implementation may not support a custom filter function, e.g. if the model does not perform client side filtering.
* It also depends on the model implementation if the filtering is case sensitive or not.
* See particular model documentation for details.
*
* The filter operators Any
and All
are only supported in V4 OData models.
* When creating a filter instance with these filter operators, the argument variable
only accepts a string identifier and condition
needs to be another filter instance.
* @param {any|string|sap.ui.model.Filter[]} vFilterInfo - Filter info object or a path or an array of filters
* @param {sap.ui.model.FilterOperator|Function|boolean} vOperator - Either a filter operator or a custom filter function or a Boolean flag that defines how to combine multiple filters
* @param {any} vValue1 - First value to use with the given filter operator
* @param {any} vValue2 - Second value to use with the given filter operator (only for some operators)
*/
public constructor(vFilterInfo: any|string|sap.ui.model.Filter[], vOperator?: sap.ui.model.FilterOperator|Function|boolean, vValue1?: any, vValue2?: any);
/**
* Compares two values
*
* This is the default comparator function used for clientside filtering, if no custom comparator is given in the
* constructor. It does compare just by using equal/less than/greater than with automatic type casting, except
* for null values, which are always last, and string values where localeCompare is used.
*
* The comparator method returns -1, 0 or 1, depending on the order of the two items and is
* suitable to be used as a comparator method for Array.sort.
* @param {any} a - the first value to compare
* @param {any} b - the second value to compare
* @returns {number} -1, 0 or 1 depending on the compare result
*/
public static defaultComparator(a: any, b: any): number;
/**
* Creates a new subclass of class sap.ui.model.Filter with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.Filter.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Operators for the Filter.
*/
export enum FilterOperator {
/**
* Used to filter a list based on filter criteria that are defined in a nested filter for dependent subitems.
* All
returns a list of those items for which all dependent subitems match the filter criteria of the nested filter.
* For example, a list of customers can be filtered by filter criteria that are applied to the list of orders the customer placed in the past.
* The filter returns a list of those customers that always ordered a specific product.
*
* This filter operator is only supported in OData V4 models.
*/
All = "All",
/**
* Used to filter a list based on filter criteria that are defined in a nested filter for dependent subitems.
* Any
returns a list of those items for which at least one dependent subitem matches the filter criteria of the nested filter.
* For example, a list of customers can be filtered by filter criteria that are applied to the list of orders the customer placed in the past.
* The filter returns a list of those customers that at least once ordered a specific product.
*
* This filter operator is only supported in OData V4 models.
*/
Any = "Any",
/**
* FilterOperator between
* When used on strings, the BT operator might not behave intuitively. For example,
* when filtering a list of Names with BT "A", "B", all Names starting with "A" will be
* included as well as the name "B" itself, but no other name starting with "B".
*/
BT = "BT",
/**
* FilterOperator contains
*/
Contains = "Contains",
/**
* FilterOperator ends with
*/
EndsWith = "EndsWith",
/**
* FilterOperator equals
*/
EQ = "EQ",
/**
* FilterOperator greater or equals
*/
GE = "GE",
/**
* FilterOperator greater than
*/
GT = "GT",
/**
* FilterOperator less or equals
*/
LE = "LE",
/**
* FilterOperator less than
*/
LT = "LT",
/**
* FilterOperator not equals
*/
NE = "NE",
/**
* FilterOperator starts with
*/
StartsWith = "StartsWith",
}
/**
* Types of Filters.
*/
export enum FilterType {
/**
* Filters which are changed by the application
*/
Application = "Application",
/**
* Filters which are set by the different controls
*/
Control = "Control",
}
/**
* JSON-based DataBinding
*/
namespace json {
/**
* Model implementation for JSON format
*
* The observation feature is experimental! When observation is activated, the application can directly change the
* JS objects without the need to call setData, setProperty or refresh. Observation does only work for existing
* properties in the JSON, it can not detect new properties or new array entries.
*/
export class JSONModel extends sap.ui.model.ClientModel {
/**
* Constructor for a new JSONModel.
* @param {any} oData - either the URL where to load the JSON from or a JS object
* @param {boolean} bObserve - whether to observe the JSON data for property changes (experimental)
*/
public constructor(oData: any, bObserve: boolean);
/**
* Creates a new subclass of class sap.ui.model.json.JSONModel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.ClientModel.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Serializes the current JSON data of the model into a string.
* Note: May not work in Internet Explorer 8 because of lacking JSON support (works only if IE 8 mode is enabled)
* @returns {string} sJSON the JSON data serialized as string
*/
public getJSON(): string;
/**
* Returns a metadata object for class sap.ui.model.json.JSONModel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the value for the property with the given sPropertyName
* @param {string} sPath - the path to the property
* @param {any} oContext - the context which will be used to retrieve the property
* @returns {any} the value of the property
*/
public getProperty(sPath: string, oContext?: any): any;
/**
* Load JSON-encoded data from the server using a GET HTTP request and store the resulting JSON data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {any|string} oParameters - A map or string that is sent to the server with the request. Data that is sent to the server is appended to the URL as a query string. If the value of the data parameter is an object (map), it is converted to a string and url-encoded before it is appended to the URL.
* @param {boolean} bAsync - By default, all requests are sent asynchronous (i.e. this is set to true by default). If you need synchronous requests, set this option to false. Cross-domain requests do not support synchronous operation. Note that synchronous requests may temporarily lock the browser, disabling any actions while the request is active.
* @param {string} sType - The type of request to make ("POST" or "GET"), default is "GET". Note: Other HTTP request methods, such as PUT and DELETE, can also be used here, but they are not supported by all browsers.
* @param {boolean} bMerge - whether the data should be merged instead of replaced
* @param {string} bCache - force no caching if false. Default is false
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, oParameters?: any|string, bAsync?: boolean, sType?: string, bMerge?: boolean, bCache?: string, mHeaders?: any): void;
/**
* Sets the JSON encoded data to the model.
* @param {any} oData - the data to set on the model
* @param {boolean} bMerge - whether to merge the data instead of replacing it
*/
public setData(oData: any, bMerge?: boolean): void;
/**
* Sets the JSON encoded string data to the model.
* @param {string} sJSONText - the string data to set on the model
* @param {boolean} bMerge - whether to merge the data instead of replacing it
*/
public setJSON(sJSONText: string, bMerge?: boolean): void;
/**
* Sets a new value for the given property sPropertyName
in the model.
* If the model value changed all interested parties are informed.
* @param {string} sPath - path of the property to set
* @param {any} oValue - value to set the property to
* @param {any} oContext - the context which will be used to set the property
* @param {boolean} bAsyncUpdate - whether to update other bindings dependent on this property asynchronously
* @returns {boolean} true if the value was set correctly and false if errors occurred like the entry was not found.
*/
public setProperty(sPath: string, oValue: any, oContext?: any, bAsyncUpdate?: boolean): boolean;
}
/**
* Tree binding implementation for JSON format.
*
* The bound data can contain JSON objects and arrays. Both will be used to build the tree structure.
* You can optionally define a set of arrays to be used for the tree structure in the parameter arrayNames
.
* If this parameter is given all other objects and arrays will be ignored.
*/
export class JSONTreeBinding extends sap.ui.model.TreeBinding {
/**
* @param {string} sPath - Path pointing to the tree or array that should be bound
* @param {any} oContext - Context object for this binding
* @param {any[]} aFilters - Predefined filters contained in an array
* @param {any} mParameters - Additional model-specific parameters
*/
public constructor(sPath: string, oContext?: any, aFilters?: any[], mParameters?: any);
/**
* @param {sap.ui.model.json.JSONModel} oModel
* @param {string} sPath - Path pointing to the tree or array that should be bound
* @param {any} oContext - Context object for this binding
* @param {any[]} aFilters - Predefined filters contained in an array
* @param {any} mParameters - Additional model-specific parameters
*/
public constructor(oModel: sap.ui.model.json.JSONModel, sPath: string, oContext?: any, aFilters?: any[], mParameters?: any);
}
}
/**
* The ListBinding is a specific binding for lists in the model, which can be used
* to populate Tables or ItemLists.
*/
export class ListBinding extends sap.ui.model.Binding {
/**
* Constructor for ListBinding
* @param {sap.ui.model.Model} oModel
* @param {string} sPath
* @param {sap.ui.model.Context} oContext
* @param {any[]} aSorters - initial sort order (can be either a sorter or an array of sorters)
* @param {any[]} aFilters - predefined filter/s (can be either a filter or an array of filters)
* @param {any} mParameters
*/
public constructor(oModel: sap.ui.model.Model, sPath: string, oContext: sap.ui.model.Context, aSorters?: any[], aFilters?: any[], mParameters?: any);
/**
* Attach event-handler fnFunction
to the 'filter' event of this sap.ui.model.ListBinding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected attachFilter(fnFunction: Function, oListener?: any): void;
/**
* Attach event-handler fnFunction
to the 'sort' event of this sap.ui.model.ListBinding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected attachSort(fnFunction: Function, oListener?: any): void;
/**
* Detach event-handler fnFunction
from the 'filter' event of this sap.ui.model.ListBinding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected detachFilter(fnFunction: Function, oListener?: any): void;
/**
* Detach event-handler fnFunction
from the 'sort' event of this sap.ui.model.ListBinding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected detachSort(fnFunction: Function, oListener?: any): void;
/**
* Creates a new subclass of class sap.ui.model.ListBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.Binding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Filters the list according to the filter definitions
* @param {any[]} aFilters - Array of filter objects
* @param {sap.ui.model.FilterType} sFilterType - Type of the filter which should be adjusted, if it is not given, the standard behaviour applies
* @returns {sap.ui.model.ListBinding} returns this
to facilitate method chaining
*/
public filter(aFilters: any[], sFilterType: sap.ui.model.FilterType): sap.ui.model.ListBinding;
/**
* Returns an array of binding contexts for the bound target list.
*
* Note:The public usage of this method is deprecated, as calls from outside of controls will lead
* to unexpected side effects. For avoidance use {@link sap.ui.model.ListBinding.prototype.getCurrentContexts}
* instead.
* @param {number} iStartIndex - the startIndex where to start the retrieval of contexts
* @param {number} iLength - determines how many contexts to retrieve beginning from the start index.
* @returns {sap.ui.model.Context[]} the array of contexts for each row of the bound list
*/
protected getContexts(iStartIndex?: number, iLength?: number): sap.ui.model.Context[];
/**
* Returns an array of currently used binding contexts of the bound control
*
* This method does not trigger any data requests from the backend or delta calculation, but just returns the context
* array as last requested by the control. This can be used by the application to get access to the data currently
* displayed by a list control.
* @returns {sap.ui.model.Context[]} the array of contexts for each row of the bound list
*/
public getCurrentContexts(): sap.ui.model.Context[];
/**
* Returns list of distinct values for the given relative binding path
* @param {string} sPath - the relative binding path
* @returns {any[]} the array of distinct values.
*/
public getDistinctValues(sPath: string): any[];
/**
* Gets the group for the given context.
* Must only be called if isGrouped() returns that grouping is enabled for this binding. The grouping will be
* performed using the first sorter (in case multiple sorters are defined).
* @param {sap.ui.model.Context} oContext - the binding context
* @returns {any} the group object containing a key property and optional custom properties
*/
public getGroup(oContext: sap.ui.model.Context): any;
/**
* Returns the number of entries in the list. This might be an estimated or preliminary length, in case
* the full length is not known yet, see method isLengthFinal().
* @returns {number} returns the number of entries in the list
*/
public getLength(): number;
/**
* Returns a metadata object for class sap.ui.model.ListBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Indicates whether grouping is enabled for the binding.
* Grouping is enabled for a list binding, if at least one sorter exists on the binding and the first sorter
* is a grouping sorter.
* @returns {boolean} whether grouping is enabled
*/
public isGrouped(): boolean;
/**
* Returns whether the length which can be retrieved using getLength() is a known, final length,
* or a preliminary or estimated length which may change if further data is requested.
* @returns {boolean} returns whether the length is final
*/
public isLengthFinal(): boolean;
/**
* Sorts the list according to the sorter object
* @param {sap.ui.model.Sorter|any[]} aSorters - the Sorter object or an array of sorters which defines the sort order
* @returns {sap.ui.model.ListBinding} returns this
to facilitate method chaining
*/
public sort(aSorters: sap.ui.model.Sorter|any[]): sap.ui.model.ListBinding;
}
/**
* Message DataBinding
*/
namespace message {
/**
* Model implementation for Messages
* *
*/
export class MessageModel extends sap.ui.model.ClientModel {
/**
* Constructor for a new JSONModel.
* @param {sap.ui.core.message.MessageManager} oMessageManager - The MessageManager instance
*/
public constructor(oMessageManager: sap.ui.core.message.MessageManager);
/**
* Creates a new subclass of class sap.ui.model.message.MessageModel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.ClientModel.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.message.MessageModel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the value for the property with the given sPropertyName
* @param {string} sPath - the path to the property
* @param {any} oContext - the context which will be used to retrieve the property
* @returns {any} the value of the property
*/
public getProperty(sPath: string, oContext?: any): any;
/**
* Sets the message data to the model.
* @param {any} oData - the data to set on the model
*/
public setData(oData: any): void;
/**
* Sets a new value for the given property sPropertyName
in the model.
* If the model value changed all interested parties are informed.
* @param {string} sPath - path of the property to set
* @param {any} oValue - value to set the property to
* @param {any} oContext - the context which will be used to set the property
*/
public setProperty(sPath: string, oValue: any, oContext?: any): void;
}
}
/**
* Model implementation for meta models
*/
export class MetaModel extends sap.ui.model.Model {
/**
* Constructor for a new MetaModel.
*/
public constructor();
/**
* Creates a new subclass of class sap.ui.model.MetaModel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.MetaModel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* This is an abstract base class for model objects.
*/
export class Model extends sap.ui.core.message.MessageProcessor {
/**
* Constructor for a new Model.
*
* Every Model is a MessageProcessor that is able to handle Messages with the normal binding path syntax in the target.
*/
public constructor();
/**
* Attach event-handler fnFunction
to the 'parseError' event of this sap.ui.model.Model
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
public attachParseError(fnFunction: Function, oListener?: any): sap.ui.model.Model;
/**
* Attach event-handler fnFunction
to the 'parseError' event of this sap.ui.model.Model
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
public attachParseError(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.Model;
/**
* Attach event-handler fnFunction
to the 'propertyChange' event of this sap.ui.model.Model
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
public attachPropertyChange(fnFunction: Function, oListener?: any): sap.ui.model.Model;
/**
* Attach event-handler fnFunction
to the 'propertyChange' event of this sap.ui.model.Model
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
public attachPropertyChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.Model;
/**
* Attach event-handler fnFunction
to the 'requestCompleted' event of this sap.ui.model.Model
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
public attachRequestCompleted(fnFunction: Function, oListener?: any): sap.ui.model.Model;
/**
* Attach event-handler fnFunction
to the 'requestCompleted' event of this sap.ui.model.Model
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
public attachRequestCompleted(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.Model;
/**
* Attach event-handler fnFunction
to the 'requestFailed' event of this sap.ui.model.Model
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
public attachRequestFailed(fnFunction: Function, oListener?: any): sap.ui.model.Model;
/**
* Attach event-handler fnFunction
to the 'requestFailed' event of this sap.ui.model.Model
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
public attachRequestFailed(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.Model;
/**
* Attach event-handler fnFunction
to the 'requestSent' event of this sap.ui.model.Model
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
public attachRequestSent(fnFunction: Function, oListener?: any): sap.ui.model.Model;
/**
* Attach event-handler fnFunction
to the 'requestSent' event of this sap.ui.model.Model
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
public attachRequestSent(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.Model;
/**
* Create ContextBinding
* @param {string|any} sPath - the path pointing to the property that should be bound or an object which contains the following parameter properties: path, context, parameters
* @param {any} oContext - the context object for this databinding (optional)
* @param {any} mParameters - additional model specific parameters (optional)
* @param {any} oEvents - event handlers can be passed to the binding ({change:myHandler})
* @returns {sap.ui.model.ContextBinding}
*/
public bindContext(sPath: string|any, oContext?: any, mParameters?: any, oEvents?: any): sap.ui.model.ContextBinding;
/**
* Implement in inheriting classes
* @param {string} sPath - the path pointing to the list / array that should be bound
* @param {any} oContext - the context object for this databinding (optional)
* @param {sap.ui.model.Sorter} aSorters - initial sort order (can be either a sorter or an array of sorters) (optional)
* @param {any[]} aFilters - predefined filter/s (can be either a filter or an array of filters) (optional)
* @param {any} mParameters - additional model specific parameters (optional)
* @returns {sap.ui.model.ListBinding}
*/
public bindList(sPath: string, oContext?: any, aSorters?: sap.ui.model.Sorter, aFilters?: any[], mParameters?: any): sap.ui.model.ListBinding;
/**
* Implement in inheriting classes
* @param {string} sPath - the path pointing to the property that should be bound
* @param {any} oContext - the context object for this databinding (optional)
* @param {any} mParameters - additional model specific parameters (optional)
* @returns {sap.ui.model.PropertyBinding}
*/
public bindProperty(sPath: string, oContext?: any, mParameters?: any): sap.ui.model.PropertyBinding;
/**
* Implement in inheriting classes
* @param {string} sPath - the path pointing to the tree / array that should be bound
* @param {any} oContext - the context object for this databinding (optional)
* @param {any[]} aFilters - predefined filter/s contained in an array (optional)
* @param {any} mParameters - additional model specific parameters (optional)
* @param {any[]} aSorters - predefined sap.ui.model.sorter/s contained in an array (optional)
* @returns {sap.ui.model.TreeBinding}
*/
public bindTree(sPath: string, oContext?: any, aFilters?: any[], mParameters?: any, aSorters?: any[]): sap.ui.model.TreeBinding;
/**
* Checks whether the given filters contain an unsupported operator.
*
* OData v1, v2 and Client Bindings cannot be filtered with sap.ui.model.FilterOperator
"Any"
and "All"
.
* The model property mUnsupportedFilterOperators
can be configured in each model subclass
* to describe the unsupported operators.
*
* If any of the given filters contains nested filters, those are checked recursively.
* @param {sap.ui.model.Filter|sap.ui.model.Filter[]} vFilters - Single filter or an array of filter instances
*/
protected checkFilterOperation(vFilters: sap.ui.model.Filter|sap.ui.model.Filter[]): void;
/**
* Implement in inheriting classes
* @param {string} sPath - the path to create the new context from
* @param {any} oContext - the context which should be used to create the new binding context
* @param {any} mParameters - the parameters used to create the new binding context
* @param {Function} fnCallBack - the function which should be called after the binding context has been created
* @param {boolean} bReload - force reload even if data is already available. For server side models this should refetch the data from the server
* @returns {sap.ui.model.Context} the binding context, if it could be created synchronously
*/
public createBindingContext(sPath: string, oContext?: any, mParameters?: any, fnCallBack?: Function, bReload?: boolean): sap.ui.model.Context;
/**
* Destroys the model and clears the model data.
* A model implementation may override this function and perform model specific cleanup tasks e.g.
* abort requests, prevent new requests, etc.
*/
public destroy(): void;
/**
* Implement in inheriting classes
* @param {any} oContext - to destroy
*/
public destroyBindingContext(oContext: any): void;
/**
* Detach event-handler fnFunction
from the 'parseError' event of this sap.ui.model.Model
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
public detachParseError(fnFunction: Function, oListener: any): sap.ui.model.Model;
/**
* Detach event-handler fnFunction
from the 'propertyChange' event of this sap.ui.model.Model
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
public detachPropertyChange(fnFunction: Function, oListener: any): sap.ui.model.Model;
/**
* Detach event-handler fnFunction
from the 'requestCompleted' event of this sap.ui.model.Model
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
public detachRequestCompleted(fnFunction: Function, oListener: any): sap.ui.model.Model;
/**
* Detach event-handler fnFunction
from the 'requestFailed' event of this sap.ui.model.Model
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
public detachRequestFailed(fnFunction: Function, oListener: any): sap.ui.model.Model;
/**
* Detach event-handler fnFunction
from the 'requestSent' event of this sap.ui.model.Model
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
public detachRequestSent(fnFunction: Function, oListener: any): sap.ui.model.Model;
/**
* Creates a new subclass of class sap.ui.model.Model with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.message.MessageProcessor.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event parseError to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
protected fireParseError(mArguments?: any): sap.ui.model.Model;
/**
* Fire event propertyChange to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
protected firePropertyChange(mArguments?: any): sap.ui.model.Model;
/**
* Fire event requestCompleted to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
protected fireRequestCompleted(mArguments?: any): sap.ui.model.Model;
/**
* Fire event requestFailed to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
protected fireRequestFailed(mArguments?: any): sap.ui.model.Model;
/**
* Fire event requestSent to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.Model} this
to allow method chaining
*/
protected fireRequestSent(mArguments?: any): sap.ui.model.Model;
/**
* Get the default binding mode for the model
* @returns {sap.ui.model.BindingMode} default binding mode of the model
*/
public getDefaultBindingMode(): sap.ui.model.BindingMode;
/**
* Get messages for path
* @param {string} sPath - The binding path
* @returns {any}
*/
protected getMessagesByPath(sPath: string): any;
/**
* Returns a metadata object for class sap.ui.model.Model.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the meta model associated with this model if it is available for the concrete
* model type.
* @returns {sap.ui.model.MetaModel} The meta model or undefined if no meta model exists.
*/
public getMetaModel(): sap.ui.model.MetaModel;
/**
* Implement in inheriting classes
* @param {string} sPath - the path to where to read the object
* @param {any} oContext - the context with which the path should be resolved
* @param {any} mParameters - additional model specific parameters
* @returns {any}
*/
public getObject(sPath: string, oContext?: any, mParameters?: any): any;
/**
* Returns the original value for the property with the given path and context.
* The original value is the value that was last responded by a server if using a server model implementation.
* @param {string} sPath - the path/name of the property
* @param {any} oContext - the context if available to access the property value
* @returns {any} vValue the value of the property
*/
public getOriginalProperty(sPath: string, oContext?: any): any;
/**
* Implement in inheriting classes
* @param {string} sPath - the path to where to read the attribute value
* @param {any} oContext - the context with which the path should be resolved
* @returns {any}
*/
public getProperty(sPath: string, oContext?: any): any;
/**
* Check if the specified binding mode is supported by the model.
* @param {sap.ui.model.BindingMode} sMode - the binding mode to check
*/
public isBindingModeSupported(sMode: sap.ui.model.BindingMode): void;
/**
* Returns whether legacy path syntax is used
* @returns {boolean}
*/
public isLegacySyntax(): boolean;
/**
* Refresh the model.
* This will check all bindings for updated data and update the controls if data has been changed.
* @param {boolean} bForceUpdate - Update controls even if data has not been changed
*/
public refresh(bForceUpdate: boolean): void;
/**
* Set the default binding mode for the model. If the default binding mode should be changed,
* this method should be called directly after model instance creation and before any binding creation.
* Otherwise it is not guaranteed that the existing bindings will be updated with the new binding mode.
* @param {sap.ui.model.BindingMode} sMode - the default binding mode to set for the model
* @returns {sap.ui.model.Model} this pointer for chaining
*/
public setDefaultBindingMode(sMode: sap.ui.model.BindingMode): sap.ui.model.Model;
/**
* Enables legacy path syntax handling
*
* This defines, whether relative bindings, which do not have a defined
* binding context, should be compatible to earlier releases which means
* they are resolved relative to the root element or handled strict and
* stay unresolved until a binding context is set
* @param {boolean} bLegacySyntax - the path syntax to use
*/
public setLegacySyntax(bLegacySyntax: boolean): void;
/**
* Sets messages
* @param {any} mMessages - Messages for this model
*/
public setMessages(mMessages: any): void;
/**
* Set the maximum number of entries which are used for list bindings.
* @param {number} iSizeLimit - collection size limit
*/
public setSizeLimit(iSizeLimit: number): void;
}
/**
* OData-based DataBinding Utility Class
*/
namespace odata {
/**
* Adapter for TreeBindings to add the ListBinding functionality and use the
* tree structure in list based controls.
* Only usable with the sap.ui.table.TreeTable control.
* The functions defined here are only available when you are using a TreeTable and an ODataModel.
*/
function ODataTreeBindingAdapter(): void;
/**
* Adapter for TreeBindings to add the ListBinding functionality and use the
* tree structure in list based controls.
*/
function ODataTreeBindingFlat(): void;
/**
* A collection of methods which help to consume
*
* OData V4 annotations in XML template views. Every context argument must belong to a
* sap.ui.model.odata.ODataMetaModel
instance.
*
* Formatter functions like {@link #.format format} and {@link #.simplePath simplePath} can
* be used in complex bindings to turn OData V4 annotations into texts or data bindings,
* e.g. <sfi:SmartField value="{path : 'meta>Value', formatter :
* 'sap.ui.model.odata.AnnotationHelper.simplePath'}"/>
.
*
* Helper functions like {@link #.resolvePath resolvePath} can be used by template
* instructions in XML template views, e.g. <template:with path="meta>Value"
* helper="sap.ui.model.odata.AnnotationHelper.resolvePath" var="target">
.
*
* Since 1.31.0, you DO NOT need to {@link jQuery.sap.require} this module before use.
*/
namespace AnnotationHelper {
/**
* Creates a property setting (which is either a constant value or a binding info
* object) from the given parts and from the optional root formatter function.
* Each part can have one of the following types:
*
* boolean
, number
, undefined
: The part is
* a constant value.
*
* string
: The part is a data binding expression with complex
* binding syntax (for example, as created by {@link #.format format}) and is parsed
* accordingly to create either a constant value or a binding info object. Proper
* backslash escaping must be used for constant values with curly braces.
*
* object
: The part is a binding info object if it has a "path" or
* "parts" property, otherwise it is a constant value.
*
* If a binding info object is not the only part and has a "parts" property itself,
* then it must have no other properties except "formatter"; this is the case for
* expression bindings and data binding expressions created by {@link #.format format}.
*
* If all parts are constant values, the resulting property setting is also a constant
* value computed by applying the root formatter function to the constant parts once.
* If at least one part is a binding info object, the resulting property setting is
* also a binding info object and the root formatter function will be applied again and
* again to the current values of all parts, no matter whether constant or variable.
*
* Note: The root formatter function should not rely on its this
value
* because it depends on how the function is called.
*
* Note: A single data binding expression can be given directly to
* {@link sap.ui.base.ManagedObject#applySettings applySettings}, no need to call this
* function first.
*
* Example:
*
* function myRootFormatter(oValue1, oValue2, sFullName, sGreeting, iAnswer) {
* return ...; //TODO compute something useful from the given values
* }
*
* oSupplierContext = oMetaModel.getMetaContext("/ProductSet('HT-1021')/ToSupplier");
* oValueContext = oMetaModel.createBindingContext("com.sap.vocabularies.UI.v1.DataPoint/Value", oSupplierContext);
*
* vPropertySetting = sap.ui.model.odata.AnnotationHelper.createPropertySetting([
* sap.ui.model.odata.AnnotationHelper.format(oValueContext),
* "{path : 'meta>Value', formatter : 'sap.ui.model.odata.AnnotationHelper.simplePath'}",
* "{:= 'Mr. ' + ${/FirstName} + ' ' + ${/LastName}}",
* "hello, world!",
* 42
* ], myRootFormatter);
*
* oControl.applySettings({"someProperty" : vPropertySetting});
*
* @param {any[]} vParts - array of parts
* @param {Function} fnRootFormatter - root formatter function; default: Array.prototype.join(., " ")
in case of multiple parts, just like {@link sap.ui.model.CompositeBinding#getExternalValue getExternalValue}
* @returns {any|any} constant value or binding info object for a property as expected by {@link sap.ui.base.ManagedObject#applySettings applySettings}
*/
function createPropertySetting(vParts: any[], fnRootFormatter?: Function): any|any;
/**
* A formatter function to be used in a complex binding inside an XML template view
* in order to interpret OData V4 annotations. It knows about
*
* - the "14.4 Constant Expressions" for "edm:Bool", "edm:Date",
* "edm:DateTimeOffset", "edm:Decimal", "edm:Float", "edm:Guid", "edm:Int",
* "edm:TimeOfDay".
*
- the constant "14.4.11 Expression edm:String": This is turned into a fixed
* text (e.g.
"Width"
) or into a data binding expression (e.g.
* "{/##/dataServices/schema/0/entityType/1/com.sap.vocabularies.UI.v1.FieldGroup#Dimensions/Data/0/Label/String}"
*
). Data binding expressions are used in case XML template processing has
* been started with the setting bindTexts : true
. The purpose is to
* reference translatable texts from OData V4 annotations, especially for XML
* template processing at design time. Since 1.31.0, string constants that contain a
* simple binding "{@i18n>...}"
to the hard-coded model name "@i18n"
* with arbitrary path are not turned into a fixed text, but kept as a data binding
* expression; this allows local annotation files to refer to a resource bundle for
* internationalization.
* - the dynamic "14.5.1 Comparison and Logical Operators": These are turned into
* expression bindings to perform the operations at run-time.
*
- the dynamic "14.5.3 Expression edm:Apply":
*
* - "14.5.3.1.1 Function odata.concat": This is turned into a data binding
* expression relative to an entity.
*
- "14.5.3.1.2 Function odata.fillUriTemplate": This is turned into an
* expression binding to fill the template at run-time.
*
- "14.5.3.1.3 Function odata.uriEncode": This is turned into an expression
* binding to encode the parameter at run-time.
*
- Apply functions may be nested arbitrarily.
*
* - the dynamic "14.5.6 Expression edm:If": This is turned into an expression
* binding to be evaluated at run-time. The expression is a conditional expression
* like
"{=condition ? expression1 : expression2}"
.
* - the dynamic "14.5.10 Expression edm:Null": This is turned into a
*
null
value. In odata.concat
it is ignored.
* - the dynamic "14.5.12 Expression edm:Path" and "14.5.13 Expression
* edm:PropertyPath": This is turned into a data binding relative to an entity,
* including type information and constraints as available from metadata,
* e.g.
"{path : 'Name', type : 'sap.ui.model.odata.type.String',
* constraints : {'maxLength':'255'}}"
.
* Depending on the used type, some additional constraints of this type are set:
*
* - Edm.DateTime: The "displayFormat" constraint is set to the value of the
* "sap:display-format" annotation of the referenced property.
*
- Edm.Decimal: The "precision" and "scale" constraints are set to the values
* of the corresponding attributes of the referenced property. The "minimum",
* "maximum", "minimumExclusive" and "maximumExlusive" constraints are set to the
* values of the corresponding "Org.OData.Validation.V1" annotation of the
* referenced property; note that in this case only constant expressions are
* supported to determine the annotation value.
*
- Edm.String: The "maxLength" constraint is set to the value of the
* corresponding attribute of the referenced property and the "isDigitSequence"
* constraint is set to the value of the
* "com.sap.vocabularies.Common.v1.IsDigitSequence" annotation of the referenced
* property; note that in this case only constant expressions are supported to
* determine the annotation value.
*
*
* Unsupported or incorrect values are turned into a string nevertheless, but indicated
* as such. Proper escaping is used to make sure that data binding syntax is not
* corrupted. An error describing the problem is logged to the console in such a case.
*
* Example:
*
* <Text text="{path: 'meta>Value', formatter: 'sap.ui.model.odata.AnnotationHelper.format'}" />
*
* @param {sap.ui.core.util.XMLPreprocessor.IContext|sap.ui.model.Context} oInterface - the callback interface related to the current formatter call
* @param {any} vRawValue - the raw value from the meta model, which is embedded within an entity set or entity type: - if this function is used as formatter the value is provided by the framework
- if this function is called directly, provide the parameter only if it is already calculated
- if the parameter is omitted, it is calculated automatically through
oInterface.getObject("")
* @returns {string} the resulting string value to write into the processed XML
*/
function format(oInterface: sap.ui.core.util.XMLPreprocessor.IContext|sap.ui.model.Context, vRawValue?: any): string;
/**
* A formatter function to be used in a complex binding inside an XML template view
* in order to interpret OData V4 annotations. It knows about the following dynamic
* expressions:
*
* - "14.5.2 Expression edm:AnnotationPath"
* - "14.5.11 Expression edm:NavigationPropertyPath"
* - "14.5.12 Expression edm:Path"
* - "14.5.13 Expression edm:PropertyPath"
*
* It returns a binding expression for a navigation path in an OData model, starting at
* an entity.
* Currently supports navigation properties. Term casts and annotations of
* navigation properties terminate the navigation path.
*
* Examples:
*
* <template:if test="{path: 'facet>Target', formatter: 'sap.ui.model.odata.AnnotationHelper.getNavigationPath'}">
* <form:SimpleForm binding="{path: 'facet>Target', formatter: 'sap.ui.model.odata.AnnotationHelper.getNavigationPath'}" />
* </template:if>
*
* @param {sap.ui.core.util.XMLPreprocessor.IContext|sap.ui.model.Context} oInterface - the callback interface related to the current formatter call
* @param {any} vRawValue - the raw value from the meta model, e.g. {AnnotationPath : "ToSupplier/@com.sap.vocabularies.Communication.v1.Address"}
or {AnnotationPath : "@com.sap.vocabularies.UI.v1.FieldGroup#Dimensions"}
; embedded within an entity set or entity type; - if this function is used as formatter the value is provided by the framework
- if this function is called directly, provide the parameter only if it is already calculated
- if the parameter is omitted, it is calculated automatically through
oInterface.getObject("")
* @returns {string} the resulting string value to write into the processed XML, e.g. "{ToSupplier}" or "{}" (in case no navigation is needed); returns "" in case the navigation path cannot be determined (this is treated as falsy in template:if
statements!)
*/
function getNavigationPath(oInterface: sap.ui.core.util.XMLPreprocessor.IContext|sap.ui.model.Context, vRawValue?: any): string;
/**
* Helper function for a template:with
instruction that depending on how
* it is called goes to the entity set with the given name or to the one determined
* by the last navigation property. Supports the following dynamic expressions:
*
* - "14.5.2 Expression edm:AnnotationPath"
* - "14.5.11 Expression edm:NavigationPropertyPath"
* - "14.5.12 Expression edm:Path"
* - "14.5.13 Expression edm:PropertyPath"
*
*
* Example:
*
* <template:with path="facet>Target" helper="sap.ui.model.odata.AnnotationHelper.gotoEntitySet" var="entitySet"/>
* <template:with path="associationSetEnd>entitySet" helper="sap.ui.model.odata.AnnotationHelper.gotoEntitySet" var="entitySet"/>
*
* @param {sap.ui.model.Context} oContext - a context which must point to a simple string or to an annotation (or annotation property) of type Edm.AnnotationPath
, Edm.NavigationPropertyPath
, Edm.Path
, or Edm.PropertyPath
embedded within an entity set or entity type; the context's model must be an {@link sap.ui.model.odata.ODataMetaModel}
* @returns {string} the path to the entity set, or undefined
if no such set is found. In this case, a warning is logged to the console.
*/
function gotoEntitySet(oContext: sap.ui.model.Context): string;
/**
* Helper function for a template:with
instruction that goes to the
* entity type with the qualified name which oContext
points at.
*
* Example: Assume that "entitySet" refers to an entity set within an OData meta model;
* the helper function is then called on the "entityType" property of that entity set
* (which holds the qualified name of the entity type) and in turn the path of that
* entity type is assigned to the variable "entityType".
*
* <template:with path="entitySet>entityType" helper="sap.ui.model.odata.AnnotationHelper.gotoEntityType" var="entityType">
*
* @param {sap.ui.model.Context} oContext - a context which must point to the qualified name of an entity type; the context's model must be an {@link sap.ui.model.odata.ODataMetaModel}
* @returns {string} the path to the entity type with the given qualified name, or undefined
if no such type is found. In this case, a warning is logged to the console.
*/
function gotoEntityType(oContext: sap.ui.model.Context): string;
/**
* Helper function for a template:with
instruction that goes to the
* function import with the name which oContext
points at.
*
* Example: Assume that "dataField" refers to a DataFieldForAction within an
* OData meta model;
* the helper function is then called on the "Action" property of that data field
* (which holds an object with the qualified name of the function import in the
* String
property) and in turn the path of that function import
* is assigned to the variable "function".
*
* <template:with path="dataField>Action"
* helper="sap.ui.model.odata.AnnotationHelper.gotoFunctionImport" var="function">
*
* @param {sap.ui.model.Context} oContext - a context which must point to an object with a String
property, which holds the qualified name of the function import; the context's model must be an {@link sap.ui.model.odata.ODataMetaModel}
* @returns {string} the path to the function import with the given qualified name, or undefined
if no function import is found. In this case, a warning is logged to the console.
*/
function gotoFunctionImport(oContext: sap.ui.model.Context): string;
/**
* A formatter function to be used in a complex binding inside an XML template view
* in order to interpret OData V4 annotations. It knows about the following dynamic
* expressions:
*
* - "14.5.2 Expression edm:AnnotationPath"
* - "14.5.11 Expression edm:NavigationPropertyPath"
* - "14.5.12 Expression edm:Path"
* - "14.5.13 Expression edm:PropertyPath"
*
* It returns the information whether the navigation path ends with an association end
* with multiplicity "*". It throws an error if the navigation path has an association
* end with multiplicity "*" which is not the last one.
* Currently supports navigation properties. Term casts and annotations of
* navigation properties terminate the navigation path.
*
* Examples:
*
* <template:if test="{path: 'facet>Target', formatter: 'sap.ui.model.odata.AnnotationHelper.isMultiple'}">
*
* @param {sap.ui.core.util.XMLPreprocessor.IContext|sap.ui.model.Context} oInterface - the callback interface related to the current formatter call
* @param {any} vRawValue - the raw value from the meta model, e.g. {AnnotationPath : "ToSupplier/@com.sap.vocabularies.Communication.v1.Address"}
or {AnnotationPath : "@com.sap.vocabularies.UI.v1.FieldGroup#Dimensions"}
; embedded within an entity set or entity type; - if this function is used as formatter the value is provided by the framework
- if this function is called directly, provide the parameter only if it is already calculated
- if the parameter is omitted, it is calculated automatically through
oInterface.getObject("")
* @returns {string} "true"
if the navigation path ends with an association end with multiplicity "*", ""
in case the navigation path cannot be determined, "false"
otherwise (the latter are both treated as falsy in template:if
statements!)
*/
function isMultiple(oInterface: sap.ui.core.util.XMLPreprocessor.IContext|sap.ui.model.Context, vRawValue?: any): string;
/**
* Helper function for a template:with
instruction that resolves a dynamic
* "14.5.2 Expression edm:AnnotationPath",
* "14.5.11 Expression edm:NavigationPropertyPath", "14.5.12 Expression edm:Path" or
* "14.5.13 Expression edm:PropertyPath".
* Currently supports navigation properties and term casts.
*
* Example:
*
* <template:with path="meta>Value" helper="sap.ui.model.odata.AnnotationHelper.resolvePath" var="target">
*
* @param {sap.ui.model.Context} oContext - a context which must point to an annotation or annotation property of type Edm.AnnotationPath
, Edm.NavigationPropertyPath
, Edm.Path
or Edm.PropertyPath
, embedded within an entity set or entity type; the context's model must be an {@link sap.ui.model.odata.ODataMetaModel}
* @returns {string} the path to the target, or undefined
in case the path cannot be resolved. In this case, a warning is logged to the console.
*/
function resolvePath(oContext: sap.ui.model.Context): string;
/**
* Formatter function that is used in a complex binding inside an XML template view.
* The function is used to interpret OData V4 annotations, supporting the same
* annotations as {@link #.format format} but with a simplified output aimed at
* design-time templating with smart controls.
*
* In contrast to format
, "14.5.12 Expression edm:Path" or
* "14.5.13 Expression edm:PropertyPath" is turned into a simple binding path without
* type or constraint information. In certain cases, a complex binding is required to
* allow for proper escaping of the path.
*
* Example:
*
* <sfi:SmartField value="{path: 'meta>Value', formatter: 'sap.ui.model.odata.AnnotationHelper.simplePath'}"/>
*
* @param {sap.ui.core.util.XMLPreprocessor.IContext|sap.ui.model.Context} oInterface - the callback interface related to the current formatter call
* @param {any} vRawValue - the raw value from the meta model, which is embedded within an entity set or entity type: - if this function is used as formatter the value is provided by the framework
- if this function is called directly, provide the parameter only if it is already calculated
- if the parameter is omitted, it is calculated automatically through
oInterface.getObject("")
* @returns {string} the resulting string value to write into the processed XML
*/
function simplePath(oInterface: sap.ui.core.util.XMLPreprocessor.IContext|sap.ui.model.Context, vRawValue?: any): string;
}
/**
* Different modes for retrieving the count of collections
*/
namespace BatchMode {
/**
* Batch grouping enabled
*/
var Group: any;
/**
* No batch requests
*/
var None: any;
}
/**
* Different modes for retrieving the count of collections.
*/
export enum CountMode {
/**
* Count is retrieved by a separate request upfront and inline with each data request.
*
* The only purpose of this mode is to reflect the behavior of the {@link sap.ui.model.odata.ODataModel ODataModel (v1)}
* before the introduction of the CountMode
. For compatibility reasons, it is the
* default for the ODataModel
(v1) and shouldn't be used otherwise.
*/
Both = "Both",
/**
* Count is retrieved by adding $inlinecount=allpages
to data requests
* as long as no count has been determined yet.
*/
Inline = "Inline",
/**
* Count is retrieved by adding $inlinecount=allpages
to every data request.
*/
InlineRepeat = "InlineRepeat",
/**
* Count is not requested from the server.
*/
None = "None",
/**
* Count is retrieved by sending a separate $count
request before requesting data.
*
* It depends on the concrete model implementation whether and how the $count
request
* and the data request are synchronized.
*/
Request = "Request",
}
/**
* Filter for the list binding
*/
export class Filter extends sap.ui.base.Object {
/**
* Constructor for Filter
* @param {string} sPath - the binding path for this filter
* @param {any[]} aValues - Array of FilterOperators and their values: [{operator:"GE",value1:"val1"},{operator:"LE",value1:"val1"},{operator:"BT",value1:"val1",value2:"val2"}]
* @param {boolean} bAND - If true the values from aValues will be ANDed; otherwise ORed
*/
public constructor(sPath: string, aValues: any[], bAND?: boolean);
/**
* Converts the sap.ui.model.odata.Filter
into a
* sap.ui.model.Filter
.
* @returns {sap.ui.model.Filter} a sap.ui.model.Filter
object
*/
public convert(): sap.ui.model.Filter;
/**
* Creates a new subclass of class sap.ui.model.odata.Filter with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.odata.Filter.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Implementation to access oData Annotations
*/
export class ODataAnnotations extends sap.ui.base.EventProvider {
/**
* @param {string|string[]} aAnnotationURI - The annotation-URL or an array of URLS that should be parsed and merged
* @param {sap.ui.model.odata.ODataMetadata} oMetadata
* @param {any} mParams
*/
public constructor(aAnnotationURI: string|string[], oMetadata: sap.ui.model.odata.ODataMetadata, mParams: any);
/**
* Adds either one URL or an array of URLs to be loaded and parsed. The result will be merged into the annotations
* data which can be retrieved using the getAnnotations-method.
* @param {string|string[]} vUrl - Either one URL as string or an array of URL strings
* @returns {Promise} The Promise to load the given URL(s), resolved if all URLs have been loaded, rejected if at least one failed to load. The argument is an object containing the annotations object, success (an array of sucessfully loaded URLs), fail (an array ob of failed URLs).
*/
public addUrl(vUrl: string|string[]): Promise;
/**
* Attach event-handler fnFunction
to the 'failed' event of this sap.ui.model.odata.ODataAnnotations
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataAnnotations} this
to allow method chaining
*/
public attachFailed(fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataAnnotations;
/**
* Attach event-handler fnFunction
to the 'failed' event of this sap.ui.model.odata.ODataAnnotations
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataAnnotations} this
to allow method chaining
*/
public attachFailed(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataAnnotations;
/**
* Attach event-handler fnFunction
to the 'loaded' event of this sap.ui.model.odata.ODataAnnotations
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataAnnotations} this
to allow method chaining
*/
public attachLoaded(fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataAnnotations;
/**
* Attach event-handler fnFunction
to the 'loaded' event of this sap.ui.model.odata.ODataAnnotations
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataAnnotations} this
to allow method chaining
*/
public attachLoaded(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataAnnotations;
/**
* Detach event-handler fnFunction
from the 'failed' event of this sap.ui.model.odata.ODataAnnotations
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.odata.ODataAnnotations} this
to allow method chaining
*/
public detachFailed(fnFunction: Function, oListener: any): sap.ui.model.odata.ODataAnnotations;
/**
* Detach event-handler fnFunction
from the 'loaded' event of this sap.ui.model.odata.ODataAnnotations
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.odata.ODataAnnotations} this
to allow method chaining
*/
public detachLoaded(fnFunction: Function, oListener: any): sap.ui.model.odata.ODataAnnotations;
/**
* Creates a new subclass of class sap.ui.model.odata.ODataAnnotations with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event failed to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.odata.ODataAnnotations} this
to allow method chaining
*/
protected fireFailed(mArguments?: any): sap.ui.model.odata.ODataAnnotations;
/**
* Fire event loaded to attached listeners.
* @param {{ [key: string]: any }} mArguments - Map of arguments that will be given as parameters to teh event handler
* @returns {sap.ui.model.odata.ODataAnnotations} this
to allow method chaining
*/
protected fireLoaded(mArguments?: { [key: string]: any }): sap.ui.model.odata.ODataAnnotations;
/**
* returns the raw annotation data
* @returns {any} returns annotations data
*/
public getAnnotationsData(): any;
/**
* Returns a metadata object for class sap.ui.model.odata.ODataAnnotations.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks whether annotations loading of at least one of the given URLs has already failed.
* Note: For asynchronous annotations {@link #attachFailed} has to be used.
* @returns {boolean} whether annotations request has failed
*/
public isFailed(): boolean;
/**
* Checks whether annotations from at least one source are available
* @returns {boolean} returns whether annotations is already loaded
*/
public isLoaded(): boolean;
/**
* Set custom headers which are provided in a key/value map. These headers are used for all requests.
* The Accept-Language header cannot be modified and is set using the Core's language setting.
*
* To remove these headers simply set the mHeaders parameter to {}. Please also note that when calling this method
* again all previous custom headers are removed unless they are specified again in the mCustomHeaders parameter.
* @param {{ [key: string]: any }} mHeaders - the header name/value map.
*/
public setHeaders(mHeaders: { [key: string]: any }): void;
/**
* Sets an XML document.
* @param {any} oXMLDocument - The XML document to parse for annotations
* @param {string} sXMLContent - The XML content as string to parse for annotations
* @param {{ [key: string]: any }} mOptions - Additional options
* @returns {boolean} Whether or not parsing was successful
*/
public setXML(oXMLDocument: any, sXMLContent: string, mOptions?: { [key: string]: any }): boolean;
}
/**
* The ContextBinding is a specific binding for a setting context for the model
*/
export class ODataContextBinding extends sap.ui.model.ContextBinding {
/**
* Constructor for odata.ODataContextBinding
* @param {sap.ui.model.Model} oModel
* @param {string} sPath
* @param {Object} oContext
* @param {Object} mParameters
*/
public constructor(oModel: sap.ui.model.Model, sPath: string, oContext: Object, mParameters?: Object);
/**
* Creates a new subclass of class sap.ui.model.odata.ODataContextBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.ContextBinding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.odata.ODataContextBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* List binding implementation for oData format.
*/
export class ODataListBinding extends sap.ui.model.ListBinding {
/**
* @param {sap.ui.model.odata.ODataModel} oModel - Model that this list binding belongs to
* @param {string} sPath - Path into the model data, relative to the given oContext
* @param {sap.ui.model.Context} oContext - Context that the sPath
is based on
* @param {any[]} aSorters - Initial sort order (can be either a sorter or an array of sorters)
* @param {any[]} aFilters - Predefined filter/s (can be either a filter or an array of filters)
* @param {any} mParameters - A map which contains additional parameters for the binding
*/
public constructor(oModel: sap.ui.model.odata.ODataModel, sPath: string, oContext: sap.ui.model.Context, aSorters?: any[], aFilters?: any[], mParameters?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.ODataListBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.ListBinding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Filters the list.
*
* When using sap.ui.model.Filter the filters are first grouped according to their binding path.
* All filters belonging to a group are combined with OR and after that the
* results of all groups are combined with AND.
* Usually this means, all filters applied to a single table column
* are combined with OR, while filters on different table columns are combined with AND.
* Please note that a custom filter function is not supported.
* @param {sap.ui.model.Filter[]|sap.ui.model.odata.Filter[]} aFilters - Array of filter objects
* @param {sap.ui.model.FilterType} sFilterType - Type of the filter which should be adjusted, if it is not given, the standard behaviour applies
* @returns {sap.ui.model.ListBinding} returns this
to facilitate method chaining
*/
public filter(aFilters: sap.ui.model.Filter[]|sap.ui.model.odata.Filter[], sFilterType: sap.ui.model.FilterType): sap.ui.model.ListBinding;
/**
* Return contexts for the list
* @param {number} iStartIndex - the start index of the requested contexts
* @param {number} iLength - the requested amount of contexts
* @param {number} iThreshold
* @returns {sap.ui.model.Context[]} the array of contexts for each row of the bound list
*/
protected getContexts(iStartIndex?: number, iLength?: number, iThreshold?: number): sap.ui.model.Context[];
/**
* Get a download URL with the specified format considering the
* sort/filter/custom parameters.
* @param {string} sFormat - Value for the $format Parameter
* @returns {string} URL which can be used for downloading
*/
public getDownloadUrl(sFormat: string): string;
/**
* Returns a metadata object for class sap.ui.model.odata.ODataListBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Initialize binding. Fires a change if data is already available ($expand) or a refresh.
* If metadata is not yet available, do nothing, method will be called again when
* metadata is loaded.
*/
public initialize(): void;
/**
* Refreshes the binding, check whether the model data has been changed and fire change event
* if this is the case. For server side models this should refetch the data from the server.
* To update a control, even if no data has been changed, e.g. to reset a control after failed
* validation, please use the parameter bForceUpdate.
* @param {boolean} bForceUpdate - Update the bound control even if no data has been changed
*/
public refresh(bForceUpdate?: boolean): void;
/**
* Sorts the list.
* @param {sap.ui.model.Sorter|any[]} aSorters - the Sorter or an array of sorter objects object which define the sort order
* @returns {sap.ui.model.ListBinding} returns this
to facilitate method chaining
*/
public sort(aSorters: sap.ui.model.Sorter|any[]): sap.ui.model.ListBinding;
}
/**
* OData implementation of the sap.ui.core.message.MessageParser class. Parses message responses from the back-end.
*/
export class ODataMessageParser extends sap.ui.core.message.MessageParser {
/**
* OData implementation of the sap.ui.core.message.MessageParser class. Parses message responses from the back-end.
*/
public constructor();
/**
* Creates a new subclass of class sap.ui.model.odata.ODataMessageParser with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.message.MessageParser.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the name of the header field that is used to parse the server messages
* @returns {string} The name of the header field
*/
public getHeaderField(): string;
/**
* Returns a metadata object for class sap.ui.model.odata.ODataMessageParser.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Parses the given response for messages, calculates the delta and fires the messageChange-event
* on the MessageProcessor if messages are found.
* @param {any} oResponse - The response from the server containing body and headers
* @param {any} oRequest - The original request that lead to this response
* @param {{ [key: string]: any }} mGetEntities - A map containing the entities requested from the back-end as keys
* @param {{ [key: string]: any }} mChangeEntities - A map containing the entities changed on the back-end as keys
*/
public parse(oResponse: any, oRequest: any, mGetEntities: { [key: string]: any }, mChangeEntities: { [key: string]: any }): void;
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public parse(...args: any[]): any;
/**
* Sets the header field name that should be used for parsing the JSON messages
* @param {string} sFieldName - The name of the header field that should be used as source of the message object
* @returns {sap.ui.model.odata.ODataMessageParser} Instance reference for method chaining
*/
public setHeaderField(sFieldName: string): sap.ui.model.odata.ODataMessageParser;
}
/**
* Implementation to access oData metadata
*/
export class ODataMetadata extends sap.ui.base.EventProvider {
/**
* Constructor for a new ODataMetadata.
* @param {string} sMetadataURI - needs the correct metadata uri including $metadata
* @param {any} mParams - optional map of parameters.
*/
public constructor(sMetadataURI: string, mParams?: any);
/**
* Attach event-handler fnFunction
to the 'failed' event of this sap.ui.model.odata.ODataMetadata
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataMetadata} this
to allow method chaining
*/
public attachFailed(fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataMetadata;
/**
* Attach event-handler fnFunction
to the 'failed' event of this sap.ui.model.odata.ODataMetadata
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataMetadata} this
to allow method chaining
*/
public attachFailed(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataMetadata;
/**
* Attach event-handler fnFunction
to the 'loaded' event of this sap.ui.model.odata.ODataMetadata
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataMetadata} this
to allow method chaining
*/
public attachLoaded(fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataMetadata;
/**
* Attach event-handler fnFunction
to the 'loaded' event of this sap.ui.model.odata.ODataMetadata
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataMetadata} this
to allow method chaining
*/
public attachLoaded(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataMetadata;
/**
* Detach event-handler fnFunction
from the 'failed' event of this sap.ui.model.odata.ODataMetadata
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.odata.ODataMetadata} this
to allow method chaining
*/
public detachFailed(fnFunction: Function, oListener: any): sap.ui.model.odata.ODataMetadata;
/**
* Detach event-handler fnFunction
from the 'loaded' event of this sap.ui.model.odata.ODataMetadata
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.odata.ODataMetadata} this
to allow method chaining
*/
public detachLoaded(fnFunction: Function, oListener: any): sap.ui.model.odata.ODataMetadata;
/**
* Creates a new subclass of class sap.ui.model.odata.ODataMetadata with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event failed to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.odata.ODataMetadata} this
to allow method chaining
*/
protected fireFailed(mArguments?: any): sap.ui.model.odata.ODataMetadata;
/**
* Fire event loaded to attached listeners.
* @returns {sap.ui.model.odata.ODataMetadata} this
to allow method chaining
*/
protected fireLoaded(): sap.ui.model.odata.ODataMetadata;
/**
* Returns a metadata object for class sap.ui.model.odata.ODataMetadata.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Return the metadata object
* @returns {Object} metdata object
*/
public getServiceMetadata(): Object;
/**
* Get the the use-batch extension value if any
* @returns {boolean} true/false
*/
public getUseBatch(): boolean;
/**
* Checks whether metadata loading has already failed
* @returns {boolean} returns whether metadata request has failed
*/
public isFailed(): boolean;
/**
* Checks whether metadata is available
* @returns {boolean} returns whether metadata is already loaded
*/
public isLoaded(): boolean;
/**
* Returns a promise for the loaded state of the metadata
* @returns {Promise} returns a promise on metadata loaded state
*/
public loaded(): Promise;
/**
* Refreshes the metadata creating a new request to the server.
* Returns a new promise which can be resolved or rejected depending on the metadata loading state.
* @returns {Promise} returns a promise on metadata loaded state
*/
public refresh(): Promise;
}
/**
* Implementation of an OData meta model which offers a unified access to both OData V2
* metadata and V4 annotations. It uses the existing {@link sap.ui.model.odata.ODataMetadata}
* as a foundation and merges V4 annotations from the existing
* {@link sap.ui.model.odata.ODataAnnotations} directly into the corresponding model element.
*
* Also, annotations from the "http://www.sap.com/Protocols/SAPData" namespace are lifted up
* from the extensions
array and transformed from objects into simple properties
* with an "sap:" prefix for their name. Note that this happens in addition, thus the
* following example shows both representations. This way, such annotations can be addressed
* via a simple relative path instead of searching an array.
*
* {
* "name" : "BusinessPartnerID",
* "extensions" : [{
* "name" : "label",
* "value" : "Bus. Part. ID",
* "namespace" : "http://www.sap.com/Protocols/SAPData"
* }],
* "sap:label" : "Bus. Part. ID"
* }
*
*
* As of 1.29.0, the corresponding vocabulary-based annotations for the following
* "SAP Annotations for OData Version 2.0"
* are added, if they are not yet defined in the V4 annotations:
*
* label
;
* creatable
, deletable
, deletable-path
,
* pageable
, requires-filter
, searchable
,
* topable
, updatable
and updatable-path
on entity sets;
*
* creatable
(since 1.41.0), creatable-path
(since 1.41.0) and
* filterable
(since 1.39.0) on navigation properties;
* aggregation-role
("dimension" and "measure", both since 1.45.0),
* creatable
, display-format
("UpperCase" and "NonNegative"),
* field-control
, filterable
, filter-restriction
,
* heading
, precision
, quickinfo
,
* required-in-filter
, sortable
, text
, unit
,
* updatable
and visible
on properties;
* semantics
; the following values are supported:
*
* - "bday", "city", "country", "email" (including support for types, for example
* "email;type=home,pref"), "familyname", "givenname", "honorific", "middlename", "name",
* "nickname", "note", "org", "org-unit", "org-role", "photo", "pobox", "region", "street",
* "suffix", "tel" (including support for types, for example "tel;type=cell,pref"), "title" and
* "zip" (mapped to V4 annotation
com.sap.vocabularies.Communication.v1.Contact
);
*
* - "class", "dtend", "dtstart", "duration", "fbtype", "location", "status", "transp" and
* "wholeday" (mapped to V4 annotation
*
com.sap.vocabularies.Communication.v1.Event
);
* - "body", "from", "received", "sender" and "subject" (mapped to V4 annotation
*
com.sap.vocabularies.Communication.v1.Message
);
* - "completed", "due", "percent-complete" and "priority" (mapped to V4 annotation
*
com.sap.vocabularies.Communication.v1.Task
).
*
*
* For example:
*
* {
* "name" : "BusinessPartnerID",
* ...
* "sap:label" : "Bus. Part. ID",
* "com.sap.vocabularies.Common.v1.Label" : {
* "String" : "Bus. Part. ID"
* }
* }
*
*
* This model is read-only and thus only supports
* {@link sap.ui.model.BindingMode.OneTime OneTime} binding mode. No events
* ({@link sap.ui.model.Model#event:parseError parseError},
* {@link sap.ui.model.Model#event:requestCompleted requestCompleted},
* {@link sap.ui.model.Model#event:requestFailed requestFailed},
* {@link sap.ui.model.Model#event:requestSent requestSent}) are fired!
*
* Within the meta model, the objects are arranged in arrays.
* /dataServices/schema
, for example, is an array of schemas where each schema has
* an entityType
property with an array of entity types, and so on. So,
* /dataServices/schema/0/entityType/16
can be the path to the entity type with
* name "Order" in the schema with namespace "MySchema". However, these paths are not stable:
* If an entity type with lower index is removed from the schema, the path to
* Order
changes to /dataServices/schema/0/entityType/15
.
*
* To avoid problems with changing indexes, {@link sap.ui.model.Model#getObject getObject} and
* {@link sap.ui.model.Model#getProperty getProperty} support XPath-like queries for the
* indexes (since 1.29.1). Each index can be replaced by a query in square brackets. You can,
* for example, address the schema using the path
* /dataServices/schema/[${namespace}==='MySchema']
or the entity using
* /dataServices/schema/[${namespace}==='MySchema']/entityType/[sap.ui.core==='Order']
.
*
* The syntax inside the square brackets is the same as in expression binding. The query is
* executed for each object in the array until the result is true (truthy) for the first time.
* This object is then chosen.
*
* BEWARE: Access to this OData meta model will fail before the promise returned by
* {@link #loaded loaded} has been resolved!
*/
export class ODataMetaModel extends sap.ui.model.MetaModel {
/**
* DO NOT CALL this private constructor for a new ODataMetaModel
,
* but rather use {@link sap.ui.model.odata.ODataModel#getMetaModel getMetaModel} instead!
* @param {sap.ui.model.odata.ODataMetadata} oMetadata - the OData model's metadata object
* @param {sap.ui.model.odata.ODataAnnotations} oAnnotations - the OData model's annotations object
* @param {any} oODataModelInterface - the private interface object of the OData model which provides friend access to selected methods
*/
public constructor(oMetadata: sap.ui.model.odata.ODataMetadata, oAnnotations?: sap.ui.model.odata.ODataAnnotations, oODataModelInterface?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.ODataMetaModel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.MetaModel.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the OData meta model context corresponding to the given OData model path.
* @param {string} sPath - an absolute path pointing to an entity or property, e.g. "/ProductSet(1)/ToSupplier/BusinessPartnerID"; this equals the resource path component of a URI according to OData V2 URI conventions
* @returns {sap.ui.model.Context} the context for the corresponding metadata object, i.e. an entity type or its property, or null
in case no path is given
*/
public getMetaContext(sPath?: string): sap.ui.model.Context;
/**
* Returns a metadata object for class sap.ui.model.odata.ODataMetaModel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the OData association end corresponding to the given entity type's navigation
* property of given name.
* @param {any} oEntityType - an entity type as returned by {@link #getODataEntityType getODataEntityType}
* @param {string} sName - the name of a navigation property within this entity type
* @returns {any} the OData association end or null
if no such association end is found
*/
public getODataAssociationEnd(oEntityType: any, sName: string): any;
/**
* Returns the OData association set end corresponding to the given entity type's
* navigation property of given name.
* @param {any} oEntityType - an entity type as returned by {@link #getODataEntityType getODataEntityType}
* @param {string} sName - the name of a navigation property within this entity type
* @returns {any} the OData association set end or null
if no such association set end is found
*/
public getODataAssociationSetEnd(oEntityType: any, sName: string): any;
/**
* Returns the OData complex type with the given qualified name, either as a path or as an
* object, as indicated.
* @param {string} sQualifiedName - a qualified name, e.g. "ACME.Address"
* @param {boolean} bAsPath - determines whether the complex type is returned as a path or as an object
* @returns {any|string} (the path to) the complex type with the given qualified name; undefined
(for a path) or null
(for an object) if no such type is found
*/
public getODataComplexType(sQualifiedName: string, bAsPath?: boolean): any|string;
/**
* Returns the OData default entity container. If there is only a single schema with a single
* entity container, the entity container does not need to be marked as default explicitly.
* @param {boolean} bAsPath - determines whether the entity container is returned as a path or as an object
* @returns {any|string} (the path to) the default entity container; undefined
(for a path) or null
(for an object) if no such container is found
*/
public getODataEntityContainer(bAsPath?: boolean): any|string;
/**
* Returns the OData entity set with the given simple name from the default entity container.
* @param {string} sName - a simple name, e.g. "ProductSet"
* @param {boolean} bAsPath - determines whether the entity set is returned as a path or as an object
* @returns {any|string} (the path to) the entity set with the given simple name; undefined
(for a path) or null
(for an object) if no such set is found
*/
public getODataEntitySet(sName: string, bAsPath?: boolean): any|string;
/**
* Returns the OData entity type with the given qualified name, either as a path or as an
* object, as indicated.
* @param {string} sQualifiedName - a qualified name, e.g. "ACME.Product"
* @param {boolean} bAsPath - determines whether the entity type is returned as a path or as an object
* @returns {any|string} (the path to) the entity type with the given qualified name; undefined
(for a path) or null
(for an object) if no such type is found
*/
public getODataEntityType(sQualifiedName: string, bAsPath?: boolean): any|string;
/**
* Returns the OData function import with the given simple or qualified name from the default
* entity container or the respective entity container specified in the qualified name.
* @param {string} sName - a simple or qualified name, e.g. "Save" or "MyService.Entities/Save"
* @param {boolean} bAsPath - determines whether the function import is returned as a path or as an object
* @returns {any|string} (the path to) the function import with the given simple name; undefined
(for a path) or null
(for an object) if no such function import is found
*/
public getODataFunctionImport(sName: string, bAsPath?: boolean): any|string;
/**
* Returns the given OData type's property (not navigation property!) of given name.
*
* If an array is given instead of a single name, it is consumed (via
* Array.prototype.shift
) piece by piece. Each element is interpreted as a
* property name of the current type, and the current type is replaced by that property's type.
* This is repeated until an element is encountered which cannot be resolved as a property name
* of the current type anymore; in this case, the last property found is returned and
* vName
contains only the remaining names, with vName[0]
being the
* one which was not found.
*
* Examples:
*
* - Get address property of business partner:
*
* var oEntityType = oMetaModel.getODataEntityType("GWSAMPLE_BASIC.BusinessPartner"),
* oAddressProperty = oMetaModel.getODataProperty(oEntityType, "Address");
* oAddressProperty.name === "Address";
* oAddressProperty.type === "GWSAMPLE_BASIC.CT_Address";
*
*
* - Get street property of address type:
*
* var oComplexType = oMetaModel.getODataComplexType("GWSAMPLE_BASIC.CT_Address"),
* oStreetProperty = oMetaModel.getODataProperty(oComplexType, "Street");
* oStreetProperty.name === "Street";
* oStreetProperty.type === "Edm.String";
*
*
* - Get address' street property directly from business partner:
*
* var aParts = ["Address", "Street"];
* oMetaModel.getODataProperty(oEntityType, aParts) === oStreetProperty;
* aParts.length === 0;
*
*
* - Trying to get address' foo property directly from business partner:
*
* aParts = ["Address", "foo"];
* oMetaModel.getODataProperty(oEntityType, aParts) === oAddressProperty;
* aParts.length === 1;
* aParts[0] === "foo";
*
*
*
* @param {any} oType - a complex type as returned by {@link #getODataComplexType getODataComplexType}, or an entity type as returned by {@link #getODataEntityType getODataEntityType}
* @param {string|string[]} vName - the name of a property within this type (e.g. "Address"), or an array of such names (e.g. ["Address", "Street"]
) in order to drill-down into complex types; BEWARE that this array is modified by removing each part which is understood!
* @param {boolean} bAsPath - determines whether the property is returned as a path or as an object
* @returns {any|string} (the path to) the last OData property found; undefined
(for a path) or null
(for an object) if no property was found at all
*/
public getODataProperty(oType: any, vName: string|string[], bAsPath?: boolean): any|string;
/**
* Returns a Promise
which is resolved with a map representing the
* com.sap.vocabularies.Common.v1.ValueList
annotations of the given property or
* rejected with an error.
* The key in the map provided on successful resolution is the qualifier of the annotation or
* the empty string if no qualifier is defined. The value in the map is the JSON object for
* the annotation. The map is empty if the property has no
* com.sap.vocabularies.Common.v1.ValueList
annotations.
* @param {sap.ui.model.Context} oPropertyContext - a model context for a structural property of an entity type or a complex type, as returned by {@link #getMetaContext getMetaContext}
* @returns {Promise} a Promise that gets resolved as soon as the value lists as well as the required model elements have been loaded
*/
public getODataValueLists(oPropertyContext: sap.ui.model.Context): Promise;
/**
* Returns a promise which is fulfilled once the meta model data is loaded and can be used.
* @returns {Promise} a Promise
*/
public loaded(): Promise;
/**
* Refresh not supported by OData meta model!
*/
public refresh(): void;
/**
* Legacy syntax not supported by OData meta model!
* @param {boolean} bLegacySyntax - must not be true!
*/
public setLegacySyntax(bLegacySyntax: boolean): void;
}
/**
* Model implementation for oData format
*/
export class ODataModel extends sap.ui.model.Model {
/**
* Constructor for a new ODataModel.
* @param {string} sServiceUrl - base uri of the service to request data from; additional URL parameters appended here will be appended to every request can be passed with the mParameters object as well: [mParameters.serviceUrl] A serviceURl is required!
* @param {any} mParameters - (optional) a map which contains the following parameter properties:
*/
public constructor(sServiceUrl?: string, mParameters?: any);
/**
* Adds (a) new URL(s) to the be parsed for OData annotations, which are then merged into the annotations object
* which can be retrieved by calling the getServiceAnnotations()-method. If a $metadata url is passed the data will
* also be merged into the metadata object, which can be reached by calling the getServiceMetadata() method.
* @param {string|string[]} vUrl - Either one URL as string or an array or URL strings
* @returns {Promise} The Promise to load the given URL(s), resolved if all URLs have been loaded, rejected if at least one fails to load. If this promise resolves it returns the following parameters: annotations: The annotation object entitySets: An array of EntitySet objects containing the newly merged EntitySets from a $metadata requests. the structure is the same as in the metadata object reached by the getServiceMetadata() method. For non $metadata requests the array will be empty.
*/
protected addAnnotationUrl(vUrl: string|string[]): Promise;
/**
* Adds new xml content to be parsed for OData annotations, which are then merged into the annotations object which
* can be retrieved by calling the getServiceAnnotations()-method.
* @param {string} sXMLContent - The string that should be parsed as annotation XML
* @param {boolean} bSuppressEvents - Whether not to fire annotationsLoaded event on the annotationParser
* @returns {Promise} The Promise to parse the given XML-String, resolved if parsed without errors, rejected if errors occur
*/
protected addAnnotationXML(sXMLContent: string, bSuppressEvents?: boolean): Promise;
/**
* Appends the change batch operations to the end of the batch stack. Only PUT, POST or DELETE batch operations should be included in the specified array.
* The operations in the array will be included in a single changeset. To embed change operations in different change sets call this method with the corresponding change operations again.
* If an illegal batch operation is added to the change set nothing will be performed and false will be returned.
* @param {any[]} aChangeOperations - an array of change batch operations created via createBatchOperation
and sMethod
= POST, PUT, MERGE or DELETE
*/
public addBatchChangeOperations(aChangeOperations: any[]): void;
/**
* Appends the read batch operations to the end of the batch stack. Only GET batch operations should be included in the specified array.
* If an illegal batch operation is added to the batch nothing will be performed and false will be returned.
* @param {any[]} aReadOperations - an array of read batch operations created via createBatchOperation
and sMethod
= GET
*/
public addBatchReadOperations(aReadOperations: any[]): void;
/**
* Attach event-handler fnFunction
to the 'annotationsFailed' event of this sap.ui.model.odata.ODataModel
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
public attachAnnotationsFailed(fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataModel;
/**
* Attach event-handler fnFunction
to the 'annotationsFailed' event of this sap.ui.model.odata.ODataModel
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
public attachAnnotationsFailed(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataModel;
/**
* Attach event-handler fnFunction
to the 'annotationsLoaded' event of this sap.ui.model.odata.ODataModel
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
public attachAnnotationsLoaded(fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataModel;
/**
* Attach event-handler fnFunction
to the 'annotationsLoaded' event of this sap.ui.model.odata.ODataModel
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
public attachAnnotationsLoaded(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataModel;
/**
* Attach event-handler fnFunction
to the 'metadataFailed' event of this sap.ui.model.odata.ODataModel
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
public attachMetadataFailed(fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataModel;
/**
* Attach event-handler fnFunction
to the 'metadataFailed' event of this sap.ui.model.odata.ODataModel
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
public attachMetadataFailed(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataModel;
/**
* Attach event-handler fnFunction
to the 'metadataLoaded' event of this sap.ui.model.odata.ODataModel
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
public attachMetadataLoaded(fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataModel;
/**
* Attach event-handler fnFunction
to the 'metadataLoaded' event of this sap.ui.model.odata.ODataModel
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
public attachMetadataLoaded(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.ODataModel;
/**
* Creates a new list binding for this model.
* @param {string} sPath - Binding path, either absolute or relative to a given oContext
* @param {sap.ui.model.Context} oContext - Binding context referring to this model
* @param {sap.ui.model.Sorter|sap.ui.model.Sorter[]} aSorters - Initial sort order, can be either a sorter or an array of sorters
* @param {sap.ui.model.Filter|sap.ui.model.Filter[]} aFilters - Predefined filter/s, can be either a filter or an array of filters
* @param {{ [key: string]: any }} mParameters - Map which contains additional parameters for the binding
* @returns {sap.ui.model.ListBinding} oBinding new list binding object
*/
public bindList(sPath: string, oContext?: sap.ui.model.Context, aSorters?: sap.ui.model.Sorter|sap.ui.model.Sorter[], aFilters?: sap.ui.model.Filter|sap.ui.model.Filter[], mParameters?: { [key: string]: any }): sap.ui.model.ListBinding;
/**
* Trigger a request to the function import odata service that was specified in the model constructor.
* @param {string} sFunctionName - A string containing the name of the function to call. The name is concatenated to the sServiceUrl which was specified in the model constructor.
* @param {{ [key: string]: any }} mParameters - Optional parameter map containing any of the following properties:
* @returns {any} an object which has an abort
function to abort the current request.
*/
public callFunction(sFunctionName: string, mParameters?: { [key: string]: any }): any;
/**
* Removes all operations in the current batch.
*/
public clearBatch(): void;
/**
* Trigger a POST request to the odata service that was specified in the model constructor. Please note that deep creates are not supported
* and may not work.
* @param {string} sPath - A string containing the path to the collection where an entry should be created. The path is concatenated to the sServiceUrl which was specified in the model constructor.
* @param {any} oData - data of the entry that should be created.
* @param {{ [key: string]: any }} mParameters - Optional parameter map containing any of the following properties:
* @returns {any} an object which has an abort
function to abort the current request.
*/
public create(sPath: string, oData: any, mParameters?: { [key: string]: any }): any;
/**
* Creates a single batch operation (read or change operation) which can be used in a batch request.
* @param {string} sPath - A string containing the path to the collection or entry where the batch operation should be performed. The path is concatenated to the sServiceUrl which was specified in the model constructor.
* @param {string} sMethod - for the batch operation. Possible values are GET, PUT, MERGE, POST, DELETE
* @param {any} oData - optional data payload which should be created, updated, deleted in a change batch operation.
* @param {any} oParameters - optional parameter for additional information introduced in SAPUI5 1.9.1,
*/
public createBatchOperation(sPath: string, sMethod: string, oData?: any, oParameters?: any): void;
/**
* Creates a new entry object which is described by the metadata of the entity type of the
* specified sPath Name. A context object is returned which can be used to bind
* against the newly created object.
*
* For each created entry a request is created and stored in a request queue.
* The request queue can be submitted by calling submitChanges. To delete a created
* entry from the request queue call deleteCreateEntry.
*
* The optional vProperties parameter can be used as follows:
*
* - vProperties could be an array containing the property names which should be included
* in the new entry. Other properties defined in the entity type are not included.
* - vProperties could be an object which includes the desired properties and the values
* which should be used for the created entry.
*
* If vProperties is not specified, all properties in the entity type will be included in the
* created entry.
*
* If there are no values specified the properties will have undefined values.
*
* Please note that deep creates (including data defined by navigationproperties) are not supported
* @param {string} sPath - Name of the path to the collection
* @param {any[]|any} vProperties - An array that specifies a set of properties or the entry
* @returns {sap.ui.model.Context} oContext A Context object that point to the new created entry.
*/
public createEntry(sPath: string, vProperties: any[]|any): sap.ui.model.Context;
/**
* Creates the key from the given collection name and property map
* @param {string} sCollection - The name of the collection
* @param {any} oKeyParameters - The object containing at least all the key properties of the entity type
* @param {boolean} bDecode - Whether the URI decoding should be applied on the key
*/
public createKey(sCollection: string, oKeyParameters: any, bDecode: boolean): void;
/**
* Deletes a created entry from the request queue and the model.
* @param {sap.ui.model.Context} oContext - The context object pointing to the created entry
*/
public deleteCreatedEntry(oContext: sap.ui.model.Context): void;
/**
*/
public destroy(): void;
/**
* Detach event-handler fnFunction
from the 'annotationsFailed' event of this sap.ui.model.odata.ODataModel
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
public detachAnnotationsFailed(fnFunction: Function, oListener: any): sap.ui.model.odata.ODataModel;
/**
* Detach event-handler fnFunction
from the 'annotationsLoaded' event of this sap.ui.model.odata.ODataModel
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
public detachAnnotationsLoaded(fnFunction: Function, oListener: any): sap.ui.model.odata.ODataModel;
/**
* Detach event-handler fnFunction
from the 'metadataFailed' event of this sap.ui.model.odata.ODataModel
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
public detachMetadataFailed(fnFunction: Function, oListener: any): sap.ui.model.odata.ODataModel;
/**
* Detach event-handler fnFunction
from the 'metadataLoaded' event of this sap.ui.model.odata.ODataModel
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
public detachMetadataLoaded(fnFunction: Function, oListener: any): sap.ui.model.odata.ODataModel;
/**
* Creates a new subclass of class sap.ui.model.odata.ODataModel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event annotationsFailed to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
protected fireAnnotationsFailed(mArguments?: any): sap.ui.model.odata.ODataModel;
/**
* Fire event annotationsLoaded to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
protected fireAnnotationsLoaded(mArguments?: any): sap.ui.model.odata.ODataModel;
/**
* Fire event metadataFailed to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
protected fireMetadataFailed(mArguments?: any): sap.ui.model.odata.ODataModel;
/**
* Fire event metadataLoaded to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.odata.ODataModel} this
to allow method chaining
*/
protected fireMetadataLoaded(mArguments?: any): sap.ui.model.odata.ODataModel;
/**
* Force no caching
* @param {boolean} bForceNoCache - whether to force no caching
*/
public forceNoCache(bForceNoCache?: boolean): void;
/**
* Return requested data as object if the data has already been loaded and stored in the model.
* @param {string} sPath - A string containing the path to the data object that should be returned.
* @param {any} oContext - the optional context which is used with the sPath to retrieve the requested data.
* @param {boolean} bIncludeExpandEntries - This parameter should be set when a URI or custom parameter with a $expand System Query Option was used to retrieve associated entries embedded/inline. If true then the getProperty function returns a desired property value/entry and includes the associated expand entries (if any). If false the associated/expanded entry properties are removed and not included in the desired entry as properties at all. This is useful for performing updates on the base entry only. Note: A copy and not a reference of the entry will be returned.
* @returns {any} oData Object containing the requested data if the path is valid.
*/
public getData(sPath: string, oContext?: any, bIncludeExpandEntries?: boolean): any;
/**
* Returns the default count mode for retrieving the count of collections
* @returns {sap.ui.model.odata.CountMode}
*/
public getDefaultCountMode(): sap.ui.model.odata.CountMode;
/**
* Returns all headers and custom headers which are stored in the OData model.
* @returns {any} the header map
*/
public getHeaders(): any;
/**
* Returns the key part from the entry URI or the given context or object
* @param {any|sap.ui.model.Context} oObject - The context or object
* @param {boolean} bDecode - Whether the URI decoding should be applied on the key
* @returns {any}
*/
public getKey(oObject: any|sap.ui.model.Context, bDecode: boolean): any;
/**
* Returns a metadata object for class sap.ui.model.odata.ODataModel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns an instance of an OData meta model which offers a unified access to both OData V2
* metadata and V4 annotations. It uses the existing {@link sap.ui.model.odata.ODataMetadata}
* as a foundation and merges V4 annotations from the existing
* {@link sap.ui.model.odata.ODataAnnotations} directly into the corresponding model element.
*
* BEWARE: Access to this OData meta model will fail before the promise returned by
* {@link sap.ui.model.odata.ODataMetaModel#loaded loaded} has been resolved!
* @returns {sap.ui.model.odata.ODataMetaModel} The meta model for this ODataModel
*/
public getMetaModel(): sap.ui.model.odata.ODataMetaModel;
/**
* Returns the value for the property with the given sPath
.
* If the path points to a navigation property which has been loaded via $expand then the bIncludeExpandEntries
* parameter determines if the navigation property should be included in the returned value or not.
* Please note that this currently works for 1..1 navigation properties only.
* @param {string} sPath - the path/name of the property
* @param {any} oContext - the context if available to access the property value
* @param {boolean} bIncludeExpandEntries - This parameter should be set when a URI or custom parameter with a $expand System Query Option was used to retrieve associated entries embedded/inline. If true then the getProperty function returns a desired property value/entry and includes the associated expand entries (if any). If false the associated/expanded entry properties are removed and not included in the desired entry as properties at all. This is useful for performing updates on the base entry only. Note: A copy and not a reference of the entry will be returned.
* @returns {any} the value of the property
*/
public getProperty(sPath: string, oContext?: any, bIncludeExpandEntries?: boolean): any;
/**
* Returns the current security token. If the token has not been requested from the server it will be requested first.
* @returns {string} the CSRF security token
*/
public getSecurityToken(): string;
/**
* Return the annotation object. Please note that when using the model with bLoadMetadataAsync = true then this function might return undefined because the
* metadata has not been loaded yet.
* In this case attach to the annotationsLoaded
event to get notified when the annotations are available and then call this function.
* @returns {Object} metdata object
*/
public getServiceAnnotations(): Object;
/**
* Return the metadata object. Please note that when using the model with bLoadMetadataAsync = true then this function might return undefined because the
* metadata has not been loaded yet.
* In this case attach to the metadataLoaded
event to get notified when the metadata is available and then call this function.
* @returns {Object} metdata object
*/
public getServiceMetadata(): Object;
/**
* Checks if there exist pending changes in the model created by the setProperty method.
* @returns {boolean} true/false
*/
public hasPendingChanges(): boolean;
/**
* Returns whether this model supports the $count on its collections
* This method is deprecated, please use getDefaultCountMode instead.
* @returns {boolean}
*/
public isCountSupported(): boolean;
/**
* Trigger a GET request to the odata service that was specified in the model constructor.
* The data will not be stored in the model. The requested data is returned with the response.
* @param {string} sPath - A string containing the path to the data which should be retrieved. The path is concatenated to the sServiceUrl which was specified in the model constructor.
* @param {{ [key: string]: any }} mParameters - Optional parameter map containing any of the following properties:
* @returns {any} an object which has an abort
function to abort the current request.
*/
public read(sPath: string, mParameters?: { [key: string]: any }): any;
/**
* Refresh the model.
* This will check all bindings for updated data and update the controls if data has been changed.
* @param {boolean} bForceUpdate - Force update of controls
* @param {boolean} bRemoveData - If set to true then the model data will be removed/cleared. Please note that the data might not be there when calling e.g. getProperty too early before the refresh call returned.
*/
public refresh(bForceUpdate?: boolean, bRemoveData?: boolean): void;
/**
* refreshes the metadata for model, e.g. in case the first request for metadata has failed
*/
public refreshMetadata(): void;
/**
* refresh XSRF token by performing a GET request against the service root URL.
* @param {Function} fnSuccess - a callback function which is called when the data has been successfully retrieved.
* @param {Function} fnError - a callback function which is called when the request failed. The handler can have the parameter: oError which contains additional error information.
* @param {boolean} bAsync - true for asynchronous requests.
* @returns {any} an object which has an abort
function to abort the current request.
*/
public refreshSecurityToken(fnSuccess?: Function, fnError?: Function, bAsync?: boolean): any;
/**
* Trigger a DELETE request to the odata service that was specified in the model constructor.
* @param {string} sPath - A string containing the path to the data that should be removed. The path is concatenated to the sServiceUrl which was specified in the model constructor.
* @param {any} mParameters - Optional, can contain the following attributes: oContext, fnSuccess, fnError, sETag:
* @returns {any} an object which has an abort
function to abort the current request.
*/
public remove(sPath: string, mParameters?: any): any;
/**
* Resets the collected changes by the setProperty method and reloads the data from the server.
* @param {Function} fnSuccess - a callback function which is called when the data has been successfully resetted. The handler can have the following parameters: oData and response.
* @param {Function} fnError - a callback function which is called when the request failed
*/
public resetChanges(fnSuccess?: Function, fnError?: Function): void;
/**
* Sets whether this OData service supports $count on its collections.
* This method is deprecated, please use setDefaultCountMode instead.
* @param {boolean} bCountSupported
*/
public setCountSupported(bCountSupported: boolean): void;
/**
* Sets the default mode how to retrieve the item count for a collection in this model.
*
* The count can be determined in the following ways
*
* - by sending a separate
$count
request
* - by adding parameter
$inlinecount=allpages
to one or all data requests
* - a combination of the previous two
* - not at all (questions about the size of the collection can't be answered then)
*
* See {@link sap.ui.model.odata.CountMode} for all enumeration values and more details.
*
* Note that a call to this method does not modify the count mode for existing list bindings,
* only bindings that are created afterwards will use the new mode when no mode is defined at their creation.
*
* If no default count mode is set for an ODataModel
(v1), the mode Both
* will be used for compatibility reasons.
* @param {sap.ui.model.odata.CountMode} sCountMode - The new default count mode for this model
*/
public setDefaultCountMode(sCountMode: sap.ui.model.odata.CountMode): void;
/**
* Set custom headers which are provided in a key/value map. These headers are used for requests against the OData backend.
* Private headers which are set in the ODataModel cannot be modified.
* These private headers are: accept, accept-language, x-csrf-token, MaxDataServiceVersion, DataServiceVersion.
*
* To remove these headers simply set the mCustomHeaders parameter to null. Please also note that when calling this method again all previous custom headers
* are removed unless they are specified again in the mCustomHeaders parameter.
* @param {any} mHeaders - the header name/value map.
*/
public setHeaders(mHeaders: any): void;
/**
* Sets a new value for the given property sPropertyName
in the model without triggering a server request.
* This can be done by the submitChanges method.
*
* Note: Only one entry of one collection can be updated at once. Otherwise a fireRejectChange event is fired.
*
* Before updating a different entry the existing changes of the current entry have to be submitted or resetted by the
* corresponding methods: submitChanges, resetChanges.
*
* IMPORTANT: All pending changes are resetted in the model if the application triggeres any kind of refresh
* on that entry. Make sure to submit the pending changes first. To determine if there are any pending changes call the hasPendingChanges method.
* @param {string} sPath - path of the property to set
* @param {any} oValue - value to set the property to
* @param {any} oContext - the context which will be used to set the property
* @param {boolean} bAsyncUpdate - whether to update other bindings dependent on this property asynchronously
* @returns {boolean} true if the value was set correctly and false if errors occurred like the entry was not found or another entry was already updated.
*/
public setProperty(sPath: string, oValue: any, oContext?: any, bAsyncUpdate?: boolean): boolean;
/**
* Enable/Disable automatic updates of all Bindings after change operations
* @param {boolean} bRefreshAfterChange
*/
public setRefreshAfterChange(bRefreshAfterChange: boolean): void;
/**
* Enable/Disable XCSRF-Token handling
* @param {boolean} bTokenHandling - whether to use token handling or not
*/
public setTokenHandlingEnabled(bTokenHandling?: boolean): void;
/**
* Enable/Disable batch for all requests
* @param {boolean} bUseBatch - whether the requests should be encapsulated in a batch request
*/
public setUseBatch(bUseBatch?: boolean): void;
/**
* Submits the collected changes in the batch which were collected via addBatchReadOperations
or addBatchChangeOperations
.
* The batch will be cleared afterwards. If the batch is empty no request will be performed and false will be returned.
* Note: No data will be stored in the model.
* @param {boolean} bImportData
* @returns {any} an object which has an abort
function to abort the current request. Returns false if no request will be performed because the batch is empty.
*/
public submitBatch(bImportData: boolean): any;
/**
* Submits the collected changes in the batch which were collected via addBatchReadOperations
or addBatchChangeOperations
.
* The batch will be cleared afterwards. If the batch is empty no request will be performed and false will be returned.
* Note: No data will be stored in the model.
* @param {Function} fnSuccess - a callback function which is called when the batch request has been successfully sent. Note: There might have errors occured in the single batch operations. These errors can be accessed in the aErrorResponses parameter in the callback handler. The handler can have the following parameters: oData, oResponse and aErrorResponses.
* @param {boolean} bImportData
* @returns {any} an object which has an abort
function to abort the current request. Returns false if no request will be performed because the batch is empty.
*/
public submitBatch(fnSuccess: Function, bImportData: boolean): any;
/**
* Submits the collected changes in the batch which were collected via addBatchReadOperations
or addBatchChangeOperations
.
* The batch will be cleared afterwards. If the batch is empty no request will be performed and false will be returned.
* Note: No data will be stored in the model.
* @param {boolean} bAsync - true for asynchronous request. Default is true.
* @param {boolean} bImportData
* @returns {any} an object which has an abort
function to abort the current request. Returns false if no request will be performed because the batch is empty.
*/
public submitBatch(bAsync: boolean, bImportData: boolean): any;
/**
* Submits the collected changes in the batch which were collected via addBatchReadOperations
or addBatchChangeOperations
.
* The batch will be cleared afterwards. If the batch is empty no request will be performed and false will be returned.
* Note: No data will be stored in the model.
* @param {Function} fnSuccess - a callback function which is called when the batch request has been successfully sent. Note: There might have errors occured in the single batch operations. These errors can be accessed in the aErrorResponses parameter in the callback handler. The handler can have the following parameters: oData, oResponse and aErrorResponses.
* @param {boolean} bAsync - true for asynchronous request. Default is true.
* @param {boolean} bImportData
* @returns {any} an object which has an abort
function to abort the current request. Returns false if no request will be performed because the batch is empty.
*/
public submitBatch(fnSuccess: Function, bAsync: boolean, bImportData: boolean): any;
/**
* Submits the collected changes in the batch which were collected via addBatchReadOperations
or addBatchChangeOperations
.
* The batch will be cleared afterwards. If the batch is empty no request will be performed and false will be returned.
* Note: No data will be stored in the model.
* @param {Function} fnError - a callback function which is called when the batch request failed. The handler can have the parameter: oError which contains additional error information.
* @param {boolean} bImportData
* @returns {any} an object which has an abort
function to abort the current request. Returns false if no request will be performed because the batch is empty.
*/
public submitBatch(fnError: Function, bImportData: boolean): any;
/**
* Submits the collected changes in the batch which were collected via addBatchReadOperations
or addBatchChangeOperations
.
* The batch will be cleared afterwards. If the batch is empty no request will be performed and false will be returned.
* Note: No data will be stored in the model.
* @param {Function} fnError - a callback function which is called when the batch request failed. The handler can have the parameter: oError which contains additional error information.
* @param {boolean} bAsync - true for asynchronous request. Default is true.
* @param {boolean} bImportData
* @returns {any} an object which has an abort
function to abort the current request. Returns false if no request will be performed because the batch is empty.
*/
public submitBatch(fnError: Function, bAsync: boolean, bImportData: boolean): any;
/**
* Submits the collected changes in the batch which were collected via addBatchReadOperations
or addBatchChangeOperations
.
* The batch will be cleared afterwards. If the batch is empty no request will be performed and false will be returned.
* Note: No data will be stored in the model.
* @param {Function} fnSuccess - a callback function which is called when the batch request has been successfully sent. Note: There might have errors occured in the single batch operations. These errors can be accessed in the aErrorResponses parameter in the callback handler. The handler can have the following parameters: oData, oResponse and aErrorResponses.
* @param {Function} fnError - a callback function which is called when the batch request failed. The handler can have the parameter: oError which contains additional error information.
* @param {boolean} bImportData
* @returns {any} an object which has an abort
function to abort the current request. Returns false if no request will be performed because the batch is empty.
*/
public submitBatch(fnSuccess: Function, fnError: Function, bImportData: boolean): any;
/**
* Submits the collected changes in the batch which were collected via addBatchReadOperations
or addBatchChangeOperations
.
* The batch will be cleared afterwards. If the batch is empty no request will be performed and false will be returned.
* Note: No data will be stored in the model.
* @param {Function} fnSuccess - a callback function which is called when the batch request has been successfully sent. Note: There might have errors occured in the single batch operations. These errors can be accessed in the aErrorResponses parameter in the callback handler. The handler can have the following parameters: oData, oResponse and aErrorResponses.
* @param {Function} fnError - a callback function which is called when the batch request failed. The handler can have the parameter: oError which contains additional error information.
* @param {boolean} bAsync - true for asynchronous request. Default is true.
* @param {boolean} bImportData
* @returns {any} an object which has an abort
function to abort the current request. Returns false if no request will be performed because the batch is empty.
*/
public submitBatch(fnSuccess: Function, fnError: Function, bAsync: boolean, bImportData: boolean): any;
/**
* Submits the collected changes which were collected by the setProperty method. A MERGE request will be triggered to only update the changed properties.
* If a URI with a $expand System Query Option was used then the expand entries will be removed from the collected changes.
* Changes to this entries should be done on the entry itself. So no deep updates are supported.
* @param {Function} fnSuccess - a callback function which is called when the data has been successfully updated. The handler can have the following parameters: oData and response.
* @param {Function} fnError - a callback function which is called when the request failed. The handler can have the parameter: oError which contains additional error information
* @param {any} oParameters - optional parameter for additional information introduced in SAPUI5 1.9.1
* @returns {any} an object which has an abort
function to abort the current request.
*/
public submitChanges(fnSuccess?: Function, fnError?: Function, oParameters?: any): any;
/**
* Trigger a PUT/MERGE request to the odata service that was specified in the model constructor. Please note that deep updates are not supported
* and may not work. These should be done seperate on the entry directly.
* @param {string} sPath - A string containing the path to the data that should be updated. The path is concatenated to the sServiceUrl which was specified in the model constructor.
* @param {any} oData - data of the entry that should be updated.
* @param {{ [key: string]: any }} mParameters - Optional, can contain the following attributes:
* @returns {any} an object which has an abort
function to abort the current request.
*/
public update(sPath: string, oData: any, mParameters?: { [key: string]: any }): any;
/**
* update all bindings
* @param {boolean} bForceUpdate - If set to false an update will only be done when the value of a binding changed.
*/
public updateBindings(bForceUpdate?: boolean): void;
}
/**
* Property binding implementation for oData format
*/
export class ODataPropertyBinding extends sap.ui.model.PropertyBinding {
/**
* @param {sap.ui.model.Model} oModel
* @param {string} sPath
* @param {sap.ui.model.Context} oContext
* @param {any} mParameters
*/
public constructor(oModel: sap.ui.model.Model, sPath: string, oContext: sap.ui.model.Context, mParameters?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.ODataPropertyBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.PropertyBinding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.odata.ODataPropertyBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the current value of the bound target
* @returns {any} the current value of the bound target
*/
public getValue(): any;
/**
* Initialize the binding. The message should be called when creating a binding.
* If metadata is not yet available, do nothing, method will be called again when
* metadata is loaded.
*/
protected initialize(): void;
}
/**
*/
namespace ODataUtils {
/**
* Compares the given OData values based on their type. All date and time types can also be
* compared with a number. This number is then interpreted as the number of milliseconds that
* the corresponding date or time object should hold.
* @param {any} vValue1 - the first value to compare
* @param {any} vValue2 - the second value to compare
* @param {string} bAsDecimal - if true
, the string values vValue1
and vValue2
are compared as a decimal number (only sign, integer and fraction digits; no exponential format). Otherwise they are recognized by looking at their types.
* @returns {number} the result of the compare: 0
if the values are equal, -1
if the first value is smaller, 1
if the first value is larger, NaN
if they cannot be compared
*/
function compare(vValue1: any, vValue2: any, bAsDecimal?: string): number;
/**
* Formats a JavaScript value according to the given
*
* EDM type.
* @param {any} vValue - the value to format
* @param {string} sType - the EDM type (e.g. Edm.Decimal)
* @returns {string} the formatted value
*/
function formatValue(vValue: any, sType: string): string;
/**
* Returns a comparator function optimized for the given EDM type.
* @param {string} sEdmType - the EDM type
* @returns {Function} the comparator function taking two values of the given type and returning 0
if the values are equal, -1
if the first value is smaller, 1
if the first value is larger and NaN
if they cannot be compared (e.g. one value is null
or undefined
)
*/
function getComparator(sEdmType: string): Function;
/**
* Adds an origin to the given service URL.
* If an origin is already present, it will only be replaced if the parameters object contains the flag "force: true".
* In case the URL already contains URL parameters, these will be kept.
* As a parameter, a sole alias is sufficient. The parameters vParameters.system and vParameters.client however have to be given in pairs.
* In case all three origin specifying parameters are given (system/client/alias), the alias has precedence.
*
* Examples:
* setOrigin("/backend/service/url/", "DEMO_123");
* - result: /backend/service/url;o=DEMO_123/
*
* setOrigin("/backend/service/url;o=OTHERSYS8?myUrlParam=true&x=4", {alias: "DEMO_123", force: true});
* - result /backend/service/url;o=DEMO_123?myUrlParam=true&x=4
*
* setOrigin("/backend/service/url/", {system: "DEMO", client: 134});
* - result /backend/service/url;o=sid(DEMO.134)/
* @param {string} sServiceURL - the URL which will be enriched with an origin
* @param {any|string} vParameters - if string then it is asumed its the system alias, else if the argument is an object then additional Parameters can be given
* @returns {string} the service URL with the added origin.
*/
function setOrigin(sServiceURL: string, vParameters: any|string): string;
}
/**
* Different modes for executing service operations (filtering, sorting)
*/
export enum OperationMode {
/**
* With operation mode Auto
, operations are either processed on the client or
* on the server. The exact behavior depends on the configured {@link sap.ui.model.odata.CountMode CountMode},
* on the threshold
and on the size of the data:
*
* - Count Modes
Request
and Both
* Initially the binding will issue a $count
request without any filters/sorters.
*
* - If the count is lower or equal to the threshold, the binding will behave like in operation mode
*
Client
, and a data request for all entries is issued.
* - If the count exceeds the threshold, the binding will behave like in operation mode
Server
.
*
*
*
* - Count Modes
Inline
or
InlineRepeat
* The initial request tries to fetch as many entries as configured with the threshold
parameter,
* without specifying any filters/sorters. In addition, the query parameter $inlinecount
is added.
* The binding assumes, that the threshold given by the application can be met, but it adapts its behavior
* depending on the response:
*
* - If the response returns fewer (or just as many) entries as the threshold, the binding will behave exactly
* like when using the operation mode
Client
. Initially configured filters/sorters will be
* applied afterwards on the client.
* - If the
$inlinecount
is higher than the threshold, the binding will behave like in operation
* mode Server
. In this case a new data request containing the initially set filters/sorters
* will be issued.
*
* It is up to the application to chose an appropriate threshold value. Ideally, it should be high enough
* to fetch all data in the most common scenarios (to avoid a fallback to operation mode Server
,
* requiring an additional request), but it also should be low enough to ensure a fast response in case there
* is much more data than expected.
*
* Count mode None
is not supported together with operation mode Auto
*
*/
Auto = "Auto",
/**
* Operations are executed on the client, all entries must be available to be able to do so.
* The initial request fetches the complete collection, filtering and sorting does not trigger further requests.
*/
Client = "Client",
/**
* Operations are executed on the OData service, by appending corresponding URL parameters
* ($filter
, $orderby
).
* Each change in filtering or sorting triggers a new request to the server.
*/
Server = "Server",
}
/**
* The types in this namespace are {@link sap.ui.model.SimpleType simple types} corresponding
* to OData primitive types for both
* {@link http://www.odata.org/documentation/odata-version-2-0/overview#AbstractTypeSystem OData V2}
* and
* {@link http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part3-csdl.html OData V4} (see
* "4.4 Primitive Types").
*
* They can be used in any place where simple types are allowed (and the model representation
* matches), but they are of course most valuable when used in bindings to a
* {@link sap.ui.model.odata.v2.ODataModel} or {@link sap.ui.model.odata.v4.ODataModel}.
*
* Example:
*
* <Label text="ID"/>
* <Input value="{path : 'id', type : 'sap.ui.model.odata.type.String',
* constraints : {nullable : false, maxLength : 10}}"/>
* <Label text="valid through"/>
* <Input value="{path : 'validThrough', type : 'sap.ui.model.odata.type.DateTime',
* constraints : {displayFormat : 'Date'}}"/>
*
*
* All types support formatting from the representation used in ODataModel ("model format") to
* various representations used by UI elements ("target type") and vice versa. Additionally they
* support validating a given value against the type's constraints.
*
* The following target types may be supported:
*
* Type Description
* string
The value is converted to a string
, so that it
* can be displayed in an input field. Supported by all types.
* boolean
The value is converted to a Boolean
, so that
* it can be displayed in a checkbox. Only supported by
* {@link sap.ui.model.odata.type.Boolean}.
* int
The value is converted to an integer (as number
).
* May cause truncation of decimals and overruns. Supported by all numeric types.
* float
The value is converted to a number
. Supported by
* all numeric types.
* any
A technical format. The value is simply passed through. Only
* supported by format
, not by parse
. Supported by all types.
*
*
* All constraints relevant for OData V2 may be given as strings besides their natural types (e.g.
* nullable : "false"
or maxLength : "10"
). This makes the life of
* template processors easier, but is not needed for OData V4.
*
* Handling of null
:
*
* All types handle null
in the same way. When formatting to string
, it
* is simply passed through (and undefined
becomes null
, too). When
* parsing from string
, it is also passed through. Additionally,
* {@link sap.ui.model.odata.type.String String} and {@link sap.ui.model.odata.type.Guid Guid}
* convert the empty string to null
when parsing. validate
decides based
* on the constraint nullable
: If false
, null
is not
* accepted and leads to a (locale-dependent) ParseException
.
*
* This ensures that the user cannot clear an input field bound to an attribute with non-nullable
* type. However it does not ensure that the user really entered something if the field was empty
* before.
*/
namespace type {
/**
* This class represents the OData primitive type
* Edm.Boolean
.
*
* In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel}
* this type is represented as a boolean
.
*/
export class Boolean extends sap.ui.model.odata.type.ODataType {
/**
* Constructor for an OData primitive type Edm.Boolean
.
* @param {any} oFormatOptions - format options as defined in the interface of {@link sap.ui.model.SimpleType}; this type ignores them since it does not support any format options
* @param {any} oConstraints - constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.Boolean with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.ODataType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Formats the given boolean value to the given target type.
* @param {boolean} bValue - the value to be formatted
* @param {string} sTargetType - the target type; may be "any", "boolean", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. If the target type (or its primitive type) is "string", the result is "Yes" or "No" in the current {@link sap.ui.core.Configuration#getLanguage language}. See {@link sap.ui.model.odata.type} for more information.
* @returns {boolean|string} the formatted output value in the target type; undefined
or null
are formatted to null
*/
public formatValue(bValue: boolean, sTargetType: string): boolean|string;
/**
* Returns a metadata object for class sap.ui.model.odata.type.Boolean.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} the type's name
*/
public getName(): string;
/**
* Parses the given value from the given type to a boolean.
* @param {boolean|string} vValue - the value to be parsed; the empty string and null
are parsed to null
* @param {string} sSourceType - the source type (the expected type of vValue
); may be "boolean", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {boolean} the parsed value
*/
public parseValue(vValue: boolean|string, sSourceType: string): boolean;
/**
* Validates whether the given value in model representation is valid and meets the given
* constraints.
* @param {boolean} bValue - the value to be validated
*/
public validateValue(bValue: boolean): void;
}
/**
* This class represents the OData primitive type
* Edm.Byte
.
*
* In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel}
* this type is represented as a number
.
*/
export class Byte extends sap.ui.model.odata.type.Int {
/**
* Constructor for a primitive type Edm.Byte
.
* @param {any} oFormatOptions - format options as defined in {@link sap.ui.core.format.NumberFormat}
* @param {any} oConstraints - constraints; {@link sap.ui.model.odata.type.Int#validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.Byte with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.Int.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.odata.type.Byte.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} the type's name
*/
public getName(): string;
/**
* Returns the type's supported range as object with properties minimum
and
* maximum
.
* @returns {any} the range
*/
protected getRange(): any;
}
/**
* This class represents the OData V4 primitive type Edm.Date
.
*
* In {@link sap.ui.model.odata.v4.ODataModel} this type is represented as a
* string
in the format "yyyy-mm-dd".
*/
export class Date extends sap.ui.model.odata.type.ODataType {
/**
* Constructor for an OData primitive type Edm.Date
.
* @param {any} oFormatOptions - format options as defined in {@link sap.ui.core.format.DateFormat}
* @param {any} oConstraints - constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.Date with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.ODataType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Formats the given value to the given target type.
* @param {string} sValue - the value to be formatted
* @param {string} sTargetType - the target type; may be "any", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {string} the formatted output value in the target type; undefined
or null
are formatted to null
*/
public formatValue(sValue: string, sTargetType: string): string;
/**
* Returns a metadata object for class sap.ui.model.odata.type.Date.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} the type's name
*/
public getName(): string;
/**
* Parses the given value to a date.
* @param {string} sValue - the value to be parsed, maps ""
to null
* @param {string} sSourceType - the source type (the expected type of sValue
); must be "string", or a type with "string" as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {string} the parsed value
*/
public parseValue(sValue: string, sSourceType: string): string;
/**
* Validates whether the given value in model representation is valid and meets the
* given constraints.
* @param {string} sValue - the value to be validated
*/
public validateValue(sValue: string): void;
}
/**
* This class represents the OData V2 primitive type
* Edm.DateTime
.
*
* If you want to display a date and a time, prefer {@link
* sap.ui.model.odata.type.DateTimeOffset}, specifically designed for this purpose.
*
* Use DateTime
with the SAP-specific annotation display-format=Date
* (resp. the constraint displayFormat: "Date"
) to display only a date.
*
* In {@link sap.ui.model.odata.v2.ODataModel} this type is represented as a
* Date
. With the constraint displayFormat: "Date"
, the time zone is
* UTF and the time part is ignored, otherwise it is a date/time value in local time.
*/
export class DateTime extends sap.ui.model.odata.type.DateTimeBase {
/**
* Constructor for a primitive type Edm.DateTime
.
* @param {any} oFormatOptions - format options as defined in {@link sap.ui.core.format.DateFormat}
* @param {any} oConstraints - constraints; {@link sap.ui.model.odata.type.DateTimeBase#validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.DateTime with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.DateTimeBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.odata.type.DateTime.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} the type's name
*/
public getName(): string;
}
/**
* This is an abstract base class for the OData primitive types
* Edm.DateTime
and Edm.DateTimeOffset
.
*/
export class DateTimeBase extends sap.ui.model.odata.type.ODataType {
/**
* Base constructor for the primitive types Edm.DateTime
and
* Edm.DateTimeOffset
.
* @param {any} oFormatOptions - Type-specific format options; see subtypes
* @param {any} oConstraints - Constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.DateTimeBase with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.ODataType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Formats the given value to the given target type.
* @param {Date} oValue - The value to be formatted, which is represented in the model as a Date
instance (OData V2)
* @param {string} sTargetType - The target type, may be "any", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {Date|string} The formatted output value in the target type; undefined
or null
are formatted to null
*/
public formatValue(oValue: Date, sTargetType: string): Date|string;
/**
* Returns a metadata object for class sap.ui.model.odata.type.DateTimeBase.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Parses the given value to a Date
instance (OData V2).
* @param {string} sValue - The value to be parsed; the empty string and null
are parsed to null
* @param {string} sSourceType - The source type (the expected type of sValue
), must be "string", or a type with "string" as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {Date} The parsed value
*/
public parseValue(sValue: string, sSourceType: string): Date;
/**
* Validates whether the given value in model representation is valid and meets the
* defined constraints.
* @param {Date} oValue - The value to be validated
*/
public validateValue(oValue: Date): void;
}
/**
* This class represents the OData primitive type
* Edm.DateTimeOffset
.
*
* In {@link sap.ui.model.odata.v2.ODataModel} this type is represented as a
* Date
instance in local time. In {@link sap.ui.model.odata.v4.ODataModel} this
* type is represented as a string
like "2014-11-27T13:47:26Z". See parameter
* oConstraints.V4
for more information.
*/
export class DateTimeOffset extends sap.ui.model.odata.type.DateTimeBase {
/**
* Constructor for a primitive type Edm.DateTimeOffset
.
* @param {any} oFormatOptions - Format options as defined in {@link sap.ui.core.format.DateFormat}
* @param {any} oConstraints - Constraints; {@link sap.ui.model.odata.type.DateTimeBase#validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.DateTimeOffset with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.DateTimeBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Formats the given value to the given target type.
* @param {Date|string} vValue - The value to be formatted, which is represented in the model as a Date
instance (OData V2) or as a string like "2014-11-27T13:47:26Z" (OData V4); both representations are accepted independent of the model's OData version
* @param {string} sTargetType - The target type, may be "any", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {Date|string} The formatted output value in the target type; undefined
or null
are formatted to null
*/
public formatValue(vValue: Date|string, sTargetType: string): Date|string;
/**
* Returns a metadata object for class sap.ui.model.odata.type.DateTimeOffset.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} The type's name
*/
public getName(): string;
/**
* Parses the given value to a Date
instance (OData V2) or a string like
* "2014-11-27T13:47:26Z" (OData V4), depending on the model's OData version.
* @param {string} sValue - The value to be parsed; the empty string and null
are parsed to null
* @param {string} sSourceType - The source type (the expected type of sValue
), must be "string", or a type with "string" as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {Date} The parsed value
*/
public parseValue(sValue: string, sSourceType: string): Date;
/**
* Validates whether the given value in model representation is valid and meets the
* defined constraints, depending on the model's OData version.
* @param {any} vValue - The value to be validated
*/
public validateValue(vValue: any): void;
}
/**
* This class represents the OData primitive type
* Edm.Decimal
.
*
* In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel}
* this type is represented as a string
. It never uses exponential format ("1e-5").
*/
export class Decimal extends sap.ui.model.odata.type.ODataType {
/**
* Constructor for a primitive type Edm.Decimal
.
* @param {any} oFormatOptions - format options as defined in {@link sap.ui.core.format.NumberFormat}. In contrast to NumberFormat groupingEnabled
defaults to true
. Note that maxFractionDigits
and minFractionDigits
are set to the value of the constraint scale
unless it is "variable". They can however be overwritten.
* @param {any} oConstraints - constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.Decimal with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.ODataType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Formats the given value to the given target type. When formatting to "string" the type's
* constraint scale
is taken into account.
* @param {string} sValue - the value to be formatted, which is represented as a string in the model
* @param {string} sTargetType - the target type; may be "any", "float", "int", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {number|string} the formatted output value in the target type; undefined
or null
are formatted to null
*/
public formatValue(sValue: string, sTargetType: string): number|string;
/**
* Returns a metadata object for class sap.ui.model.odata.type.Decimal.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} the type's name
*/
public getName(): string;
/**
* Parses the given value, which is expected to be of the given type, to a decimal in
* string
representation.
* @param {string|number} vValue - the value to be parsed; the empty string and null
are parsed to null
* @param {string} sSourceType - the source type (the expected type of vValue
); may be "float", "int", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {string} the parsed value
*/
public parseValue(vValue: string|number, sSourceType: string): string;
/**
* Validates whether the given value in model representation is valid and meets the
* defined constraints.
* @param {string} sValue - the value to be validated
*/
public validateValue(sValue: string): void;
}
/**
* This class represents the OData primitive type
* Edm.Double
.
*
* In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel}
* this type is represented as a number
.
*/
export class Double extends sap.ui.model.odata.type.ODataType {
/**
* Constructor for a primitive type Edm.Double
.
* @param {any} oFormatOptions - format options as defined in {@link sap.ui.core.format.NumberFormat}. In contrast to NumberFormat groupingEnabled
defaults to true
.
* @param {any} oConstraints - constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.Double with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.ODataType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Formats the given value to the given target type. When formatting to "string", very large
* or very small values are formatted to the exponential format (e.g. "-3.14 E+15").
* @param {number|string} vValue - the value to be formatted, which is represented as a number in the model
* @param {string} sTargetType - the target type; may be "any", "float", "int", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {number|string} the formatted output value in the target type; undefined
or null
are formatted to null
*/
public formatValue(vValue: number|string, sTargetType: string): number|string;
/**
* Returns a metadata object for class sap.ui.model.odata.type.Double.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} the type's name
*/
public getName(): string;
/**
* Parses the given value, which is expected to be of the given type, to an Edm.Double in
* number
representation.
* @param {string|number} vValue - the value to be parsed; the empty string and null
are parsed to null
; note that there is no way to enter Infinity
or NaN
values
* @param {string} sSourceType - the source type (the expected type of vValue
); may be "float", "int", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {number} the parsed value
*/
public parseValue(vValue: string|number, sSourceType: string): number;
/**
* Validates whether the given value in model representation is valid and meets the
* defined constraints.
* @param {number} fValue - the value to be validated
*/
public validateValue(fValue: number): void;
}
/**
* This class represents the OData primitive type
* Edm.Guid
.
*
* In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel}
* this type is represented as a string
.
*/
export class Guid extends sap.ui.model.odata.type.ODataType {
/**
* Constructor for an OData primitive type Edm.Guid
.
* @param {any} oFormatOptions - format options as defined in the interface of {@link sap.ui.model.SimpleType}; this type ignores them since it does not support any format options
* @param {any} oConstraints - constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.Guid with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.ODataType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Formats the given value to the given target type.
* @param {string} sValue - the value to be formatted
* @param {string} sTargetType - the target type; may be "any", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {string} the formatted output value in the target type; undefined
or null
are formatted to null
*/
public formatValue(sValue: string, sTargetType: string): string;
/**
* Returns a metadata object for class sap.ui.model.odata.type.Guid.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} the type's name
*/
public getName(): string;
/**
* Parses the given value to a GUID.
* @param {string} sValue - the value to be parsed, maps ""
to null
* @param {string} sSourceType - the source type (the expected type of sValue
); must be "string", or a type with "string" as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {string} the parsed value
*/
public parseValue(sValue: string, sSourceType: string): string;
/**
* Validates whether the given value in model representation is valid and meets the
* given constraints.
* @param {string} sValue - the value to be validated
*/
public validateValue(sValue: string): void;
}
/**
* This is an abstract base class for integer-based
*
* OData primitive types like Edm.Int16
or Edm.Int32
.
*/
export class Int extends sap.ui.model.odata.type.ODataType {
/**
* Constructor for a new Int
.
* @param {any} oFormatOptions - type-specific format options; see subtypes
* @param {any} oConstraints - constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.Int with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.ODataType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Formats the given value to the given target type.
* When formatting to string
the format options are used.
* @param {number} iValue - the value in model representation to be formatted
* @param {string} sTargetType - the target type; may be "any", "int", "float", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {number|string} the formatted output value in the target type; undefined
or null
are formatted to null
*/
public formatValue(iValue: number, sTargetType: string): number|string;
/**
* Returns a metadata object for class sap.ui.model.odata.type.Int.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Parses the given value, which is expected to be of the given source type, to an Int in
* number representation.
* @param {number|string} vValue - the value to be parsed. The empty string and null
are parsed to null
.
* @param {string} sSourceType - the source type (the expected type of vValue
); may be "float", "int", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {number} the parsed value
*/
public parseValue(vValue: number|string, sSourceType: string): number;
/**
* Validates whether the given value in model representation is valid and meets the
* defined constraints.
* @param {number} iValue - the value to be validated
*/
public validateValue(iValue: number): void;
}
/**
* This class represents the OData primitive type
* Edm.Int16
.
*
* In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel}
* this type is represented as a number
.
*/
export class Int16 extends sap.ui.model.odata.type.Int {
/**
* Constructor for a primitive type Edm.Int16
.
* @param {any} oFormatOptions - format options as defined in {@link sap.ui.core.format.NumberFormat}. In contrast to NumberFormat groupingEnabled
defaults to true
.
* @param {any} oConstraints - constraints; {@link sap.ui.model.odata.type.Int#validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.Int16 with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.Int.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.odata.type.Int16.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} the type's name
*/
public getName(): string;
/**
* Returns the type's supported range as object with properties minimum
and
* maximum
.
* @returns {any} the range
*/
protected getRange(): any;
}
/**
* This class represents the OData primitive type
* Edm.Int32
.
*
* In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel}
* this type is represented as a number
.
*/
export class Int32 extends sap.ui.model.odata.type.Int {
/**
* Constructor for a primitive type Edm.Int32
.
* @param {any} oFormatOptions - format options as defined in {@link sap.ui.core.format.NumberFormat}. In contrast to NumberFormat groupingEnabled
defaults to true
.
* @param {any} oConstraints - constraints; {@link sap.ui.model.odata.type.Int#validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.Int32 with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.Int.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.odata.type.Int32.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} the type's name
*/
public getName(): string;
/**
* Returns the type's supported range as object with properties minimum
and
* maximum
.
* @returns {any} the range
*/
protected getRange(): any;
}
/**
* This class represents the OData primitive type
* Edm.Int64
.
*
* In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel}
* this type is represented as a string
.
*/
export class Int64 extends sap.ui.model.odata.type.ODataType {
/**
* Constructor for a primitive type Edm.Int64
.
* @param {any} oConstraints - constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oConstraints: any);
/**
* Constructor for a primitive type Edm.Int64
.
* @param {any} oFormatOptions - format options as defined in {@link sap.ui.core.format.NumberFormat}. In contrast to NumberFormat groupingEnabled
defaults to true
.
* @param {any} oConstraints - constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions: any, oConstraints: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.Int64 with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.ODataType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Formats the given value to the given target type.
* @param {string} sValue - the value to be formatted, which is represented as a string in the model
* @param {string} sTargetType - the target type; may be "any", "float", "int", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {number|string} the formatted output value in the target type; undefined
or null
are formatted to null
*/
public formatValue(sValue: string, sTargetType: string): number|string;
/**
* Returns a metadata object for class sap.ui.model.odata.type.Int64.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} the type's name
*/
public getName(): string;
/**
* Parses the given value, which is expected to be of the given type, to an Int64 in
* string
representation.
* @param {string|number} vValue - the value to be parsed; the empty string and null
are parsed to null
* @param {string} sSourceType - the source type (the expected type of vValue
); may be "float", "int", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {string} the parsed value
*/
public parseValue(vValue: string|number, sSourceType: string): string;
/**
* Validates whether the given value in model representation is valid and meets the
* defined constraints.
* @param {string} sValue - the value to be validated
*/
public validateValue(sValue: string): void;
}
/**
* This class is an abstract base class for all OData primitive types (see {@link
* http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part3-csdl/odata-v4.0-errata02-os-part3-csdl-complete.html#_The_edm:Documentation_Element
* OData V4 Edm Types} and
* {@link http://www.odata.org/documentation/odata-version-2-0/overview#AbstractTypeSystem
* OData V2 Edm Types}). All subtypes implement the interface of
* {@link sap.ui.model.SimpleType}. That means they implement next to the constructor:
*
* - {@link sap.ui.model.SimpleType#getName getName}
* - {@link sap.ui.model.SimpleType#formatValue formatValue}
* - {@link sap.ui.model.SimpleType#parseValue parseValue}
* - {@link sap.ui.model.SimpleType#validateValue validateValue}
*
*
* All ODataTypes are immutable. All format options and constraints are given to the
* constructor, they cannot be modified later.
*
* All ODataTypes use a locale-specific message when throwing an error caused by invalid
* user input (e.g. if {@link sap.ui.model.odata.type.Double#parseValue Double.parseValue}
* cannot parse the given value to a number, or if any type's {@link #validateValue
* validateValue} gets a null
, but the constraint nullable
is
* false
).
*/
export class ODataType extends sap.ui.model.SimpleType {
/**
* Constructor for a new ODataType
.
* @param {any} oFormatOptions - type-specific format options; see subtypes
* @param {any} oConstraints - type-specific constraints (e.g. oConstraints.nullable
), see subtypes
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.ODataType with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.SimpleType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {sap.ui.base.Interface} this
*/
public getInterface(): sap.ui.base.Interface;
/**
* Returns a metadata object for class sap.ui.model.odata.type.ODataType.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* This class represents a placeholder for all unsupported OData primitive types. It can
* only be used to retrieve raw values "as is" (i.e. formatValue(vValue, "any")
),
* but not to actually convert to or from any other representation or to validate.
*/
export class Raw extends sap.ui.model.odata.type.ODataType {
/**
* Constructor for a placeholder for all unsupported OData primitive types.
* @param {any} oFormatOptions - Must be undefined
* @param {any} oConstraints - Must be undefined
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.Raw with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.ODataType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Formats the given value to the given target type.
* @param {any} vValue - The raw value to be retrieved "as is"
* @param {string} sTargetType - The target type; must be "any"
* @returns {any} The raw value "as is"
*/
public formatValue(vValue: any, sTargetType: string): any;
/**
* Returns a metadata object for class sap.ui.model.odata.type.Raw.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} The type's name
*/
public getName(): string;
/**
* Method not supported
*/
public parseValue(): void;
/**
* Method not supported
*/
public validateValue(): void;
}
/**
* This class represents the OData primitive type
* Edm.SByte
.
*
* In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel}
* this type is represented as a number
.
*/
export class SByte extends sap.ui.model.odata.type.Int {
/**
* Constructor for a primitive type Edm.SByte
.
* @param {any} oFormatOptions - format options as defined in {@link sap.ui.core.format.NumberFormat}
* @param {any} oConstraints - constraints; {@link sap.ui.model.odata.type.Int#validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.SByte with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.Int.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.odata.type.SByte.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} the type's name
*/
public getName(): string;
/**
* Returns the type's supported range as object with properties minimum
and
* maximum
.
* @returns {any} the range
*/
protected getRange(): any;
}
/**
* This class represents the OData primitive type
* Edm.Single
.
*
* In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel}
* this type is represented as a number
.
*/
export class Single extends sap.ui.model.odata.type.ODataType {
/**
* Constructor for a primitive type Edm.Single
.
* @param {any} oFormatOptions - format options as defined in {@link sap.ui.core.format.NumberFormat}. In contrast to NumberFormat groupingEnabled
defaults to true
.
* @param {any} oConstraints - constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.Single with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.ODataType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Formats the given value to the given target type.
* @param {string|number} vValue - the value to be formatted, which is represented as a number in the model
* @param {string} sTargetType - the target type; may be "any", "float", "int", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {number|string} the formatted output value in the target type; undefined
or null
are formatted to null
*/
public formatValue(vValue: string|number, sTargetType: string): number|string;
/**
* Returns a metadata object for class sap.ui.model.odata.type.Single.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} the type's name
*/
public getName(): string;
/**
* Parses the given value, which is expected to be of the given type, to an Edm.Single in
* number
representation.
* @param {string|number} vValue - the value to be parsed; the empty string and null
are parsed to null
; note that there is no way to enter Infinity
or NaN
values
* @param {string} sSourceType - the source type (the expected type of vValue
); may be "float", "int", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {number} the parsed value
*/
public parseValue(vValue: string|number, sSourceType: string): number;
/**
* Validates whether the given value in model representation is valid and meets the
* defined constraints.
* @param {number} fValue - the value to be validated
*/
public validateValue(fValue: number): void;
}
/**
* This class represents the OData primitive type
* Edm.String
.
*
* In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel}
* this type is represented as a string
.
*/
export class String extends sap.ui.model.odata.type.ODataType {
/**
* Constructor for an OData primitive type Edm.String
.
* @param {any} oFormatOptions - format options as defined in the interface of {@link sap.ui.model.SimpleType}; this type ignores them since it does not support any format options
* @param {any} oConstraints - constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.String with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.ODataType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Formats the given value to the given target type.
* If isDigitSequence
constraint of this type is set to true
and the
* target type is any or string and the given value contains only digits, the leading zeros are
* truncated.
* @param {string} sValue - the value to be formatted
* @param {string} sTargetType - the target type; may be "any", "boolean", "float", "int" or "string". See {@link sap.ui.model.odata.type} for more information.
* @returns {string|number|boolean} the formatted output value in the target type; undefined
is always formatted to null
; null
is formatted to "" if the target type is "string".
*/
public formatValue(sValue: string, sTargetType: string): string|number|boolean;
/**
* Returns a metadata object for class sap.ui.model.odata.type.String.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} the type's name
*/
public getName(): string;
/**
* Parses the given value which is expected to be of the given type to a string.
* If isDigitSequence
constraint of this type is set to true
and
* the parsed string is a sequence of digits, then the parsed string is either enhanced with
* leading zeros, if maxLength
constraint is given, or leading zeros are removed
* from parsed string.
*
* Note: An empty input string (""
) is parsed to null
. This value will
* be rejected with a {@link sap.ui.model.ValidateException ValidateException} by
* {@link #validateValue} if the constraint nullable
is false
.
* @param {string|number|boolean} vValue - the value to be parsed
* @param {string} sSourceType - the source type (the expected type of vValue
). See {@link sap.ui.model.odata.type} for more information.
* @returns {string} the parsed value or null
if vValue
is ""
*/
public parseValue(vValue: string|number|boolean, sSourceType: string): string;
/**
* Validates whether the given value in model representation is valid and meets the
* defined constraints.
* @param {string} sValue - the value to be validated
*/
public validateValue(sValue: string): void;
}
/**
* This class represents the OData V2 primitive type
* Edm.Time
.
*
* In {@link sap.ui.model.odata.v2.ODataModel ODataModel} this type is represented as an
* object with two properties:
*
* __edmType
with the value "Edm.Time"
* ms
with the number of milliseconds since midnight
*
*/
export class Time extends sap.ui.model.odata.type.ODataType {
/**
* Constructor for an OData primitive type Edm.Time
.
* @param {any} oFormatOptions - format options as defined in {@link sap.ui.core.format.DateFormat}
* @param {any} oConstraints - constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.Time with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.ODataType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Formats the given value to the given target type
* @param {any} oValue - the value in model representation to be formatted.
* @param {string} sTargetType - the target type; may be "any", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {string} the formatted output value in the target type; undefined
or null
are formatted to null
*/
public formatValue(oValue: any, sTargetType: string): string;
/**
* Returns a metadata object for class sap.ui.model.odata.type.Time.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} the type's name
*/
public getName(): string;
/**
* Parses the given value, which is expected to be of the given type, to a time object.
* @param {string} sValue - the value to be parsed, maps ""
to null
* @param {string} sSourceType - the source type (the expected type of sValue
); must be "string", or a type with "string" as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {any} the parsed value as described in {@link #formatValue formatValue}
*/
public parseValue(sValue: string, sSourceType: string): any;
/**
* Validates whether the given value in model representation is valid and meets the
* defined constraints.
* @param {any} oValue - the value to be validated
*/
public validateValue(oValue: any): void;
}
/**
* This class represents the OData V4 primitive type {@link
* http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part3-csdl/odata-v4.0-errata02-os-part3-csdl-complete.html#_The_edm:Documentation_Element
* Edm.TimeOfDay
}.
* In {@link sap.ui.model.odata.v4.ODataModel} this type is represented as a
* string
.
*/
export class TimeOfDay extends sap.ui.model.odata.type.ODataType {
/**
* Constructor for an OData primitive type Edm.TimeOfDay
.
* @param {any} oFormatOptions - Format options as defined in {@link sap.ui.core.format.DateFormat}
* @param {any} oConstraints - Constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.odata.type.TimeOfDay with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.odata.type.ODataType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Formats the given value to the given target type.
* @param {string} sValue - The value to be formatted, which is represented as a string in the model
* @param {string} sTargetType - The target type, may be "any", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information
* @returns {string} The formatted output value in the target type; undefined
or null
are formatted to null
*/
public formatValue(sValue: string, sTargetType: string): string;
/**
* Returns a metadata object for class sap.ui.model.odata.type.TimeOfDay.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type's name.
* @returns {string} The type's name
*/
public getName(): string;
/**
* Parses the given value, which is expected to be of the given type, to a string with an
* OData V4 Edm.TimeOfDay value.
* @param {string} sValue - The value to be parsed, maps ""
to null
* @param {string} sSourceType - The source type (the expected type of sValue
), must be "string", or a type with "string" as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type} for more information.
* @returns {string} The parsed value
*/
public parseValue(sValue: string, sSourceType: string): string;
/**
* Validates the given value in model representation and meets the type's constraints.
* @param {string} sValue - The value to be validated
*/
public validateValue(sValue: string): void;
}
}
/**
* Different methods for update operations.
*/
export enum UpdateMethod {
/**
* Update requests will be send with HTTP method MERGE
.
*/
Merge = "Merge",
/**
* Update requests will be send with HTTP method PUT
.
*/
Put = "Put",
}
/**
* OData-based DataBinding
*/
namespace v2 {
/**
* Annotation loader for OData V2 services
*/
export class ODataAnnotations extends sap.ui.base.EventProvider {
/**
* Creates a new instance of the ODataAnnotations annotation loader.
* @param {sap.ui.model.odata.ODataMetadata} oMetadata - Metadata object with the metadata information needed to parse the annotations
* @param {{ [key: string]: any }} mOptions - Obligatory options
*/
public constructor(oMetadata: sap.ui.model.odata.ODataMetadata, mOptions: { [key: string]: any });
/**
* Adds one or several sources to the annotation loader. Sources will be loaded instantly but merged only after
* the previously added source has either been successfully merged or failed.
* @param {string|string[]|{ [key: string]: any }|{ [key: string]: any }[]} vSource - One or several annotation source(s). Can be either a string or a map of the type ODataAnnotations~Source
or an array containing several (either strings or source objects).
* @returns {Promise} The promise to (load,) parse and merge the given source(s). The Promise resolves on success with an array of maps containing properties source
and data
. See the parameters of the success
event for more details. The promise fails in case at least one source could not be (loaded,) parsed or merged with an array of objects containing Errors and/or Success objects.
*/
public addSource(vSource: string|string[]|{ [key: string]: any }|{ [key: string]: any }[]): Promise;
/**
* This event exists for compatibility with the old Annotation loader
* Attaches the given callback to the allFailed
event. This event is fired when no annotation from a group of
* sources was successfully (loaded,) parsed and merged.
* The parameter result
will be set on the event argument and contains an array of Errors in the order in which
* the sources had been added.
* @param {Function} fnFunction - The event callback. This function will be called in the context of the oListener object if given as the next argument.
* @param {any} oListener - Object to use as context of the callback. If empty, the global context is used.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining
*/
public attachAllFailed(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* This event exists for compatibility with the old Annotation loader
* Attaches the given callback to the allFailed
event. This event is fired when no annotation from a group of
* sources was successfully (loaded,) parsed and merged.
* The parameter result
will be set on the event argument and contains an array of Errors in the order in which
* the sources had been added.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The event callback. This function will be called in the context of the oListener object if given as the next argument.
* @param {any} oListener - Object to use as context of the callback. If empty, the global context is used.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining
*/
public attachAllFailed(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* Attaches the given callback to the error
event, which is fired whenever a source cannot be loaded, parsed or
* merged into the annotation data.
* The following parameters will be set on the event object that is given to the callback function:
* source
- A map containing the properties type
- containing either "url" or "xml" - and data
containing
* the data given as source, either a URL or an XML string depending on how the source was added.
* error
- An Error object describing the problem that occurred
* @param {Function} fnFunction - The event callback. This function will be called in the context of the oListener object if given as the next argument.
* @param {any} oListener - Object to use as context of the callback. If empty, the global context is used.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining
*/
public attachError(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* Attaches the given callback to the error
event, which is fired whenever a source cannot be loaded, parsed or
* merged into the annotation data.
* The following parameters will be set on the event object that is given to the callback function:
* source
- A map containing the properties type
- containing either "url" or "xml" - and data
containing
* the data given as source, either a URL or an XML string depending on how the source was added.
* error
- An Error object describing the problem that occurred
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The event callback. This function will be called in the context of the oListener object if given as the next argument.
* @param {any} oListener - Object to use as context of the callback. If empty, the global context is used.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining
*/
public attachError(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* Attaches the given callback to the failed
event. This event is fired when at least one annotation from a group
* of sources was not successfully (loaded,) parsed or merged.
* The parameter result
will be set on the event argument and contains an array of Errors in the order in which
* the sources had been added.
* @param {Function} fnFunction - The event callback. This function will be called in the context of the oListener object if given as the next argument.
* @param {any} oListener - Object to use as context of the callback. If empty, the global context is used.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining
*/
public attachFailed(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* Attaches the given callback to the failed
event. This event is fired when at least one annotation from a group
* of sources was not successfully (loaded,) parsed or merged.
* The parameter result
will be set on the event argument and contains an array of Errors in the order in which
* the sources had been added.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The event callback. This function will be called in the context of the oListener object if given as the next argument.
* @param {any} oListener - Object to use as context of the callback. If empty, the global context is used.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining
*/
public attachFailed(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* Attaches the given callback to the loaded
event. This event is fired when all annotations from a group of
* sources was successfully (loaded,) parsed and merged.
* The parameter result
will be set on the event argument and contains an array of all loaded sources as well
* as Errors in the order in which they had been added.
* @param {Function} fnFunction - The event callback. This function will be called in the context of the oListener object if given as the next argument.
* @param {any} oListener - Object to use as context of the callback. If empty, the global context is used.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining
*/
public attachLoaded(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* Attaches the given callback to the loaded
event. This event is fired when all annotations from a group of
* sources was successfully (loaded,) parsed and merged.
* The parameter result
will be set on the event argument and contains an array of all loaded sources as well
* as Errors in the order in which they had been added.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The event callback. This function will be called in the context of the oListener object if given as the next argument.
* @param {any} oListener - Object to use as context of the callback. If empty, the global context is used.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining
*/
public attachLoaded(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* This event exists for compatibility with the old Annotation loader
* Attaches the given callback to the someLoaded
event. This event is fired when at least one annotation from a
* group of sources was successfully (loaded,) parsed and merged.
* The parameter result
will be set on the event argument and contains an array of all loaded sources as well
* as Errors in the order in which they had been added.
* @param {Function} fnFunction - The event callback. This function will be called in the context of the oListener object if given as the next argument.
* @param {any} oListener - Object to use as context of the callback. If empty, the global context is used.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining
*/
public attachSomeLoaded(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* This event exists for compatibility with the old Annotation loader
* Attaches the given callback to the someLoaded
event. This event is fired when at least one annotation from a
* group of sources was successfully (loaded,) parsed and merged.
* The parameter result
will be set on the event argument and contains an array of all loaded sources as well
* as Errors in the order in which they had been added.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The event callback. This function will be called in the context of the oListener object if given as the next argument.
* @param {any} oListener - Object to use as context of the callback. If empty, the global context is used.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining
*/
public attachSomeLoaded(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* Attaches the given callback to the success
event, which is fired whenever a source has been successfully
* (loaded,) parsed and merged into the annotation data.
* The following parameters will be set on the event object that is given to the callback function:
* source
- A map containing the properties type
- containing either "url" or "xml" - and data
containing
* the data given as source, either a URL or an XML string depending on how the source was added.
* @param {Function} fnFunction - The event callback. This function will be called in the context of the oListener object if given as the next argument.
* @param {any} oListener - Object to use as context of the callback. If empty, the global context is used.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining.
*/
public attachSuccess(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* Attaches the given callback to the success
event, which is fired whenever a source has been successfully
* (loaded,) parsed and merged into the annotation data.
* The following parameters will be set on the event object that is given to the callback function:
* source
- A map containing the properties type
- containing either "url" or "xml" - and data
containing
* the data given as source, either a URL or an XML string depending on how the source was added.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The event callback. This function will be called in the context of the oListener object if given as the next argument.
* @param {any} oListener - Object to use as context of the callback. If empty, the global context is used.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining.
*/
public attachSuccess(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* Detaches the given callback from the allFailed
event.
* The passed function and listener object must match the ones previously used for attaching to the event.
* @param {Function} fnFunction - The event callback previously used with {@link sap.ui.model.odata.v2.ODataAnnotations#attachFailed}.
* @param {any} oListener - The same (if any) context object that was used when attaching to the error
event.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining.
*/
public detachAllFailed(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* Detaches the given callback from the error
event.
* The passed function and listener object must match the ones previously used for attaching to the event.
* @param {Function} fnFunction - The event callback previously used with {@link sap.ui.model.odata.v2.ODataAnnotations#attachError}.
* @param {any} oListener - The same (if any) context object that was used when attaching to the error
event.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining.
*/
public detachError(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* Detaches the given callback from the failed
event.
* The passed function and listener object must match the ones previously used for attaching to the event.
* @param {Function} fnFunction - The event callback previously used with {@link sap.ui.model.odata.v2.ODataAnnotations#attachFailed}.
* @param {any} oListener - The same (if any) context object that was used when attaching to the error
event.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining.
*/
public detachFailed(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* Detaches the given callback from the loaded
event.
* The passed function and listener object must match the ones previously used for attaching to the event.
* @param {Function} fnFunction - The event callback previously used with {@link sap.ui.model.odata.v2.ODataAnnotations#attachLoaded}.
* @param {any} oListener - The same (if any) context object that was used when attaching to the error
event.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining.
*/
public detachLoaded(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* Detaches the given callback from the someLoaded
event.
* The passed function and listener object must match the ones previously used for attaching to the event.
* @param {Function} fnFunction - The event callback previously used with {@link sap.ui.model.odata.v2.ODataAnnotations#attachSomeLoaded}.
* @param {any} oListener - The same (if any) context object that was used when attaching to the error
event.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining.
*/
public detachSomeLoaded(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* Detaches the given callback from the success
event.
* The passed function and listener object must match the ones previously used for attaching to the event.
* @param {Function} fnFunction - The event callback previously used with {@link sap.ui.model.odata.v2.ODataAnnotations#attachSuccess}.
* @param {any} oListener - The same (if any) context object that was used when attaching to the success
event.
* @returns {sap.ui.model.odata.v2.ODataAnnotations} this
-reference to allow method chaining.
*/
public detachSuccess(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataAnnotations;
/**
* Creates a new subclass of class sap.ui.model.odata.v2.ODataAnnotations with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* V1 API Compatibility method. @see sap.ui.model.odata.v2.ODataAnnotations#getData
* Returns the parsed and merged annotation data object
* @returns {any} returns annotations data
*/
public getAnnotationsData(): any;
/**
* Returns the parsed and merged annotation data object
* @returns {any} returns annotations data
*/
public getData(): any;
/**
* Returns a metadata object for class sap.ui.model.odata.v2.ODataAnnotations.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns a promise that resolves when the annotation sources that were added up to this point were successfully
* (loaded,) parsed and merged
* @returns {Promise} The Promise that resolves/rejects after the last added sources have been processed
*/
public loaded(): Promise;
/**
* Set custom headers which are provided in a key/value map. These headers are used for all requests.
* The "Accept-Language" header cannot be modified and is set using the core's language setting.
*
* To remove these headers, simply set the mHeaders
parameter to {}
. Please also note that when calling this method
* again all previous custom headers are removed unless they are specified again in the mCustomHeaders
parameter.
* @param {{ [key: string]: any }} mHeaders - the header name/value map.
*/
public setHeaders(mHeaders: { [key: string]: any }): void;
}
/**
* The ContextBinding is a specific binding for a setting context for the model
*/
export class ODataContextBinding extends sap.ui.model.ContextBinding {
/**
* Constructor for odata.ODataContextBinding
* @param {sap.ui.model.Model} oModel
* @param {string} sPath
* @param {Object} oContext
* @param {{ [key: string]: any }} mParameters - a map which contains additional parameters for the binding.
*/
public constructor(oModel: sap.ui.model.Model, sPath: string, oContext: Object, mParameters?: { [key: string]: any });
/**
* Creates a new subclass of class sap.ui.model.odata.v2.ODataContextBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.ContextBinding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.odata.v2.ODataContextBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* @param {boolean} bForceUpdate - Update the bound control even if no data has been changed
* @param {string} sGroupId - The group Id for the refresh
*/
public refresh(bForceUpdate?: boolean, sGroupId?: string): void;
}
/**
* List binding implementation for oData format.
*/
export class ODataListBinding extends sap.ui.model.ListBinding {
/**
* @param {sap.ui.model.odata.v2.ODataModel} oModel - Model that this list binding belongs to
* @param {string} sPath - Path into the model data, relative to the given oContext
* @param {sap.ui.model.Context} oContext - Context that the sPath
is based on
* @param {sap.ui.model.Sorter|sap.ui.model.Sorter[]} aSorters - Initial sort order, can be either a sorter or an array of sorters
* @param {sap.ui.model.Filter|sap.ui.model.Filter[]} aFilters - Predefined filters, can be either a filter or an array of filters
* @param {{ [key: string]: any }} mParameters - A map which contains additional parameters for the binding
*/
public constructor(oModel: sap.ui.model.odata.v2.ODataModel, sPath: string, oContext: sap.ui.model.Context, aSorters?: sap.ui.model.Sorter|sap.ui.model.Sorter[], aFilters?: sap.ui.model.Filter|sap.ui.model.Filter[], mParameters?: { [key: string]: any });
/**
* Creates a new subclass of class sap.ui.model.odata.v2.ODataListBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.ListBinding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Filters the list.
*
* When using sap.ui.model.Filter
the filters are first grouped according to their binding path.
* All filters belonging to the same group are combined with OR and after that the
* results of all groups are combined with AND.
* Usually this means, all filters applied to a single table column
* are combined with OR, while filters on different table columns are combined with AND.
* Please note that a custom filter function is only supported with operation mode sap.ui.model.odata.OperationMode.Client
.
* @param {sap.ui.model.Filter|sap.ui.model.Filter[]} aFilters - Single filter or array of filter objects
* @param {sap.ui.model.FilterType} sFilterType - Type of the filter which should be adjusted, if it is not given, the standard behaviour applies
* @param {boolean} bReturnSuccess - Whether the success indicator should be returned instead of this
* @returns {sap.ui.model.ListBinding} Reference to this
to facilitate method chaining or a boolean success indicator
*/
public filter(aFilters: sap.ui.model.Filter|sap.ui.model.Filter[], sFilterType: sap.ui.model.FilterType, bReturnSuccess?: boolean): sap.ui.model.ListBinding;
/**
* Return contexts for the list.
* @param {number} iStartIndex - The start index of the requested contexts
* @param {number} iLength - The requested amount of contexts
* @param {number} iThreshold - The threshold value
* @returns {sap.ui.model.Context[]} The array of contexts for each row of the bound list
*/
protected getContexts(iStartIndex?: number, iLength?: number, iThreshold?: number): sap.ui.model.Context[];
/**
* Get a download URL with the specified format considering the
* sort/filter/custom parameters.
* @param {string} sFormat - Value for the $format Parameter
* @returns {string} URL which can be used for downloading
*/
public getDownloadUrl(sFormat: string): string;
/**
* Return the length of the list.
*
* In case the final length is unknown (e.g. when searching on a large dataset), this will
* return an estimated length.
* @returns {number} The length
*/
public getLength(): number;
/**
* Returns a metadata object for class sap.ui.model.odata.v2.ODataListBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Initialize binding.
*
* Fires a change if data is already available ($expand) or a refresh.
* If metadata is not yet available, do nothing, method will be called again when
* metadata is loaded.
*/
public initialize(): void;
/**
* Refreshes the binding, check whether the model data has been changed and fire change event
* if this is the case. For server side models this should refetch the data from the server.
* To update a control, even if no data has been changed, e.g. to reset a control after failed
* validation, please use the parameter bForceUpdate.
* @param {boolean} bForceUpdate - Update the bound control even if no data has been changed
* @param {string} sGroupId - The group Id for the refresh
*/
public refresh(bForceUpdate?: boolean, sGroupId?: string): void;
/**
* Sorts the list.
* @param {sap.ui.model.Sorter|sap.ui.model.Sorter[]} aSorters - A new sorter or an array of sorters which define the sort order
* @param {boolean} bReturnSuccess - Whether the success indicator should be returned instead of this
* @returns {sap.ui.model.ListBinding} Reference to this
to facilitate method chaining or the success indicator
*/
public sort(aSorters: sap.ui.model.Sorter|sap.ui.model.Sorter[], bReturnSuccess?: boolean): sap.ui.model.ListBinding;
}
/**
* Model implementation for oData format
*/
export class ODataModel extends sap.ui.model.Model {
/**
* Constructor for a new ODataModel.
* @param {string|any} serviceUrl - Base URI of the service to request data from; additional URL parameters appended here will be appended to every request. If you pass an object it will be interpreted as the parameter object (second parameter). Then mParameters.serviceUrl
is a required parameter.
* @param {any} mParameters - Map which contains the following parameter properties:
*/
public constructor(serviceUrl: string|any, mParameters?: any);
/**
* Adds (a) new URL(s) whose content should be parsed as OData annotations, which are then merged into the annotations object
* which can be retrieved by calling the {@link #getServiceAnnotations}-method. If a $metadata
URL is passed,
* the data will also be merged into the metadata object, which can be reached by calling the {@link #getServiceMetadata} method.
* @param {string|string[]} vUrl - Either one URL as string or an array of URL strings
* @returns {Promise} The Promise to load the given URL(s), resolved if all URLs have been loaded, rejected if at least one fails to load. If this promise resolves it returns an object with the following properties: annotations
: The annotation object entitySets
: An array of EntitySet objects containing the newly merged EntitySets from a $metadata
requests. The structure is the same as in the metadata object reached by the getServiceMetadata()
method. For non-$metadata
requests the array will be empty.
*/
protected addAnnotationUrl(vUrl: string|string[]): Promise;
/**
* Adds new XML content to be parsed for OData annotations, which are then merged into the annotations object which
* can be retrieved by calling the {@link #getServiceAnnotations}-method.
* @param {string} sXMLContent - The string that should be parsed as annotation XML
* @param {boolean} bSuppressEvents - Whether not to fire annotationsLoaded event on the annotationParser
* @returns {Promise} The Promise to parse the given XML-String, resolved if parsed without errors, rejected if errors occur
*/
protected addAnnotationXML(sXMLContent: string, bSuppressEvents?: boolean): Promise;
/**
* Returns a promise that resolves with an array containing information about the initially loaded annotations.
*
* Important: This covers the annotations that were given to the model constructor, not the ones that might have
* been added later on using the protected API method {@link #addAnnotationUrl}. In order to get information about those,
* the event annotationsLoaded
can be used.
* @returns {Promise} A promise to load the annotation URLs that were given to the model on instantiation
*/
public annotationsLoaded(): Promise;
/**
* Attach event-handler fnFunction
to the annotationsFailed
event of this sap.ui.model.odata.v2.ODataModel
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public attachAnnotationsFailed(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Attach event-handler fnFunction
to the annotationsFailed
event of this sap.ui.model.odata.v2.ODataModel
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public attachAnnotationsFailed(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Attach event-handler fnFunction
to the annotationsLoaded
event of this sap.ui.model.odata.v2.ODataModel
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public attachAnnotationsLoaded(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Attach event-handler fnFunction
to the annotationsLoaded
event of this sap.ui.model.odata.v2.ODataModel
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public attachAnnotationsLoaded(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Attach event-handler fnFunction
to the batchRequestCompleted
event of this sap.ui.model.odata.v2.ODataModel
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public attachBatchRequestCompleted(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Attach event-handler fnFunction
to the batchRequestCompleted
event of this sap.ui.model.odata.v2.ODataModel
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public attachBatchRequestCompleted(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Attach event-handler fnFunction
to the batchRequestFailed
event of this sap.ui.model.odata.v2.ODataModel
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public attachBatchRequestFailed(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Attach event-handler fnFunction
to the batchRequestFailed
event of this sap.ui.model.odata.v2.ODataModel
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public attachBatchRequestFailed(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Attach event-handler fnFunction
to the requestSent
event of this sap.ui.model.odata.v2.ODataModel
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public attachBatchRequestSent(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Attach event-handler fnFunction
to the requestSent
event of this sap.ui.model.odata.v2.ODataModel
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public attachBatchRequestSent(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Attach event-handler fnFunction
to the metadataFailed
event of this sap.ui.model.odata.v2.ODataModel
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public attachMetadataFailed(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Attach event-handler fnFunction
to the metadataFailed
event of this sap.ui.model.odata.v2.ODataModel
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public attachMetadataFailed(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Attach event-handler fnFunction
to the metadataLoaded
event of this sap.ui.model.odata.v2.ODataModel
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public attachMetadataLoaded(fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Attach event-handler fnFunction
to the metadataLoaded
event of this sap.ui.model.odata.v2.ODataModel
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, the global context (window) is used.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public attachMetadataLoaded(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Creates new context binding for this model.
* @param {string} sPath - Resolved path
* @param {sap.ui.model.Context} oContext - Context object
* @param {{ [key: string]: any }} mParameters - Map of parameters
* @returns {sap.ui.model.ContextBinding} The new context binding
*/
public bindContext(sPath: string, oContext: sap.ui.model.Context, mParameters?: { [key: string]: any }): sap.ui.model.ContextBinding;
/**
* Creates a new list binding for this model.
* @param {string} sPath - Binding path, either absolute or relative to a given oContext
* @param {sap.ui.model.Context} oContext - Binding context referring to this model
* @param {sap.ui.model.Sorter|sap.ui.model.Sorter[]} aSorters - Initial sort order, can be either a sorter or an array of sorters
* @param {sap.ui.model.Filter|sap.ui.model.Filter[]} aFilters - Predefined filters, can be either a filter or an array of filters
* @param {{ [key: string]: any }} mParameters - Map which contains additional parameters for the binding
* @returns {sap.ui.model.ListBinding} The new list binding
*/
public bindList(sPath: string, oContext?: sap.ui.model.Context, aSorters?: sap.ui.model.Sorter|sap.ui.model.Sorter[], aFilters?: sap.ui.model.Filter|sap.ui.model.Filter[], mParameters?: { [key: string]: any }): sap.ui.model.ListBinding;
/**
* Creates a new property binding for this model.
* @param {string} sPath - Path pointing to the property that should be bound; either an absolute path or a path relative to a given oContext
* @param {any} oContext - A context object for the new binding
* @param {{ [key: string]: any }} mParameters - Map of optional parameters for the binding; the ODataModel (v2) currently supports no additional parameters
* @returns {sap.ui.model.PropertyBinding} The new property binding
*/
public bindProperty(sPath: string, oContext?: any, mParameters?: { [key: string]: any }): sap.ui.model.PropertyBinding;
/**
* Creates a new tree binding for this model.
* @param {string} sPath - Binding path, either absolute or relative to a given oContext
* @param {sap.ui.model.Context} oContext - Binding context referring to this model
* @param {sap.ui.model.Filter|sap.ui.model.Filter[]} aFilters - Predefined filters, can be either a filter or an array of filters
* @param {{ [key: string]: any }} mParameters - Map of parameters for the tree binding
* @param {sap.ui.model.Sorter[]} aSorters - An array of predefined sorters
* @returns {sap.ui.model.TreeBinding} The new tree binding
*/
public bindTree(sPath: string, oContext?: sap.ui.model.Context, aFilters?: sap.ui.model.Filter|sap.ui.model.Filter[], mParameters?: { [key: string]: any }, aSorters?: sap.ui.model.Sorter[]): sap.ui.model.TreeBinding;
/**
* Trigger a request to the function import OData service that was specified in the model constructor.
*
* If the return type of the function import is either an entity type or a collection of an entity type,
* then the changes are reflected in the model. Otherwise they are ignored, and the response
can
* be processed in the success
callback.
* @param {string} sFunctionName - A string containing the name of the function to call. The name is concatenated to the service URL which was specified in the model constructor.
* @param {{ [key: string]: any }} mParameters - Optional parameter map containing any of the following properties:
* @returns {any} An object which has a contextCreated
function that returns a Promise
. This resolves with the created {@link sap.ui.model.Context}. In addition it has an abort
function to abort the current request.
*/
public callFunction(sFunctionName: string, mParameters?: { [key: string]: any }): any;
/**
* Trigger a POST
request to the OData service that was specified in the model constructor.
*
* Please note that deep creates are not supported and may not work.
* @param {string} sPath - A string containing the path to the collection where an entry should be created. The path is concatenated to the service URL which was specified in the model constructor.
* @param {any} oData - Data of the entry that should be created.
* @param {{ [key: string]: any }} mParameters - Optional parameter map containing any of the following properties:
* @returns {any} An object which has an abort
function to abort the current request.
*/
public create(sPath: string, oData: any, mParameters?: { [key: string]: any }): any;
/**
* Creates a binding context for the given path.
*
* If the data of the context is not yet available, it can not be created, but first the
* entity needs to be fetched from the server asynchronously. In case no callback function
* is provided, the request will not be triggered.
* @param {string} sPath - Binding path
* @param {any} oContext - Binding context
* @param {{ [key: string]: any }} mParameters - Map which contains additional parameters for the binding
* @param {Function} fnCallBack - Function to be called when context has been created
* @param {boolean} bReload - Whether to reload data
* @returns {sap.ui.model.Context} The created binding context
*/
public createBindingContext(sPath: string, oContext?: any, mParameters?: { [key: string]: any }, fnCallBack?: Function, bReload?: boolean): sap.ui.model.Context;
/**
* Creates a new entry object which is described by the metadata of the entity type of the
* specified sPath
Name. A context object is returned which can be used to bind
* against the newly created object.
*
* For each created entry a request is created and stored in a request queue.
* The request queue can be submitted by calling {@link #submitChanges}. To delete a created
* entry from the request queue call {@link #deleteCreatedEntry}.
*
* The optional parameter mParameters.properties
can be used as follows:
*
* properties
could be an array containing the property names which should be included
* in the new entry. Other properties defined in the entity type won't be included.
* properties
could be an object which includes the desired properties and the
* corresponding values which should be used for the created entry.
*
* If properties
is not specified, all properties in the entity type will be included in the
* created entry.
*
* If there are no values specified, the properties will have undefined
values.
*
* Please note that deep creates (including data defined by navigation properties) are not supported.
* @param {string} sPath - Name of the path to the EntitySet
* @param {{ [key: string]: any }} mParameters - A map of the following parameters:
* @returns {sap.ui.model.Context} A Context object that points to the new created entry.
*/
public createEntry(sPath: string, mParameters: { [key: string]: any }): sap.ui.model.Context;
/**
* Creates the key from the given collection name and property map.
*
* Please make sure that the metadata document is loaded before using this function.
* @param {string} sCollection - Name of the collection
* @param {any} oKeyProperties - Object containing at least all the key properties of the entity type
* @returns {string} Key of the entry
*/
public createKey(sCollection: string, oKeyProperties: any): string;
/**
* Deletes a created entry from the request queue and from the model.
* @param {sap.ui.model.Context} oContext - The context object pointing to the created entry
*/
public deleteCreatedEntry(oContext: sap.ui.model.Context): void;
/**
*/
public destroy(): void;
/**
* Detach event-handler fnFunction
from the annotationsFailed
event of this sap.ui.model.odata.v2.ODataModel
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public detachAnnotationsFailed(fnFunction: Function, oListener: any): sap.ui.model.odata.v2.ODataModel;
/**
* Detach event-handler fnFunction
from the annotationsLoaded
event of this sap.ui.model.odata.v2.ODataModel
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public detachAnnotationsLoaded(fnFunction: Function, oListener: any): sap.ui.model.odata.v2.ODataModel;
/**
* Detach event-handler fnFunction
from the batchRequestCompleted
event of this sap.ui.model.odata.v2.ODataModel
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public detachBatchRequestCompleted(fnFunction: Function, oListener: any): sap.ui.model.odata.v2.ODataModel;
/**
* Detach event-handler fnFunction
from the batchRequestFailed
event of this sap.ui.model.odata.v2.ODataModel
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public detachBatchRequestFailed(fnFunction: Function, oListener: any): sap.ui.model.odata.v2.ODataModel;
/**
* Detach event-handler fnFunction
from the batchRequestSent
event of this sap.ui.model.odata.v2.ODataModel
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public detachBatchRequestSent(fnFunction: Function, oListener: any): sap.ui.model.odata.v2.ODataModel;
/**
* Detach event-handler fnFunction
from the metadataFailed
event of this sap.ui.model.odata.v2.ODataModel
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public detachMetadataFailed(fnFunction: Function, oListener: any): sap.ui.model.odata.v2.ODataModel;
/**
* Detach event-handler fnFunction
from the metadataLoaded
event of this sap.ui.model.odata.v2.ODataModel
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
public detachMetadataLoaded(fnFunction: Function, oListener: any): sap.ui.model.odata.v2.ODataModel;
/**
* Creates a new subclass of class sap.ui.model.odata.v2.ODataModel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event annotationsFailed
to attached listeners.
* @param {any} mArguments - The arguments to pass along with the event
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
protected fireAnnotationsFailed(mArguments?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Fire event annotationsLoaded
to attached listeners.
* @param {any} mArguments - The arguments to pass along with the event
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
protected fireAnnotationsLoaded(mArguments?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Fire event batchRequestCompleted
to attached listeners.
* @param {any} mArguments - parameters to add to the fired event
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
protected fireBatchRequestCompleted(mArguments: any): sap.ui.model.odata.v2.ODataModel;
/**
* Fire event batchRequestFailed
to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
protected fireBatchRequestFailed(mArguments: any): sap.ui.model.odata.v2.ODataModel;
/**
* Fire event batchRequestSent
to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
protected fireBatchRequestSent(mArguments?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Fire event metadataFailed
to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
protected fireMetadataFailed(mArguments?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Fire event metadataLoaded
to attached listeners.
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.odata.v2.ODataModel} this
to allow method chaining
*/
protected fireMetadataLoaded(mArguments?: any): sap.ui.model.odata.v2.ODataModel;
/**
* Force the update on the server of an entity by setting its ETag to '*'.
*
* ETag handling must be active so the force update will work.
* @param {string} sKey - The key to an Entity e.g.: Customer(4711)
*/
public forceEntityUpdate(sKey: string): void;
/**
* Returns the definition of batch groups per entity type for two-way binding changes
* @returns {{ [key: string]: any }} Definition of batch groups for two-way binding changes
*/
public getChangeBatchGroups(): { [key: string]: any };
/**
* Returns the definition of groups per entity type for two-way binding changes
* @returns {{ [key: string]: any }} mChangeGroups Definition of groups for two-way binding changes
*/
public getChangeGroups(): { [key: string]: any };
/**
* Return requested data as object if the data has already been loaded and stored in the model.
* @param {string} sPath - A string containing the path to the data object that should be returned.
* @param {any} oContext - The optional context which is used with the sPath
to retrieve the requested data.
* @param {boolean} bIncludeExpandEntries - This parameter should be set when a URI or custom parameter with a $expand
system query option was used to retrieve associated entries embedded. If set to true
then the getProperty
function returns a desired property value or entry and includes the associated expand entries (if any). If set to false
the associated/expanded entry properties are removed and not included in the desired entry as properties at all. This is useful for performing updates on the base entry only. Note: A copy, not a reference of the entry will be returned.
* @returns {any} Object containing the requested data if the path is valid.
*/
public getData(sPath: string, oContext?: any, bIncludeExpandEntries?: boolean): any;
/**
* Returns the default count mode for retrieving the count of collections
* @returns {sap.ui.model.odata.CountMode} Returns the default count mode for this model
*/
public getDefaultCountMode(): sap.ui.model.odata.CountMode;
/**
* Returns the array of batch group IDs that are set as deferred
* @returns {any[]} aGroupIds The array of deferred batch group IDs
*/
public getDeferredBatchGroups(): any[];
/**
* Returns the array of group IDs that are set as deferred.
* @returns {any[]} aGroupIds The array of deferred group IDs
*/
public getDeferredGroups(): any[];
/**
* Returns the ETag for a given binding path/context or data object.
* @param {string} sPath - The binding path
* @param {sap.ui.model.Context} oContext - The binding context
* @param {any} oEntity - The entity data
* @returns {string} The found ETag (or null
if none could be found)
*/
public getETag(sPath?: string, oContext?: sap.ui.model.Context, oEntity?: any): string;
/**
* Returns all headers and custom headers which are stored in this OData model.
* @returns {any} The header map
*/
public getHeaders(): any;
/**
* Returns the key part for the given the canonical entry URI, model context or data object or
* undefined
when the vValue
can't be interpreted.
* @param {string|any|sap.ui.model.Context} vValue - The canonical entry URI, the context or entry object
* @returns {string} Key of the entry or undefined
*/
public getKey(vValue: string|any|sap.ui.model.Context): string;
/**
* Returns a metadata object for class sap.ui.model.odata.v2.ODataModel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns an instance of an OData meta model which offers a unified access to both OData V2
* metadata and V4 annotations. It uses the existing {@link sap.ui.model.odata.ODataMetadata}
* as a foundation and merges V4 annotations from the existing
* {@link sap.ui.model.odata.v2.ODataAnnotations} directly into the corresponding model element.
*
* BEWARE: Access to this OData meta model will fail before the promise returned by
* {@link sap.ui.model.odata.ODataMetaModel#loaded loaded} has been resolved!
* @returns {sap.ui.model.odata.ODataMetaModel} The meta model for this ODataModel
*/
public getMetaModel(): sap.ui.model.odata.ODataMetaModel;
/**
* Returns the JSON object for an entity with the given sPath
and optional oContext
.
*
* With the mParameters.select
parameter it is possible to specify comma-separated property or navigation property
* names which should be included in the result object. This works like the OData $select
parameter.
* With the mParameters.expand
parameter it is possible to specify comma-separated navigation property names
* which should be included inline in the result object. This works like the OData $expand
parameter.
*
* This method will return a copy and not a reference of the entity. It does not load any data and may not return all requested
* data if it is not available/loaded. If select entries are contained in the parameters and not all selected properties are
* available, this method will return undefined
instead of incomplete data. If no select entries are defined,
* all properties available on the client will be returned.
*
* Example:
* {select: "Products/ProductName, Products", expand:"Products"}
will return no properties of the entity itself, but
* only the ProductName property of the Products navigation property. If Products/ProductName has not been loaded before, so is not
* available on the client, it will return undefined
.
* @param {string} sPath - Path referencing the object
* @param {any} oContext - Context the path should be resolved with, in case it is relative
* @param {{ [key: string]: any }} mParameters - Map of parameters
* @returns {any} The value for the given path/context or undefined
if data or entity type could not be found or was incomplete
*/
public getObject(sPath: string, oContext?: any, mParameters?: { [key: string]: any }): any;
/**
* Returns the original value for the property with the given path and context.
* The original value is the value that was last responded by the server.
* @param {string} sPath - The path/name of the property
* @param {any} oContext - The context if available to access the property value
* @returns {any} the value of the property
*/
public getOriginalProperty(sPath: string, oContext?: any): any;
/**
* Returns the changed properties of all changed entities in a map which are still pending.
* The key is the string name of the entity and the value is an object which contains the changed properties.
* @returns {{ [key: string]: any }} the pending changes in a map
*/
public getPendingChanges(): { [key: string]: any };
/**
* Returns the value for the property with the given sPath
.
*
* If the path points to a navigation property which has been loaded via $expand
then the bIncludeExpandEntries
* parameter determines if the navigation property should be included in the returned value or not.
* Please note that this currently works for 1..1 navigation properties only.
* @param {string} sPath - Path/name of the property
* @param {any} oContext - Context if available to access the property value
* @param {boolean} bIncludeExpandEntries - @deprecated Please use {@link #getObject} function with select/expand parameters instead. This parameter should be set when a URI or custom parameter with a $expand
system query option was used to retrieve associated entries embedded/inline. If true then the getProperty
function returns a desired property value/entry and includes the associated expand entries (if any). Note: A copy and not a reference of the entry will be returned.
* @returns {any} Value of the property
*/
public getProperty(sPath: string, oContext?: any, bIncludeExpandEntries?: boolean): any;
/**
* @returns {boolean} bRefreshAfterChange Whether to automatically refresh after changes
*/
public getRefreshAfterChange(): boolean;
/**
* Returns the current security token.
*
* If the token has not been requested from the server it will be requested first (synchronously).
* @returns {string} The CSRF security token
*/
public getSecurityToken(): string;
/**
* Return the annotation object. Please note that the metadata is loaded asynchronously and this function might return undefined because the
* metadata has not been loaded yet.
* In this case attach to the annotationsLoaded
event to get notified when the annotations are available and then call this function.
* @returns {any} Metadata object
*/
public getServiceAnnotations(): any;
/**
* Return the parsed XML metadata as a Javascript object.
*
* Please note that the metadata is loaded asynchronously and this function might return undefined because the
* metadata has not been loaded yet.
* In this case attach to the metadataLoaded
event to get notified when the metadata is available and then call this function.
* @returns {Object} Metadata object
*/
public getServiceMetadata(): Object;
/**
* Checks if there exist pending changes in the model created by the {@link #setProperty} method.
* @returns {boolean} Whether there are pending changes
*/
public hasPendingChanges(): boolean;
/**
* Checks if there are pending requests, either ongoing or sequential.
* @returns {boolean} Whether there are pending requests
*/
public hasPendingRequests(): boolean;
/**
* Checks whether metadata loading has failed in the past.
* @returns {boolean} Whether metadata request has failed
*/
public isMetadataLoadingFailed(): boolean;
/**
* Returns a promise for the loaded state of the metadata.
*
* The promise won't get rejected in case the metadata loading failed but is only resolved if the metadata is loaded successfully.
* If refreshMetadata
function is called after this promise is already resolved you should rely on the promise returned by
* refreshMetadata
to get information about the refreshed metadata loaded state.
* @returns {Promise} A promise on metadata loaded state
*/
public metadataLoaded(): Promise;
/**
* Trigger a GET
request to the OData service that was specified in the model constructor.
*
* The data will be stored in the model. The requested data is returned with the response.
* @param {string} sPath - A string containing the path to the data which should be retrieved. The path is concatenated to the service URL which was specified in the model constructor.
* @param {{ [key: string]: any }} mParameters - Optional parameter map containing any of the following properties:
* @returns {any} An object which has an abort
function to abort the current request.
*/
public read(sPath: string, mParameters?: { [key: string]: any }): any;
/**
* Refresh the model.
*
* This will check all bindings for updated data and update the controls if data has been changed.
* @param {boolean} bForceUpdate - Force update of controls
* @param {boolean} bRemoveData - If set to true
then the model data will be removed/cleared. Please note that the data might not be there when calling e.g. getProperty
too early before the refresh call returned.
* @param {string} sGroupId - ID of a request group; requests belonging to the same group will be bundled in one batch request
*/
public refresh(bForceUpdate?: boolean, bRemoveData?: boolean, sGroupId?: string): void;
/**
* Refreshes the metadata for this model, for example when the request for metadata has failed.
*
* Note: Do not use refreshMetadata
if the metadata is outdated or should be updated.
* This will lead to inconsistent data in the application.
*
* Returns a new promise which can be resolved or rejected depending on the metadata loading state.
* @returns {Promise} A promise on metadata loaded state or null
if metadata is not initialized or currently refreshed.
*/
public refreshMetadata(): Promise;
/**
* Refresh XSRF token by performing a GET request against the service root URL.
* @param {Function} fnSuccess - Callback function which is called when the data has been successfully retrieved.
* @param {Function} fnError - Callback function which is called when the request failed. The handler can have the parameter: oError which contains additional error information.
* @param {boolean} bAsync - Whether the request should be send asynchronously
* @returns {any} An object which has an abort
function to abort the current request.
*/
public refreshSecurityToken(fnSuccess?: Function, fnError?: Function, bAsync?: boolean): any;
/**
* Trigger a DELETE
request to the OData service that was specified in the model constructor.
* @param {string} sPath - A string containing the path to the data that should be removed. The path is concatenated to the service URL which was specified in the model constructor.
* @param {any} mParameters - Optional, can contain the following attributes:
* @returns {any} An object which has an abort
function to abort the current request.
*/
public remove(sPath: string, mParameters?: any): any;
/**
* Resets the changes that have been collected by the {@link #setProperty} method.
* @param {any[]} aPath - Array of paths that should be reset. If no array is passed, all changes will be reset.
*/
public resetChanges(aPath?: any[]): void;
/**
* Returns a promise, which will resolve with the security token as soon as it is available.
* @returns {Promise} A promise on the CSRF security token
*/
public securityTokenAvailable(): Promise;
/**
* Definition of batch groups per entity type for two-way binding changes.
* @param {{ [key: string]: any }} mGroups - A map containing the definition of batch groups for two-way binding changes. The map has the following format: { "EntityTypeName": { batchGroupId: "ID", [changeSetId: "ID",] [single: true/false,] } }
batchGroupId
: Defines the batch group for changes of the defined EntityTypeName changeSetId
: ID of a ChangeSet
which bundles the changes for the entity type. single
: Defines if every change will get an own change set (defaults to true
)
*/
public setChangeBatchGroups(mGroups: { [key: string]: any }): void;
/**
* Definition of groups per entity type for two-way binding changes.
* @param {{ [key: string]: any }} mGroups - A map containing the definition of batch groups for two-way binding changes. The map has the following format: { "EntityTypeName": { groupId: "ID", [changeSetId: "ID",] [single: true/false,] } }
groupId
: Defines the group for changes of the defined EntityTypeName changeSetId
: ID of a ChangeSet
which bundles the changes for the entity type. single
: Defines if every change will get an own change set (defaults to true
)
*/
public setChangeGroups(mGroups: { [key: string]: any }): void;
/**
* Sets the default mode how to retrieve the item count for a collection in this model.
*
* The count can be determined in the following ways
*
* - by sending a separate
$count
request
* - by adding parameter
$inlinecount=allpages
to one or all data requests
* - a combination of the previous two
* - not at all (questions about the size of the collection can't be answered then)
*
* See {@link sap.ui.model.odata.CountMode} for all enumeration values and more details.
*
* Note that a call to this method does not modify the count mode for existing list bindings,
* only bindings that are created afterwards will use the new mode when no mode is defined at their creation.
*
* If no default count mode is set for an ODataModel
(v2), the mode Request
will be used.
* @param {sap.ui.model.odata.CountMode} sCountMode - The new default count mode for this model
*/
public setDefaultCountMode(sCountMode: sap.ui.model.odata.CountMode): void;
/**
* Setting batch groups as deferred.
*
* Requests that belong to a deferred batch group have to be sent by explicitly calling {@link #submitChanges}.
* @param {any[]} aGroupIds - Array of batch group IDs that should be set as deferred
*/
public setDeferredBatchGroups(aGroupIds: any[]): void;
/**
* Setting request groups as deferred.
*
* Requests that belong to a deferred group will be sent by explicitly calling {@link #submitChanges}.
* @param {any[]} aGroupIds - Array of group IDs that should be set as deferred
*/
public setDeferredGroups(aGroupIds: any[]): void;
/**
* Set custom headers which are provided in a key/value map.
*
* These headers are used for requests against the OData backend.
* Private headers which are set in the ODataModel cannot be modified.
* These private headers are: accept, accept-language, x-csrf-token, MaxDataServiceVersion, DataServiceVersion
.
*
* To remove these custom headers simply set the mCustomHeaders
parameter to null.
* Please also note that when calling this method again all previous custom headers
* are removed unless they are specified again in the mCustomHeaders
parameter.
* @param {any} mHeaders - The header name/value map.
*/
public setHeaders(mHeaders: any): void;
/**
* Sets a new value for the given property sPath
in the model.
*
* If the changeBatchGroup
for the changed entity type is set to deferred changes could be submitted
* with {@link #submitChanges}. Otherwise the change will be submitted directly.
* @param {string} sPath - Path of the property to set
* @param {any} oValue - Value to set the property to
* @param {sap.ui.model.Context} oContext - The context which will be used to set the property
* @param {boolean} bAsyncUpdate - Whether to update other bindings dependent on this property asynchronously
* @returns {boolean} true
if the value was set correctly and false
refreshAfterChange
* parameter to the corresponding function (for example {@link #update}).
* @param {boolean} bRefreshAfterChange - Whether to automatically refresh after changes
*/
public setRefreshAfterChange(bRefreshAfterChange: boolean): void;
/**
* Enable/Disable XCSRF-Token handling.
* @param {boolean} bTokenHandling - Whether to use token handling or not
*/
public setTokenHandlingEnabled(bTokenHandling?: boolean): void;
/**
* Enable or disable batch mode for future requests.
* @param {boolean} bUseBatch - Whether the requests should be encapsulated in a batch request
*/
public setUseBatch(bUseBatch?: boolean): void;
/**
* Submits the collected changes which were collected by the {@link #setProperty} method.
*
* The update method is defined by the global defaultUpdateMethod
parameter which is
* sap.ui.model.odata.UpdateMethod.Merge
by default. In case of a sap.ui.model.odata.UpdateMethod.Merge
* request only the changed properties will be updated.
* If a URI with a $expand
query option was used then the expand entries will be removed from the collected changes.
* Changes to this entries should be done on the entry itself. So no deep updates are supported.
*
* Important: The success/error handler will only be called if batch support is enabled. If multiple batch groups are submitted the handlers will be called for every batch group.
* @param {any} mParameters - A map which contains the following parameter properties:
* @returns {any} An object which has an abort
function to abort the current request or requests
*/
public submitChanges(mParameters?: any): any;
/**
* Trigger a PUT/MERGE
request to the OData service that was specified in the model constructor.
*
* The update method used is defined by the global defaultUpdateMethod
parameter which is
* sap.ui.model.odata.UpdateMethod.Merge
by default. Please note that deep updates are not
* supported and may not work. These should be done separately and directly on the corresponding entry.
* @param {string} sPath - A string containing the path to the data that should be updated. The path is concatenated to the sServiceUrl which was specified in the model constructor.
* @param {any} oData - Data of the entry that should be updated.
* @param {{ [key: string]: any }} mParameters - Optional, can contain the following attributes:
* @returns {any} An object which has an abort
function to abort the current request.
*/
public update(sPath: string, oData: any, mParameters?: { [key: string]: any }): any;
/**
* Update all bindings.
* @param {boolean} bForceUpdate - If set to false
, an update will only be done when the value of a binding changed.
*/
public updateBindings(bForceUpdate?: boolean): void;
}
/**
* Tree binding implementation for OData models.
*
* Hierarchy Annotations
* To use the v2.ODataTreeBinding with an OData service, which exposes hierarchy annotations, please
* see the "SAP Annotations for OData Version 2.0" Specification.
* The required property annotations, as well as accepted/default values are documented in the specification.
*
* Services which include the hierarchy-node-descendant-count-for
annotation and expose the data points in a depth-first pre-order sorted manner,
* can use an optimized auto-expand feature by specifying the numberOfExpandedLevels
in the binding parameters.
* This will pre-expand the hierarchy to the given number of levels, with one single initial OData request.
*
* For services without the hierarchy-node-descendant-count-for
annotation, the numberOfExpandedLevels
property is deprecated.
*
* Navigation Properties
* Important: The use of navigation properties to build up the hierarchy structure is deprecated and it is recommended to use the hierarchy annotations mentioned above instead.
* In addition to these hierarchy annotations, the ODataTreeBinding also supports (cyclic) references between entities based on navigation properties.
* To do this you have to specify the binding parameter "navigation".
* The pattern for this is as follows: { entitySetName: "navigationPropertyName" }.
* Example: {
* "Employees": "toColleagues"
* }
*
* OperationModes
* For a full definition and explanation of all OData binding OperationModes please see {@link sap.ui.model.odata.OperationMode}.
*
* In OperationMode.Server
* Filtering on the ODataTreeBinding is only supported with application filters.
* However please be aware that this applies only to filters which do not prevent the creation of a hierarchy.
* So filtering on a property (e.g. a "Customer") is fine, as long as the application can ensure that the responses from the backend are sufficient
* to create a valid hierarchy on the client. Subsequent paging requests for sibiling and child nodes must also return responses since the filters will be sent with
* every request.
* Using Control-Filters ({@link sap.ui.model.FilterType}) via the filter() function is not supported for the OperationMode.Server.
*
* OperationMode.Client and OperationMode.Auto
* The ODataTreeBinding supports Control-Filters only in OperationModes Client
and Auto
.
*
* In these OperationModes, the filters and sorters will be applied on the client, same as for the v2.ODataListBinding.
*
* The OperationModes Client
and Auto
are only supported for services. which expose the hierarchy annotations mentioned above, but do not
* expose the hierarchy-node-descendant-count-for
annotation.
* Services with hierarchy annotations including the hierarchy-node-descendant-count-for
annotation, do NOT support the OperationModes Client and Auto.
*/
export class ODataTreeBinding extends sap.ui.model.TreeBinding {
/**
* @param {sap.ui.model.Model} oModel
* @param {string} sPath
* @param {sap.ui.model.Context} oContext
* @param {sap.ui.model.Filter[]} aApplicationFilters - predefined filter/s (can be either a filter or an array of filters). All initial filters, will be sent with every request. Filtering on the ODataTreeBinding is only supported with initial filters.
* @param {any} mParameters - Parameter Object
* @param {sap.ui.model.Sorter[]} aSorters - predefined sorter/s (can be either a sorter or an array of sorters)
*/
public constructor(oModel: sap.ui.model.Model, sPath: string, oContext: sap.ui.model.Context, aApplicationFilters?: sap.ui.model.Filter[], mParameters?: any, aSorters?: sap.ui.model.Sorter[]);
/**
* Creates a new subclass of class sap.ui.model.odata.v2.ODataTreeBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.TreeBinding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Applies the given filters to the ODataTreeBinding.
* Please note that "Control" filters are not suported for OperationMode.Server, here only "Application" filters are allowed.
* Filters given via the constructor are always Application filters and will be send with every backend-request.
* Please see the constructor documentation for more information.
*
* Since 1.34.0 complete clientside filtering is supported for OperationMode.Client and in OperationMode.Auto, in case the backend-count is lower than the threshold.
* In this case all control and application filters will be applied on the client.
* See also: {@link sap.ui.model.odata.OperationMode.Auto}, {@link sap.ui.model.FilterType}.
*
* For the OperationMode.Client and OperationMode.Auto, you may also specify the "useServersideApplicationFilters" constructor binding parameter.
* If this is set, the Application filters will always be applied on the backend, and thus trigger an OData request.
* Please see the constructor documentation for more information.
* @param {sap.ui.model.Filter[]|sap.ui.model.Filter} aFilters
* @param {sap.ui.model.FilterType} sFilterType - Type of the filter which should be adjusted, if it is not given, the standard behaviour FilterType.Client applies
*/
public filter(aFilters: sap.ui.model.Filter[]|sap.ui.model.Filter, sFilterType: sap.ui.model.FilterType): void;
/**
* Returns the number of child nodes. This function is not available when the annotation "hierarchy-node-descendant-count-for"
* is exposed on the service.
* @param {Object} oContext - the context element of the node
* @returns {number} the number of children
*/
public getChildCount(oContext: Object): number;
/**
* Get a download URL with the specified format considering the
* sort/filter/custom parameters.
* @param {string} sFormat - Value for the $format Parameter
* @returns {string} URL which can be used for downloading
*/
public getDownloadUrl(sFormat: string): string;
/**
* Returns a metadata object for class sap.ui.model.odata.v2.ODataTreeBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the contexts of the child nodes for the given context. This function is not available when the annotation "hierarchy-node-descendant-count-for"
* is exposed on the service.
* @param {sap.ui.model.Context} oContext - the context for which the child nodes should be retrieved
* @param {number} iStartIndex - the start index of the requested contexts
* @param {number} iLength - the requested amount of contexts
* @param {number} iThreshold
* @returns {any[]} the contexts array
*/
public getNodeContexts(oContext: sap.ui.model.Context, iStartIndex: number, iLength: number, iThreshold: number): any[];
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public getNodeContexts(...args: any[]): any;
/**
* Returns root contexts for the tree. You can specify the start index and the length for paging requests.
* This function is not available when the annotation "hierarchy-node-descendant-count-for" is exposed on the service.
* @param {number} iStartIndex - the start index of the requested contexts
* @param {number} iLength - the requested amount of contexts. If none given, the default value is the size limit of the underlying sap.ui.model.odata.v2.ODataModel instance.
* @param {number} iThreshold - the number of entities which should be retrieved in addition to the given length. A higher threshold reduces the number of backend requests, yet these request blow up in size, since more data is loaded.
* @returns {any[]} an array containing the contexts for the entities returned by the backend, might be fewer than requested if the backend does not have enough data.
*/
public getRootContexts(iStartIndex?: number, iLength?: number, iThreshold?: number): any[];
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public getRootContexts(...args: any[]): any;
/**
* Returns the rootLevel
* @returns {number}
*/
public getRootLevel(): number;
/**
* Returns if the node has child nodes.
* If the ODataTreeBinding is running with hierarchy annotations, a context with the property values "expanded" or "collapsed"
* for the drilldown state property, returns true. Entities with drilldown state "leaf" return false.
*
* This function is not available when the annotation "hierarchy-node-descendant-count-for" is exposed on the service.
* @param {sap.ui.model.Context} oContext - the context element of the node
* @returns {boolean} true if node has children
*/
public hasChildren(oContext: sap.ui.model.Context): boolean;
/**
* Initialize binding. Fires a change if data is already available ($expand) or a refresh.
* If metadata is not yet available, do nothing, method will be called again when
* metadata is loaded.
*/
public initialize(): void;
/**
* Refreshes the binding, check whether the model data has been changed and fire change event
* if this is the case. For server side models this should refetch the data from the server.
* To update a control, even if no data has been changed, e.g. to reset a control after failed
* validation, please use the parameter bForceUpdate.
* @param {boolean} bForceUpdate - Update the bound control even if no data has been changed
* @param {string} sGroupId - The group Id for the refresh
*/
public refresh(bForceUpdate?: boolean, sGroupId?: string): void;
/**
* Sets the rootLevel
* The root level is the level of the topmost tree nodes, which will be used as an entry point for OData services.
* This is only possible (and necessary) for OData services implementing the hierarchy annotation specification,
* or when providing the annotation information locally as a binding parameter. See the constructor for API documentation on this.
* @param {number} iRootLevel
*/
public setRootLevel(iRootLevel: number): void;
/**
* Sorts the Tree according to the given Sorter(s).
* In OperationMode.Client or OperationMode.Auto (if the given threshold is satisfied), the sorters are applied locally on the client.
* @param {sap.ui.model.Sorter[]|sap.ui.model.Sorter} aSorters - the Sorter or an Array of sap.ui.model.Sorter instances
*/
public sort(aSorters: sap.ui.model.Sorter[]|sap.ui.model.Sorter): void;
}
}
/**
* Model and related classes like bindings for OData V4.
*/
namespace v4 {
/**
* A collection of methods which help to consume
*
* OData V4 annotations in XML template views. Every context argument must belong to a
* {@link sap.ui.model.odata.v4.ODataMetaModel} instance.
*/
namespace AnnotationHelper {
/**
* Returns a data binding according to the result of {@link #getNavigationPath}.
* @param {string} sPath - The path value from the meta model, for example "ToSupplier/@com.sap.vocabularies.Communication.v1.Address" or "@com.sap.vocabularies.UI.v1.FieldGroup#Dimensions"
* @returns {string} A data binding according to the result of {@link #getNavigationPath}, for example "{ToSupplier}" or ""
*/
function getNavigationBinding(sPath: string): string;
/**
* A function that helps to interpret OData V4 annotations. It knows about the syntax
* of the path value used by the following dynamic expressions:
*
* - "14.5.2 Expression edm:AnnotationPath"
* - "14.5.11 Expression edm:NavigationPropertyPath"
* - "14.5.12 Expression edm:Path"
* - "14.5.13 Expression edm:PropertyPath"
*
* It returns the path of structural and navigation properties from the given path
* value, but removes "$count", types casts, term casts, and annotations of navigation
* properties.
* @param {string} sPath - The path value from the meta model, for example "ToSupplier/@com.sap.vocabularies.Communication.v1.Address" or "@com.sap.vocabularies.UI.v1.FieldGroup#Dimensions"
* @returns {string} The path of structural and navigation properties, for example "ToSupplier" or ""
*/
function getNavigationPath(sPath: string): string;
/**
* Determines which type of value list exists for the given property.
* @param {any} vRawValue - The raw value from the meta model; must be either a property or a path pointing to a property (relative to oDetails.schemaChildName
)
* @param {any} oDetails - The details object
* @returns {sap.ui.model.odata.v4.ValueListType} The type of the value list
*/
function getValueListType(vRawValue: any, oDetails: any): sap.ui.model.odata.v4.ValueListType;
/**
* A function that helps to interpret OData V4 annotations. It knows about the syntax
* of the path value used by the following dynamic expressions:
*
* - "14.5.2 Expression edm:AnnotationPath"
* - "14.5.11 Expression edm:NavigationPropertyPath"
* - "14.5.12 Expression edm:Path"
* - "14.5.13 Expression edm:PropertyPath"
*
* It returns the information whether the given path ends with "$count" or with a
* multi-valued structural or navigation property. Term casts and annotations of
* navigation properties are ignored.
*
* Examples:
*
* <template:if test="{facet>Target/$AnnotationPath@@sap.ui.model.odata.v4.AnnotationHelper.isMultiple}">
*
* @param {string} sPath - The path value from the meta model, for example "ToSupplier/@com.sap.vocabularies.Communication.v1.Address" or "@com.sap.vocabularies.UI.v1.FieldGroup#Dimensions"
* @param {any} oDetails - The details object
* @returns {boolean} true
if the given path ends with "$count" or with a multi-valued structural or navigation property, false
otherwise
*/
function isMultiple(sPath: string, oDetails: any): boolean;
/**
* A function that helps to interpret OData V4 annotations. It knows about
*
* - the "14.4 Constant Expressions" for "edm:Bool", "edm:Date",
* "edm:DateTimeOffset", "edm:Decimal", "edm:Float", "edm:Guid", "edm:Int",
* "edm:TimeOfDay".
*
- the constant "14.4.11 Expression edm:String": This is turned into a fixed
* text (e.g.
"Width"
). String constants that contain a simple binding
* "{@i18n>...}"
to the hard-coded model name "@i18n" with arbitrary path
* are not turned into a fixed text, but kept as a data binding expression; this
* allows local annotation files to refer to a resource bundle for
* internationalization.
* - the dynamic "14.5.1 Comparison and Logical Operators": These are turned into
* expression bindings to perform the operations at run-time.
*
- the dynamic "14.5.3 Expression edm:Apply":
*
* - "14.5.3.1.1 Function odata.concat": This is turned into a data binding
* expression.
*
- "14.5.3.1.2 Function odata.fillUriTemplate": This is turned into an
* expression binding to fill the template at run-time.
*
- "14.5.3.1.3 Function odata.uriEncode": This is turned into an expression
* binding to encode the parameter at run-time.
*
- Apply functions may be nested arbitrarily.
*
* - the dynamic "14.5.6 Expression edm:If": This is turned into an expression
* binding to be evaluated at run-time. The expression is a conditional expression
* like
"{=condition ? expression1 : expression2}"
.
* - the dynamic "14.5.10 Expression edm:Null": This is turned into a
*
null
value. In odata.concat
it is ignored.
* - the dynamic "14.5.12 Expression edm:Path" and "14.5.13 Expression
* edm:PropertyPath": This is turned into a simple data binding, e.g.
*
"{Name}"
.
*
* Unsupported or incorrect values are turned into a string nevertheless, but indicated
* as such. An error describing the problem is logged to the console in such a case.
*
* Example:
*
* <Text text="{meta>Value/@@sap.ui.model.odata.v4.AnnotationHelper.value}" />
*
* @param {any} vRawValue - The raw value from the meta model
* @param {any} oDetails - The details object
* @returns {string} A data binding or a fixed text or a sequence thereof
*/
function value(vRawValue: any, oDetails: any): string;
}
/**
* Implementation of an OData V4 model's context.
*
* The context is a pointer to model data as returned by a query from a
* {@link sap.ui.model.odata.v4.ODataContextBinding} or a
* {@link sap.ui.model.odata.v4.ODataListBinding}. Contexts are always and only
* created by such bindings. A context for a context binding points to the complete query
* result. A context for a list binding points to one specific entry in the binding's
* collection. A property binding does not have a context, you can access its value via
* {@link sap.ui.model.odata.v4.ODataPropertyBinding#getValue}.
*
* Applications can access model data only via a context, either synchronously with the risk
* that the values are not available yet ({@link #getProperty} and {@link #getObject}) or
* asynchronously ({@link #requestProperty} and {@link #requestObject}).
*
* Context instances are immutable.
*/
export class Context extends sap.ui.model.Context {
/**
* Do NOT call this private constructor. In the OData V4 model you cannot
* create contexts at will: retrieve them from a binding or a view element instead.
* @param {sap.ui.model.odata.v4.ODataModel} oModel - The model
* @param {sap.ui.model.odata.v4.ODataContextBinding|sap.ui.model.odata.v4.ODataListBinding} oBinding - A binding that belongs to the model
* @param {string} sPath - An absolute path without trailing slash
* @param {number} iIndex - Index of item (within the collection addressed by sPath
) represented by this context; used by list bindings, not context bindings
* @param {Promise} oCreatePromise - Promise returned by {@link #created}
*/
public constructor(oModel: sap.ui.model.odata.v4.ODataModel, oBinding: sap.ui.model.odata.v4.ODataContextBinding|sap.ui.model.odata.v4.ODataListBinding, sPath: string, iIndex?: number, oCreatePromise?: Promise);
/**
* Returns a promise that is resolved without data when the entity represented by this context
* has been created in the backend. As long as it is not yet resolved or rejected the entity
* represented by this context is transient.
* @returns {Promise} A promise that is resolved without data when the entity represented by this context has been created in the backend. Returns undefined
if the context has not been created using {@link sap.ui.model.odata.v4.ODataListBinding#create}.
*/
public created(): Promise;
/**
* Deletes the OData entity this context points to. The context must be part of a context
* binding with an empty path or be part of a list binding.
*
* The context must not be used anymore after successful deletion.
* @param {string} sGroupId - The group ID to be used for the DELETE request; if not specified, the update group ID for the context's binding is used, see {@link sap.ui.model.odata.v4.ODataModel#bindContext} and {@link sap.ui.model.odata.v4.ODataModel#bindList}; the resulting group ID must be '$auto' or '$direct'
* @returns {Promise} A promise which is resolved without a result in case of success, or rejected with an instance of Error
in case of failure, e.g. if the given context does not point to an entity, if it is not part of a list binding, if there are pending changes for the context's binding, if the resulting group ID is neither '$auto' nor '$direct', or if the deletion on the server fails. The error instance is flagged with isConcurrentModification
in case a concurrent modification (e.g. by another user) of the entity between loading and deletion has been detected; this should be shown to the user who needs to decide whether to try deletion again. If the entity does not exist, we assume it has already been deleted by someone else and report success.
*/
public delete(sGroupId?: string): Promise;
/**
* Destroys this context, that is, it removes this context from all dependent bindings and drops
* references to binding and model, so that the context cannot be used anymore; it keeps path
* and index for debugging purposes.
*/
public destroy(): void;
/**
* Creates a new subclass of class sap.ui.model.odata.v4.Context with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.Context.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the binding this context belongs to.
* @returns {sap.ui.model.odata.v4.ODataContextBinding|sap.ui.model.odata.v4.ODataListBinding} The context's binding
*/
public getBinding(): sap.ui.model.odata.v4.ODataContextBinding|sap.ui.model.odata.v4.ODataListBinding;
/**
* Returns the "canonical path" of the entity for this context.
* According to "4.3.1 Canonical URL" of the specification "OData Version 4.0 Part 2: URL
* Conventions", this is the "name of the entity set associated with the entity followed by the
* key predicate identifying the entity within the collection".
* Use the canonical path in {@link sap.ui.core.Element#bindElement} to create an element
* binding.
* Note: For a transient context (see {@link #isTransient}) a wrong path is returned unless all
* key properties are available within the initial data.
* @returns {string} The canonical path (e.g. "/SalesOrderList('0500000000')")
*/
public getCanonicalPath(): string;
/**
* Returns the context's index within the binding's collection. The return value changes if a
* new entity is added via {@link sap.ui.model.odata.v4.ODataListBinding#create} or deleted
* again.
* @returns {number} The context's index within the binding's collection or undefined
if the context does not belong to a list binding.
*/
public getIndex(): number;
/**
* Returns a metadata object for class sap.ui.model.odata.v4.Context.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the value for the given path relative to this context. The function allows access to
* the complete data the context points to (if sPath
is "") or any part thereof.
* The data is a JSON structure as described in
*
* "OData JSON Format Version 4.0".
* Note that the function clones the result. Modify values via
* {@link sap.ui.model.odata.v4.ODataPropertyBinding#setValue}.
*
* Returns undefined
if the data is not (yet) available. Use
* {@link #requestObject} for asynchronous access.
* @param {string} sPath - A relative path within the JSON structure
* @returns {any} The requested value
*/
public getObject(sPath?: string): any;
/**
* Returns the property value for the given path relative to this context. The path is expected
* to point to a structural property with primitive type. Returns undefined
* if the data is not (yet) available. Use {@link #requestProperty} for asynchronous access.
* @param {string} sPath - A relative path within the JSON structure
* @param {boolean} bExternalFormat - If true
, the value is returned in external format using a UI5 type for the given property path that formats corresponding to the property's EDM type and constraints. If the type is not yet available, undefined
is returned.
* @returns {any} The requested property value
*/
public getProperty(sPath: string, bExternalFormat?: boolean): any;
/**
* Returns true
if this context is transient, which means that the promise returned
* by {@link #created} is not yet resolved or rejected.
* @returns {boolean} Whether this context is transient
*/
public isTransient(): boolean;
/**
* Returns a promise for the "canonical path" of the entity for this context.
* According to "4.3.1 Canonical URL" of the specification "OData Version 4.0 Part 2: URL
* Conventions", this is the "name of the entity set associated with the entity followed by the
* key predicate identifying the entity within the collection".
* Use the canonical path in {@link sap.ui.core.Element#bindElement} to create an element
* binding.
* Note: For a transient context (see {@link #isTransient}) a wrong path is returned unless all
* key properties are available within the initial data.
* @returns {Promise} A promise which is resolved with the canonical path (e.g. "/SalesOrderList('0500000000')") in case of success, or rejected with an instance of Error
in case of failure, e.g. if the given context does not point to an entity
*/
public requestCanonicalPath(): Promise;
/**
* Returns a promise on the value for the given path relative to this context. The function
* allows access to the complete data the context points to (if sPath
is "") or
* any part thereof. The data is a JSON structure as described in
*
* "OData JSON Format Version 4.0".
* Note that the function clones the result. Modify values via
* {@link sap.ui.model.odata.v4.ODataPropertyBinding#setValue}.
*
* If you want {@link #requestObject} to read fresh data, call
* oContext.getBinding().refresh()
first.
* @param {string} sPath - A relative path within the JSON structure
* @returns {Promise} A promise on the requested value
*/
public requestObject(sPath?: string): Promise;
/**
* Returns a promise on the property value for the given path relative to this context. The path
* is expected to point to a structural property with primitive type.
* @param {string} sPath - A relative path within the JSON structure
* @param {boolean} bExternalFormat - If true
, the value is returned in external format using a UI5 type for the given property path that formats corresponding to the property's EDM type and constraints.
* @returns {Promise} A promise on the requested value; it is rejected if the value is not primitive
*/
public requestProperty(sPath?: string, bExternalFormat?: boolean): Promise;
/**
* Returns a string representation of this object including the binding path.
* @returns {string} A string description of this binding
*/
public toString(): string;
}
/**
* Context binding for an OData V4 model.
* An event handler can only be attached to this binding for the following events: 'change',
* 'dataReceived', and 'dataRequested'.
* For other events, an error is thrown.
*
* A context binding can also be used as an operation binding to support bound actions,
* action imports and function imports. If you want to control the execution time of an
* operation, for example a function import named "GetNumberOfAvailableItems", create a
* context binding for the path "/GetNumberOfAvailableItems(...)" (as specified here,
* including the three dots). Such an operation binding is deferred, meaning that it
* does not request automatically, but only when you call {@link #execute}. {@link #refresh}
* is always ignored for actions and action imports. For function imports, it is ignored if
* {@link #execute} has not yet been called. Afterwards it results in another call of the
* function with the parameter values of the last execute.
*
* The binding parameter for bound actions may be given in the binding path, for example
* "/SalesOrderList('42')/name.space.SalesOrder_Confirm". This can be
* used if the exact entity for the binding parameter is known in advance. If you use a
* relative binding instead, the operation path is a concatenation of the parent context's
* canonical path and the deferred binding's path.
*
* Example: You have a table with a list binding to "/SalesOrderList". In
* each row you have a button to confirm the sales order, with the relative binding
* "name.space.SalesOrder_Confirm(...)". Then the parent context for such a button
* refers to an entity in "SalesOrderList", so its canonical path is
* "/SalesOrderList('SalesOrderID')" and the resulting path for the action
* is "/SalesOrderList('SalesOrderID')/name.space.SalesOrder_Confirm".
*
* This also works if the relative path of the deferred operation binding starts with a
* navigation property. Then this navigation property will be part of the operation's
* resource path, which is still valid.
*
* A deferred operation binding is not allowed to have another deferred operation binding as
* parent.
*/
export class ODataContextBinding extends sap.ui.model.ContextBinding {
/**
* Do NOT call this private constructor, but rather use
* {@link sap.ui.model.odata.v4.ODataModel#bindContext} instead!
* @param {sap.ui.model.odata.v4.ODataModel} oModel - The OData V4 model
* @param {string} sPath - The binding path in the model; must not end with a slash
* @param {sap.ui.model.Context} oContext - The context which is required as base for a relative path
* @param {any} mParameters - Map of binding parameters
*/
public constructor(oModel: sap.ui.model.odata.v4.ODataModel, sPath: string, oContext?: sap.ui.model.Context, mParameters?: any);
/**
* Changes this binding's parameters and refreshes the binding.
*
* If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if
* there are pending changes. If there are changes, call
* {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit the changes or
* {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
* {@link #changeParameters}.
*
* The parameters are changed according to the given map of parameters: Parameters with an
* undefined
value are removed, the other parameters are set, and missing
* parameters remain unchanged.
* @param {any} mParameters - Map of binding parameters, see {@link sap.ui.model.odata.v4.ODataModel#bindList} and {@link sap.ui.model.odata.v4.ODataModel#bindContext}
*/
public changeParameters(mParameters: any): void;
/**
* Destroys the object. The object must not be used anymore after this function was called.
*/
public destroy(): void;
/**
* Calls the OData operation that corresponds to this operation binding.
*
* Parameters for the operation must be set via {@link #setParameter} beforehand.
*
* The value of this binding is the result of the operation. To access a result of primitive
* type, bind a control to the path "value", for example
* <Text text="{value}"/>
. If the result has a complex or entity type, you
* can bind properties as usual, for example <Text text="{street}"/>
.
* @param {string} sGroupId - The group ID to be used for the request; if not specified, the group ID for this binding is used, see {@link sap.ui.model.odata.v4.ODataContextBinding#constructor}. Valid values are undefined
, '$auto', '$direct' or application group IDs as specified in {@link sap.ui.model.odata.v4.ODataModel#submitBatch}.
* @returns {Promise} A promise that is resolved without data when the operation call succeeded, or rejected with an instance of Error
in case of failure.
*/
public execute(sGroupId?: string): Promise;
/**
* Creates a new subclass of class sap.ui.model.odata.v4.ODataContextBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.ContextBinding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the bound context.
* @returns {sap.ui.model.odata.v4.Context} The bound context
*/
public getBoundContext(): sap.ui.model.odata.v4.Context;
/**
* Returns a metadata object for class sap.ui.model.odata.v4.ODataContextBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns true
if this binding or its dependent bindings have pending changes,
* meaning updates that have not yet been successfully sent to the server.
* @returns {boolean} true
if the binding has pending changes
*/
public hasPendingChanges(): boolean;
/**
* Initializes the OData list binding. Fires a 'change' event in case the binding has a
* resolved path.
*/
protected initialize(): void;
/**
* Method not supported
* @returns {boolean}
*/
public isInitial(): boolean;
/**
* Refreshes the binding. Prompts the model to retrieve data from the server using the given
* group ID and notifies the control that new data is available.
*
* Refresh is supported for bindings which are not relative to a
* {@link sap.ui.model.odata.v4.Context}.
*
* Note: When calling {@link #refresh} multiple times, the result of the request triggered by
* the last call determines the binding's data; it is independent of the order of calls
* to {@link sap.ui.model.odata.v4.ODataModel#submitBatch} with the given group ID.
*
* If there are pending changes, an error is thrown. Use {@link #hasPendingChanges} to check if
* there are pending changes. If there are changes, call
* {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit the changes or
* {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
* {@link #refresh}.
* @param {string} sGroupId - The group ID to be used for refresh; if not specified, the group ID for this binding is used. Valid values are undefined
, '$auto', '$direct' or application group IDs as specified in {@link sap.ui.model.odata.v4.ODataModel#submitBatch}.
*/
public refresh(sGroupId?: string): void;
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public refresh(...args: any[]): any;
/**
* Resets all pending changes of this binding, see {@link #hasPendingChanges}. Resets also
* invalid user input.
*/
public resetChanges(): void;
/**
* Method not supported
*/
public resume(): void;
/**
* Sets a parameter for an operation call.
* @param {string} sParameterName - The parameter name
* @param {any} vValue - The parameter value
* @returns {sap.ui.model.odata.v4.ODataContextBinding} this
to enable method chaining
*/
public setParameter(sParameterName: string, vValue: any): sap.ui.model.odata.v4.ODataContextBinding;
/**
* Method not supported
*/
public suspend(): void;
/**
* Returns a string representation of this object including the binding path. If the binding is
* relative, the parent path is also given, separated by a '|'.
* @returns {string} A string description of this binding
*/
public toString(): string;
}
/**
* List binding for an OData V4 model.
* An event handler can only be attached to this binding for the following events: 'change',
* 'dataReceived', 'dataRequested', and 'refresh'.
* For other events, an error is thrown.
*/
export class ODataListBinding extends sap.ui.model.ListBinding {
/**
* Do NOT call this private constructor, but rather use
* {@link sap.ui.model.odata.v4.ODataModel#bindList} instead!
* @param {sap.ui.model.odata.v4.ODataModel} oModel - The OData V4 model
* @param {string} sPath - The binding path in the model; must not end with a slash
* @param {sap.ui.model.Context} oContext - The parent context which is required as base for a relative path
* @param {sap.ui.model.Sorter|sap.ui.model.Sorter[]} vSorters - The dynamic sorters to be used initially; supported since 1.39.0
* @param {sap.ui.model.Filter|sap.ui.model.Filter[]} vFilters - The dynamic application filters to be used initially; supported since 1.39.0
* @param {any} mParameters - Map of binding parameters
*/
public constructor(oModel: sap.ui.model.odata.v4.ODataModel, sPath: string, oContext?: sap.ui.model.Context, vSorters?: sap.ui.model.Sorter|sap.ui.model.Sorter[], vFilters?: sap.ui.model.Filter|sap.ui.model.Filter[], mParameters?: any);
/**
* Changes this binding's parameters and refreshes the binding.
*
* If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if
* there are pending changes. If there are changes, call
* {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit the changes or
* {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
* {@link #changeParameters}.
*
* The parameters are changed according to the given map of parameters: Parameters with an
* undefined
value are removed, the other parameters are set, and missing
* parameters remain unchanged.
* @param {any} mParameters - Map of binding parameters, see {@link sap.ui.model.odata.v4.ODataModel#bindList} and {@link sap.ui.model.odata.v4.ODataModel#bindContext}
*/
public changeParameters(mParameters: any): void;
/**
* Creates a new entity and inserts it at the beginning of the list. As long as the binding
* contains an entity created via this function, you cannot create another entity. This is only
* possible after the creation of the entity has been successfully sent to the server and you
* have called {@link #refresh} at the (parent) binding, which is absolute or not relative to a
* {@link sap.ui.model.odata.v4.Context}, or the new entity is deleted in between.
*
* For creating the new entity, the binding's update group ID is used, see binding parameter
* $$updateGroupId of {@link sap.ui.model.odata.v4.ODataModel#bindList}.
*
* You can call {@link sap.ui.model.odata.v4.Context#delete} to delete the created context
* again. As long as the context is transient (see
* {@link sap.ui.model.odata.v4.Context#isTransient}), {@link #resetChanges} and a call to
* {@link sap.ui.model.odata.v4.ODataModel#resetChanges} with the update group ID as parameter
* also delete the created context together with other changes.
*
* If the creation of the entity on the server failed, the creation is repeated for application
* group IDs with the next call of {@link sap.ui.model.odata.v4.ODataModel#submitBatch}. For
* '$auto' or '$direct', the creation is repeated automatically with the next update for the
* entity.
* @param {any} oInitialData - The initial data for the created entity
* @returns {sap.ui.model.odata.v4.Context} The context object for the created entity
*/
public create(oInitialData?: any): sap.ui.model.odata.v4.Context;
/**
* Destroys the object. The object must not be used anymore after this function was called.
*/
public destroy(): void;
/**
* Creates a new subclass of class sap.ui.model.odata.v4.ODataListBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.ListBinding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Filters the list with the given filters.
*
* If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if
* there are pending changes. If there are changes, call
* {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit the changes or
* {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
* {@link #filter}.
* @param {sap.ui.model.Filter|sap.ui.model.Filter[]} vFilters - The dynamic filters to be used; replaces the dynamic filters given in {@link sap.ui.model.odata.v4.ODataModel#bindList}. The filter executed on the list is created from the following parts, which are combined with a logical 'and': - Dynamic filters of type {@link sap.ui.model.FilterType.Application}
- Dynamic filters of type {@link sap.ui.model.FilterType.Control}
- The static filters, as defined in the '$filter' binding parameter
* @param {sap.ui.model.FilterType} sFilterType - The filter type to be used
* @returns {sap.ui.model.odata.v4.ODataListBinding} this
to facilitate method chaining
*/
public filter(vFilters?: sap.ui.model.Filter|sap.ui.model.Filter[], sFilterType?: sap.ui.model.FilterType): sap.ui.model.odata.v4.ODataListBinding;
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public filter(...args: any[]): any;
/**
* Returns already created binding contexts for all entities in this list binding for the range
* determined by the given start index iStart
and iLength
.
* If at least one of the entities in the given range has not yet been loaded, fires a
* {@link #event:change} event on this list binding once these entities have been loaded
* asynchronously. A further call to this method in the 'change' event handler with the
* same index range then yields the updated array of contexts.
* @param {number} iStart - The index where to start the retrieval of contexts
* @param {number} iLength - The number of contexts to retrieve beginning from the start index; defaults to the model's size limit, see {@link sap.ui.model.Model#setSizeLimit}
* @param {number} iMaximumPrefetchSize - The maximum number of contexts to read before and after the given range; with this, controls can prefetch data that is likely to be needed soon, e.g. when scrolling down in a table. Negative values will be treated as 0. Supported since 1.39.0
* @returns {sap.ui.model.Context[]} The array of already created contexts with the first entry containing the context for iStart
*/
protected getContexts(iStart?: number, iLength?: number, iMaximumPrefetchSize?: number): sap.ui.model.Context[];
/**
* Returns the contexts that were requested by a control last time. Does not trigger a data
* request. In the time between the {@link #event:dataRequested} event and the
* {@link #event:dataReceived} event, the resulting array contains undefined
at
* those indexes where the data is not yet available.
* @returns {sap.ui.model.Context[]} The contexts
*/
public getCurrentContexts(): sap.ui.model.Context[];
/**
* Method not supported
* @returns {any[]}
*/
public getDistinctValues(): any[];
/**
* Returns the header context which allows binding to $count
. If known, the value
* of such a binding is the element count of the collection on the server. Otherwise it is
* undefined
. The value is a number and its type is Edm.Int64
.
*
* The count is known to the binding in the following situations:
*
* - It has been requested from the server via the system query option
$count
.
* - A "short read" in a paged collection (the server delivered less elements than
* requested) indicated that the server has no more unread elements.
*
- It has been read completely in one request, for example an embedded collection via
*
$expand
.
*
*
* The $count
is unknown, if the binding is relative, but has no context.
* @returns {sap.ui.model.odata.v4.Context} The header context or null
if the binding is relative and has no context
*/
public getHeaderContext(): sap.ui.model.odata.v4.Context;
/**
* Returns the number of entries in the list. As long as the client does not know the size on
* the server an estimated length is returned.
* @returns {number} The number of entries in the list
*/
public getLength(): number;
/**
* Returns a metadata object for class sap.ui.model.odata.v4.ODataListBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns true
if this binding or its dependent bindings have pending changes,
* meaning updates that have not yet been successfully sent to the server.
* @returns {boolean} true
if the binding has pending changes
*/
public hasPendingChanges(): boolean;
/**
* Initializes the OData list binding. Fires a 'change' event in case the binding has a
* resolved path.
*/
protected initialize(): void;
/**
* Method not supported
* @returns {boolean}
*/
public isInitial(): boolean;
/**
* Returns true
if the length has been determined by the data returned from
* server. If the length is a client side estimation false
is returned.
* @returns {boolean} If true the length is determined by server side data
*/
public isLengthFinal(): boolean;
/**
* Refreshes the binding. Prompts the model to retrieve data from the server using the given
* group ID and notifies the control that new data is available.
*
* Refresh is supported for bindings which are not relative to a
* {@link sap.ui.model.odata.v4.Context}.
*
* Note: When calling {@link #refresh} multiple times, the result of the request triggered by
* the last call determines the binding's data; it is independent of the order of calls
* to {@link sap.ui.model.odata.v4.ODataModel#submitBatch} with the given group ID.
*
* If there are pending changes, an error is thrown. Use {@link #hasPendingChanges} to check if
* there are pending changes. If there are changes, call
* {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit the changes or
* {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
* {@link #refresh}.
* @param {string} sGroupId - The group ID to be used for refresh; if not specified, the group ID for this binding is used. Valid values are undefined
, '$auto', '$direct' or application group IDs as specified in {@link sap.ui.model.odata.v4.ODataModel#submitBatch}.
*/
public refresh(sGroupId?: string): void;
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public refresh(...args: any[]): any;
/**
* Resets all pending changes of this binding, see {@link #hasPendingChanges}. Resets also
* invalid user input.
*/
public resetChanges(): void;
/**
* Method not supported
*/
public resume(): void;
/**
* Sort the entries represented by this list binding according to the given sorters.
* The sorters are stored at this list binding and they are used for each following data
* request.
*
* If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if
* there are pending changes. If there are changes, call
* {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit the changes or
* {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
* {@link #sort}.
* @param {sap.ui.model.Sorter|sap.ui.model.Sorter[]} vSorters - The dynamic sorters to be used; they replace the dynamic sorters given in {@link sap.ui.model.odata.v4.ODataModel#bindList}. Static sorters, as defined in the '$orderby' binding parameter, are always executed after the dynamic sorters.
* @returns {sap.ui.model.odata.v4.ODataListBinding} this
to facilitate method chaining
*/
public sort(vSorters?: sap.ui.model.Sorter|sap.ui.model.Sorter[]): sap.ui.model.odata.v4.ODataListBinding;
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public sort(...args: any[]): any;
/**
* Method not supported
*/
public suspend(): void;
/**
* Returns a string representation of this object including the binding path. If the binding is
* relative, the parent path is also given, separated by a '|'.
* @returns {string} A string description of this binding
*/
public toString(): string;
}
/**
* Implementation of an OData metadata model which offers access to OData V4 metadata.
* The meta model does not support any public events; attaching an event handler leads to an
* error.
*
* This model is read-only.
*/
export class ODataMetaModel extends sap.ui.model.MetaModel {
/**
* Do NOT call this private constructor, but rather use
* {@link sap.ui.model.odata.v4.ODataModel#getMetaModel} instead.
* @param {any} oRequestor - The metadata requestor
* @param {string} sUrl - The URL to the $metadata document of the service
* @param {sap.ui.model.odata.v4.ODataModel} oModel - The model this meta model is related to
* @param {boolean} bSupportReferences - Whether <edmx:Reference>
and <edmx:Include>
directives are supported in order to load schemas on demand from other $metadata documents and include them into the current service ("cross-service references").
*/
public constructor(oRequestor: any, sUrl: string, oModel: sap.ui.model.odata.v4.ODataModel, bSupportReferences?: boolean);
/**
* Do NOT call this private constructor, but rather use
* {@link sap.ui.model.odata.v4.ODataModel#getMetaModel} instead.
* @param {any} oRequestor - The metadata requestor
* @param {string} sUrl - The URL to the $metadata document of the service
* @param {string|string[]} vAnnotationUri - The URL (or an array of URLs) from which the annotation metadata are loaded Supported since 1.41.0
* @param {sap.ui.model.odata.v4.ODataModel} oModel - The model this meta model is related to
* @param {boolean} bSupportReferences - Whether <edmx:Reference>
and <edmx:Include>
directives are supported in order to load schemas on demand from other $metadata documents and include them into the current service ("cross-service references").
*/
public constructor(oRequestor: any, sUrl: string, vAnnotationUri: string|string[], oModel: sap.ui.model.odata.v4.ODataModel, bSupportReferences?: boolean);
/**
* Creates a list binding for this metadata model which iterates content from the given path
* (relative to the given context), sorted and filtered as indicated.
*
* By default, OData names are iterated and a trailing slash is implicitly added to the path
* (see {@link #requestObject} for the effects this has); technical properties and inline
* annotations are filtered out.
*
* A path which ends with an "@" segment can be used to iterate all inline or external
* targeting annotations; no trailing slash is added implicitly; technical properties and OData
* names are filtered out.
* @param {string} sPath - A relative or absolute path within the metadata model, for example "/EMPLOYEES"
* @param {sap.ui.model.Context} oContext - The context to be used as a starting point in case of a relative path
* @param {sap.ui.model.Sorter|sap.ui.model.Sorter[]} aSorters - Initial sort order, see {@link sap.ui.model.ListBinding#sort}
* @param {sap.ui.model.Filter|sap.ui.model.Filter[]} aFilters - Initial application filter(s), see {@link sap.ui.model.ListBinding#filter}
* @returns {sap.ui.model.ListBinding} A list binding for this metadata model
*/
public bindList(sPath: string, oContext?: sap.ui.model.Context, aSorters?: sap.ui.model.Sorter|sap.ui.model.Sorter[], aFilters?: sap.ui.model.Filter|sap.ui.model.Filter[]): sap.ui.model.ListBinding;
/**
* Creates a property binding for this meta data model which refers to the content from the
* given path (relative to the given context).
* @param {string} sPath - A relative or absolute path within the meta data model, for example "/EMPLOYEES/ENTRYDATE"
* @param {sap.ui.model.Context} oContext - The context to be used as a starting point in case of a relative path
* @param {any} mParameters - Optional binding parameters that are passed to {@link #getObject} to compute the binding's value; if they are given, oContext
cannot be omitted
* @returns {sap.ui.model.PropertyBinding} A property binding for this meta data model
*/
public bindProperty(sPath: string, oContext?: sap.ui.model.Context, mParameters?: any): sap.ui.model.PropertyBinding;
/**
* Method not supported
* @returns {sap.ui.model.TreeBinding}
*/
public bindTree(): sap.ui.model.TreeBinding;
/**
* Creates a new subclass of class sap.ui.model.odata.v4.ODataMetaModel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.MetaModel.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the maximum value of all "Last-Modified" response headers seen so far.
* @returns {Date} The maximum value of all "Last-Modified" (or, as a fallback, "Date") response headers seen so far when loading $metadata or annotation files. It is new Date(0)
initially as long as no such files have been loaded. It becomes new Date()
as soon as a file without such a header is loaded. Note that this value may change due to load-on-demand of "cross-service references" (see parameter "bSupportReferences" of {@link sap.ui.model.odata.v4.ODataMetaModel}).
*/
public getLastModified(): Date;
/**
* Returns the OData metadata model context corresponding to the given OData data model path.
* @param {string} sPath - An absolute data path within the OData data model, for example "/EMPLOYEES/0/ENTRYDATE"
* @returns {sap.ui.model.Context} The corresponding metadata context within the OData metadata model, for example with metadata path "/EMPLOYEES/ENTRYDATE"
*/
public getMetaContext(sPath: string): sap.ui.model.Context;
/**
* Returns a metadata object for class sap.ui.model.odata.v4.ODataMetaModel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the metadata object for the given path relative to the given context. Returns
* undefined
in case the metadata is not (yet) available. Use
* {@link #requestObject} for asynchronous access.
* @param {string} sPath - A relative or absolute path within the metadata model
* @param {sap.ui.model.Context} oContext - The context to be used as a starting point in case of a relative path
* @param {any} mParameters - Optional (binding) parameters; if they are given, oContext
cannot be omitted
* @returns {any} The requested metadata object if it is already available, or undefined
*/
public getObject(sPath: string, oContext?: sap.ui.model.Context, mParameters?: any): any;
/**
* Method not supported
* @returns {any}
*/
public getOriginalProperty(): any;
/**
* @returns {any}
*/
public getProperty(): any;
/**
* Returns the UI5 type for the given property path that formats and parses corresponding to
* the property's EDM type and constraints. The property's type must be a primitive type. Use
* {@link #requestUI5Type} for asynchronous access.
* @param {string} sPath - An absolute path to an OData property within the OData data model
* @returns {sap.ui.model.odata.type.ODataType} The corresponding UI5 type from {@link sap.ui.model.odata.type}, if all required metadata to calculate this type is already available; if no specific type can be determined, a warning is logged and {@link sap.ui.model.odata.type.Raw} is used
*/
public getUI5Type(sPath: string): sap.ui.model.odata.type.ODataType;
/**
* Determines which type of value list exists for the given property.
* @param {string} sPropertyPath - An absolute path to an OData property within the OData data model
* @returns {sap.ui.model.odata.v4.ValueListType} The type of the value list
*/
public getValueListType(sPropertyPath: string): sap.ui.model.odata.v4.ValueListType;
/**
* Method not supported
*/
public refresh(): void;
/**
* Requests the metadata value for the given path relative to the given context. Returns a
* Promise
which is resolved with the requested metadata value or rejected with
* an error (only in case metadata cannot be loaded). An invalid path leads to an
* undefined
result and a warning is logged. Use {@link #getObject} for
* synchronous access.
*
* A relative path is appended to the context's path separated by a forward slash("/").
* A relative path starting with "@" (that is, an annotation) is appended without a separator.
* Use "./" as a prefix for such a relative path to enforce a separator.
*
* Example:
*
* <template:with path="/EMPLOYEES/ENTRYDATE" var="property">
* <!-- /EMPLOYEES/ENTRYDATE/$Type -->
* "{property>$Type}"
*
* <!-- /EMPLOYEES/ENTRYDATE@com.sap.vocabularies.Common.v1.Text -->
* "{property>@com.sap.vocabularies.Common.v1.Text}"
*
* <!-- /EMPLOYEES/ENTRYDATE/@com.sap.vocabularies.Common.v1.Text -->
* "{property>./@com.sap.vocabularies.Common.v1.Text}"
* </template:with>
*
*
* The basic idea is that every path described in "14.2.1 Attribute Target" in specification
* "OData Version 4.0 Part 3: Common Schema Definition Language" is a valid absolute path
* within the metadata model if a leading slash is added; for example
* "/" + "MySchema.MyEntityContainer/MyEntitySet/MyComplexProperty/MyNavigationProperty". Also,
* every path described in "14.5.2 Expression edm:AnnotationPath",
* "14.5.11 Expression edm:NavigationPropertyPath", "14.5.12 Expression edm:Path", and
* "14.5.13 Expression edm:PropertyPath" is a valid relative path within the metadata model
* if a suitable prefix is added which addresses an entity container, entity set, singleton,
* complex type, entity type, or property; for example
* "/MySchema.MyEntityType/MyProperty" + "@vCard.Address#work/FullName".
*
* The absolute path is split into segments and followed step-by-step, starting at the global
* scope of all known qualified OData names. There are two technical properties there:
* "$Version" (typically "4.0") and "$EntityContainer" with the name of the single entity
* container for this metadata model's service.
*
* An empty segment in between is invalid. An empty segment at the end caused by a trailing
* slash differentiates between a name and the object it refers to. This way,
* "/$EntityContainer" refers to the name of the single entity container and
* "/$EntityContainer/" refers to the single entity container as an object.
*
* The segment "@sapui.name" refers back to the last OData name (simple identifier or qualified
* name) or annotation name encountered during path traversal immediately before "@sapui.name":
*
* - "/EMPLOYEES@sapui.name" results in "EMPLOYEES" and "/EMPLOYEES/@sapui.name"
* results in the same as "/EMPLOYEES/$Type", that is, the qualified name of the entity set's
* type (see below how "$Type" is inserted implicitly). Note how the separating slash again
* makes a difference here.
*
- "/EMPLOYEES/@com.sap.vocabularies.Common.v1.Label@sapui.name" results in
* "@com.sap.vocabularies.Common.v1.Label" and a slash does not make any difference as long as
* the annotation does not have a "$Type" property.
*
- A technical property (that is, a numerical segment or one starting with a "$")
* immediately before "@sapui.name" is invalid, for example "/$EntityContainer@sapui.name".
*
* The path must not continue after "@sapui.name".
*
* If the current object is a string value, that string value is treated as a relative path and
* followed step-by-step before the next segment is processed. Except for this, a path must
* not continue if it comes across a non-object value. Such a string value can be a qualified
* name (example path "/$EntityContainer/..."), a simple identifier (example path
* "/TEAMS/$NavigationPropertyBinding/TEAM_2_EMPLOYEES/...") or even a path according to
* "14.5.12 Expression edm:Path" etc. (example path
* "/TEAMS/$Type/@com.sap.vocabularies.UI.v1.LineItem/0/Value/$Path/...").
*
* Segments starting with an "@" character, for example "@com.sap.vocabularies.Common.v1.Label",
* address annotations at the current object. As the first segment, they refer to the single
* entity container. For objects which can only be annotated inline (see "14.3 Element
* edm:Annotation" minus "14.2.1 Attribute Target"), the object already contains the
* annotations as a property. For objects which can (only or also) be annotated via external
* targeting, the object does not contain any annotation as a property. Such annotations MUST
* be accessed via a path. BEWARE of a special case: Actions, functions and their parameters
* can be annotated inline for a single overload or via external targeting for all overloads at
* the same time. In this case, the object contains all annotations for the single overload as
* a property, but annotations MUST nevertheless be accessed via a path in order to include
* also annotations for all overloads at the same time.
*
* Segments starting with an OData name followed by an "@" character, for example
* "/TEAMS@Org.OData.Capabilities.V1.TopSupported", address annotations at an entity set,
* singleton, or property, not at the corresponding type. In contrast,
* "/TEAMS/@com.sap.vocabularies.Common.v1.Deletable" (note the separating slash) addresses an
* annotation at the entity set's type. This is in line with the special rule of
* "14.5.12 Expression edm:Path" regarding annotations at a navigation property itself.
*
* "@" can be used as a segment to address a map of all annotations of the current object. This
* is useful for iteration, for example via
* <template:repeat list="{entityType>@}" ...>
.
*
* Annotations of an annotation are addressed not by two separate segments, but by a single
* segment like
* "@com.sap.vocabularies.Common.v1.Text@com.sap.vocabularies.Common.v1.TextArrangement". Each
* annotation can have a qualifier, for example "@first#foo@second#bar". Note: If the first
* annotation's value is a record, a separate segment addresses an annotation of that record,
* not an annotation of the first annotation itself.
* In a similar way, annotations of "7.2 Element edm:ReferentialConstraint",
* "7.3 Element edm:OnDelete", "10.2 Element edm:Member" and
* "14.5.14.2 Element edm:PropertyValue" are addressed by segments like
* "<7.2.1 Attribute Property>@...", "$OnDelete@...", "<10.2.1 Attribute Name>@..." and
* "<14.5.14.2.1 Attribute Property>@..." (where angle brackets denote a variable part and
* sections refer to specification "OData Version 4.0 Part 3: Common Schema Definition
* Language").
*
* Annotations starting with "@@", for example
* "@@sap.ui.model.odata.v4.AnnotationHelper.isMultiple" or "@@.AH.isMultiple" or
* "@@.isMultiple", represent computed annotations. Their name without the "@@" prefix must
* refer to a function either in the global namespace (in case of an absolute name) or in
* mParameters.scope
(in case of a relative name starting with a dot, which is
* stripped before lookup; see the <template:alias>
instruction for XML
* Templating). This function is called with the current object (or primitive value) and
* additional details and returns the result of this {@link #requestObject} call. The additional
* details are given as an object with the following properties:
*
* {@link sap.ui.model.Context} context
Points to the current object
* {string} schemaChildName
The qualified name of the schema child where the
* computed annotation has been found
*
* Computed annotations cannot be iterated by "@". The path must not continue after a computed
* annotation.
*
* A segment which represents an OData qualified name is looked up in the global scope ("scope
* lookup") and thus determines a schema child which is used later on. Unknown qualified names
* are invalid. This way, "/acme.DefaultContainer/EMPLOYEES" addresses the "EMPLOYEES" child of
* the schema child named "acme.DefaultContainer". This also works indirectly
* ("/$EntityContainer/EMPLOYEES") and implicitly ("/EMPLOYEES", see below).
*
* A segment which represents an OData simple identifier needs special preparations. The same
* applies to the empty segment after a trailing slash.
*
* - If the current object has a "$Action", "$Function" or "$Type" property, it is used for
* scope lookup first. This way, "/EMPLOYEES/ENTRYDATE" addresses the same object as
* "/EMPLOYEES/$Type/ENTRYDATE", namely the "ENTRYDATE" child of the entity type
* corresponding to the "EMPLOYEES" child of the entity container. The other cases jump from
* an action or function import to the corresponding action or function overloads.
*
- Else if the segment is the first one within its path, the last schema child addressed
* via scope lookup is used instead of the current object. This can only happen indirectly as
* in "/TEAMS/$NavigationPropertyBinding/TEAM_2_EMPLOYEES/..." where the schema child is the
* entity container and the navigation property binding can contain the simple identifier of
* another entity set within the same container.
*
* If the segment is the first one overall, "$EntityContainer" is inserted into the path
* implicitly. In other words, the entity container is used as the initial schema child.
* This way, "/EMPLOYEES" addresses the same object as "/$EntityContainer/EMPLOYEES", namely
* the "EMPLOYEES" child of the entity container.
*
- Afterwards, if the current object is an array, it represents overloads for an action or
* function. Multiple overloads are invalid. The overload's "$ReturnType/$Type" is used for
* scope lookup. This way, "/GetOldestWorker/AGE" addresses the same object as
* "/GetOldestWorker/0/$ReturnType/$Type/AGE". For primitive return types, the special
* segment "value" can be used to refer to the return type itself (see
* {@link sap.ui.model.odata.v4.ODataContextBinding#execute}). This way,
* "/GetOldestAge/value" addresses the same object as "/GetOldestAge/0/$ReturnType" (which
* is needed for automatic type determination, see {@link #requestUI5Type}).
*
*
* A trailing slash can be used to continue a path and thus force scope lookup or OData simple
* identifier preparations, but then stay at the current object. This way, "/EMPLOYEES/$Type/"
* addresses the entity type itself corresponding to the "EMPLOYEES" child of the entity
* container. Although the empty segment is not an OData simple identifier, it can be used as a
* placeholder for one. In this way, "/EMPLOYEES/" addresses the same entity type as
* "/EMPLOYEES/$Type/". That entity type in turn is a map of all its OData children (that is,
* structural and navigation properties) and determines the set of possible child names that
* might be used after the trailing slash.
*
* Any other segment, including an OData simple identifier, is looked up as a property of the
* current object.
* @param {string} sPath - A relative or absolute path within the metadata model
* @param {sap.ui.model.Context} oContext - The context to be used as a starting point in case of a relative path
* @param {any} mParameters - Optional (binding) parameters; if they are given, oContext
cannot be omitted
* @returns {Promise} A promise which is resolved with the requested metadata value as soon as it is available
*/
public requestObject(sPath: string, oContext?: sap.ui.model.Context, mParameters?: any): Promise;
/**
* Requests the UI5 type for the given property path that formats and parses corresponding to
* the property's EDM type and constraints. The property's type must be a primitive type. Use
* {@link #getUI5Type} for synchronous access.
* @param {string} sPath - An absolute path to an OData property within the OData data model
* @returns {Promise} A promise that gets resolved with the corresponding UI5 type from {@link sap.ui.model.odata.type} or rejected with an error; if no specific type can be determined, a warning is logged and {@link sap.ui.model.odata.type.Raw} is used
*/
public requestUI5Type(sPath: string): Promise;
/**
* Requests information to retrieve a value list for the property given by
* sPropertyPath
.
* @param {string} sPropertyPath - An absolute path to an OData property within the OData data model
* @returns {Promise} A promise which is resolved with a map of qualifier to value list mapping objects structured as defined by com.sap.vocabularies.Common.v1.ValueListMappingType
; the map entry with key "" represents the mapping without qualifier. Each entry has an additional property "$model" which is the {@link sap.ui.model.odata.v4.ODataModel} instance to read value list data via this mapping. For fixed values, only one mapping is expected and the qualifier is ignored. The mapping is available with key "". The promise is rejected with an error if there is no value list information available for the given property path. Use {@link #getValueListType} to determine if value list information exists. It is also rejected with an error if the value list metadata is inconsistent. An inconsistency can result from one of the following reasons: - There is a reference, but the referenced service does not contain mappings for the property.
- The referenced service contains annotation targets in the namespace of the data service that are not mappings for the property.
- Two different referenced services contain a mapping using the same qualifier.
- A service is referenced twice.
- No mappings have been found.
- There are multiple mappings for a fixed value list.
*/
public requestValueListInfo(sPropertyPath: string): Promise;
/**
* Determines which type of value list exists for the given property.
* @param {string} sPropertyPath - An absolute path to an OData property within the OData data model
* @returns {Promise} A promise that is resolved with the type of the value list, a constant of the enumeration {@link sap.ui.model.odata.v4.ValueListType}. The promise is rejected if the property cannot be found in the metadata.
*/
public requestValueListType(sPropertyPath: string): Promise;
/**
* Method not supported
*/
public setLegacySyntax(): void;
/**
* Returns a string representation of this object including the URL to the $metadata document of
* the service.
* @returns {string} A string description of this model
*/
public toString(): string;
}
/**
* Model implementation for OData V4.
*
* Every resource path (relative to the service root URL, no query options) according to
* "4 Resource Path" in specification "OData Version 4.0 Part 2: URL Conventions" is
* a valid data binding path within this model if a leading slash is added; for example
* "/" + "SalesOrderList('A%2FB%26C')" to access an entity instance with key "A/B&C". Note
* that appropriate URI encoding is necessary. "4.5.1 Addressing Actions" needs an operation
* binding, see {@link sap.ui.model.odata.v4.ODataContextBinding}.
*
* Note that the OData V4 model has its own {@link sap.ui.model.odata.v4.Context} class.
* Bindings which are relative to such a V4 context depend on their corresponding parent
* binding and do not access data with their own service requests unless parameters are
* provided.
*
* The model does not support any public events; attaching an event handler leads to an error.
*/
export class ODataModel extends sap.ui.model.Model {
/**
* Constructor for a new ODataModel.
* @param {any} mParameters - The parameters
*/
public constructor(mParameters: any);
/**
* Creates a new context binding for the given path, context and parameters.
*
* This binding is inactive and will not know the bound context initially. You have to call
* {@link sap.ui.model.Binding#initialize} to get it updated asynchronously and register a
* change listener at the binding to be informed when the bound context is available.
* @param {string} sPath - The binding path in the model; must not end with a slash
* @param {sap.ui.model.odata.v4.Context} oContext - The context which is required as base for a relative path
* @param {any} mParameters - Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2: URL Conventions" or the binding-specific parameters "$$groupId" and "$$updateGroupId". Note: The binding creates its own data service request if it is absolute or if it has any parameters or if it is relative and has a context created via {@link ODataModel#createBindingContext}. The following OData query options are allowed: - All "5.2 Custom Query Options" except for those with a name starting with "sap-"
- The $count, $expand, $filter, $levels, $orderby, $search and $select "5.1 System Query Options"; OData V4 only allows $count, $filter, $levels, $orderby and $search inside resource paths that identify a collection. In our case here, this means you can only use them inside $expand.
All other query options lead to an error. Query options specified for the binding overwrite model query options.
* @returns {sap.ui.model.odata.v4.ODataContextBinding} The context binding
*/
public bindContext(sPath: string, oContext?: sap.ui.model.odata.v4.Context, mParameters?: any): sap.ui.model.odata.v4.ODataContextBinding;
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public bindContext(...args: any[]): any;
/**
* Creates a new list binding for the given path and optional context which must
* resolve to an absolute OData path for an entity set.
* @param {string} sPath - The binding path in the model; must not be empty or end with a slash
* @param {sap.ui.model.Context} oContext - The context which is required as base for a relative path
* @param {sap.ui.model.Sorter|sap.ui.model.Sorter[]} vSorters - The dynamic sorters to be used initially. Call {@link sap.ui.model.odata.v4.ODataListBinding#sort} to replace them. Static sorters, as defined in the '$orderby' binding parameter, are always executed after the dynamic sorters. Supported since 1.39.0.
* @param {sap.ui.model.Filter|sap.ui.model.Filter[]} vFilters - The dynamic application filters to be used initially. Call {@link sap.ui.model.odata.v4.ODataListBinding#filter} to replace them. Static filters, as defined in the '$filter' binding parameter, are always combined with the dynamic filters using a logical AND
. Supported since 1.39.0.
* @param {any} mParameters - Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2: URL Conventions" or the binding-specific parameters "$$groupId" and "$$updateGroupId". Note: The binding creates its own data service request if it is absolute or if it has any parameters or if it is relative and has a context created via {@link ODataModel#createBindingContext} or if it has sorters or filters. The following OData query options are allowed: - All "5.2 Custom Query Options" except for those with a name starting with "sap-"
- The $apply, $count, $expand, $filter, $levels, $orderby, $search, and $select "5.1 System Query Options"
All other query options lead to an error. Query options specified for the binding overwrite model query options.
* @returns {sap.ui.model.odata.v4.ODataListBinding} The list binding
*/
public bindList(sPath: string, oContext?: sap.ui.model.Context, vSorters?: sap.ui.model.Sorter|sap.ui.model.Sorter[], vFilters?: sap.ui.model.Filter|sap.ui.model.Filter[], mParameters?: any): sap.ui.model.odata.v4.ODataListBinding;
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public bindList(...args: any[]): any;
/**
* Creates a new property binding for the given path. This binding is inactive and will not
* know the property value initially. You have to call {@link sap.ui.model.Binding#initialize}
* to get it updated asynchronously and register a change listener at the binding to be informed
* when the value is available.
* @param {string} sPath - The binding path in the model; must not be empty or end with a slash
* @param {sap.ui.model.Context} oContext - The context which is required as base for a relative path
* @param {any} mParameters - Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2: URL Conventions" or the binding-specific parameter "$$groupId". Note: The binding creates its own data service request if it is absolute or if it has any parameters or if it is relative and has a context created via {@link ODataModel#createBindingContext}. All "5.2 Custom Query Options" are allowed except for those with a name starting with "sap-". All other query options lead to an error. Query options specified for the binding overwrite model query options.
* @returns {sap.ui.model.odata.v4.ODataPropertyBinding} The property binding
*/
public bindProperty(sPath: string, oContext?: sap.ui.model.Context, mParameters?: any): sap.ui.model.odata.v4.ODataPropertyBinding;
/**
* Method not supported
* @returns {sap.ui.model.TreeBinding}
*/
public bindTree(): sap.ui.model.TreeBinding;
/**
* Creates a binding context for the given path. A relative path can only be resolved if a
* context is provided.
* Note: The parameters mParameters
, fnCallBack
, and
* bReload
from {@link sap.ui.model.Model#createBindingContext} are not supported.
*
* It is possible to create binding contexts pointing to metadata. A '#' in the resolved path
* splits it into two parts: The part before '#' is transformed into a metadata context (see
* {@link sap.ui.model.odata.v4.ODataMetaModel#getMetaContext}). The part following '#' is then
* interpreted relative to this metadata context, even if it starts with a '/'; a trailing '/'
* is allowed here, see {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject} for the
* effect it has.
*
* Examples:
*
* /Products('42')/Name#@com.sap.vocabularies.Common.v1.Label
* points to the "Label" annotation of the "Name" property of the entity set "Products".
* /#Products/Name@com.sap.vocabularies.Common.v1.Label
has no data path part
* and thus starts at the metadata root. It also points to the "Label" annotation of the
* "Name" property of the entity set "Products".
* /Products#/
* points to the entity type (note the trailing '/') of the entity set "Products".
*
* @param {string} sPath - The binding path, may be relative to the provided context
* @param {sap.ui.model.Context} oContext - The context which is required as base for a relative path
* @returns {sap.ui.model.Context} The binding context with the resolved path and the model instance
*/
public createBindingContext(sPath: string, oContext?: sap.ui.model.Context): sap.ui.model.Context;
/**
* Destroys this model and its meta model.
*/
public destroy(): void;
/**
* Method not supported
*/
public destroyBindingContext(): void;
/**
* Creates a new subclass of class sap.ui.model.odata.v4.ODataModel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the model's group ID.
* @returns {string} The group ID
*/
public getGroupId(): string;
/**
* Returns a metadata object for class sap.ui.model.odata.v4.ODataModel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the meta model for this ODataModel.
* @returns {sap.ui.model.odata.v4.ODataMetaModel} The meta model for this ODataModel
*/
public getMetaModel(): sap.ui.model.odata.v4.ODataMetaModel;
/**
* Method not supported
* @returns {any}
*/
public getObject(): any;
/**
* Method not supported
* @returns {any}
*/
public getOriginalProperty(): any;
/**
* Method not supported
* @returns {any}
*/
public getProperty(): any;
/**
* Returns the model's update group ID.
* @returns {string} The update group ID
*/
public getUpdateGroupId(): string;
/**
* Returns true
if there are pending changes, meaning updates or created entities
* (see {@link sap.ui.model.odata.v4.ODataListBinding#create}) that have not yet been
* successfully sent to the server.
* @returns {boolean} true
if there are pending changes
*/
public hasPendingChanges(): boolean;
/**
* Refreshes the model by calling refresh on all bindings which have a change event handler
* attached.
*
* Note: When calling {@link #refresh} multiple times, the result of the request triggered by
* the last call determines the model's data; it is independent of the order of calls to
* {@link #submitBatch} with the given group ID.
*
* If there are pending changes, an error is thrown. Use {@link #hasPendingChanges} to check if
* there are pending changes. If there are changes, call {@link #submitBatch} to submit the
* changes or {@link #resetChanges} to reset the changes before calling {@link #refresh}.
* @param {string} sGroupId - The group ID to be used for refresh; valid values are undefined
, '$auto', '$direct' or application group IDs as specified in {@link #submitBatch}
*/
public refresh(sGroupId?: string): void;
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public refresh(...args: any[]): any;
/**
* Returns a promise for the "canonical path" of the entity for the given context.
* According to "4.3.1 Canonical URL" of the specification "OData Version 4.0 Part 2: URL
* Conventions", this is the "name of the entity set associated with the entity followed by the
* key predicate identifying the entity within the collection".
* Use the canonical path in {@link sap.ui.core.Element#bindElement} to create an element
* binding.
* @param {sap.ui.model.odata.v4.Context} oEntityContext - A context in this model which must point to a non-contained OData entity
* @returns {Promise} A promise which is resolved with the canonical path (e.g. "/SalesOrderList('0500000000')") in case of success, or rejected with an instance of Error
in case of failure, e.g. when the given context does not point to an entity
*/
public requestCanonicalPath(oEntityContext: sap.ui.model.odata.v4.Context): Promise;
/**
* Resets all property changes and created entities associated with the given group ID which
* have not been successfully submitted via {@link #submitBatch}. Resets also invalid user
* input for the same group ID. This function does not reset the deletion of entities
* (see {@link sap.ui.model.odata.v4.Context#delete}) and the execution of OData operations
* (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}).
* @param {string} sGroupId - The application group ID, which is a non-empty string consisting of alphanumeric characters from the basic Latin alphabet, including the underscore. If it is undefined
, the model's updateGroupId
is used. Note that the default updateGroupId
is '$auto', which is invalid here.
*/
public resetChanges(sGroupId?: string): void;
/**
* Method not supported
*/
public setLegacySyntax(): void;
/**
* Submits the requests associated with the given application group ID in one batch request.
* @param {string} sGroupId - The application group ID, which is a non-empty string consisting of alphanumeric characters from the basic Latin alphabet, including the underscore.
* @returns {Promise} A promise on the outcome of the HTTP request resolving with undefined
; it is rejected with an error if the batch request itself fails
*/
public submitBatch(sGroupId: string): Promise;
/**
* Returns a string representation of this object including the service URL.
* @returns {string} A string description of this model
*/
public toString(): string;
}
/**
* Property binding for an OData V4 model.
* An event handler can only be attached to this binding for the following events: 'change',
* 'dataReceived', and 'dataRequested'.
* For unsupported events, an error is thrown.
*/
export class ODataPropertyBinding extends sap.ui.model.PropertyBinding {
/**
* Do NOT call this private constructor, but rather use
* {@link sap.ui.model.odata.v4.ODataModel#bindProperty} instead!
* @param {sap.ui.model.odata.v4.ODataModel} oModel - The OData V4 model
* @param {string} sPath - The binding path in the model; must not end with a slash
* @param {sap.ui.model.Context} oContext - The context which is required as base for a relative path
* @param {any} mParameters - Map of binding parameters
*/
public constructor(oModel: sap.ui.model.odata.v4.ODataModel, sPath: string, oContext?: sap.ui.model.Context, mParameters?: any);
/**
* Destroys the object. The object must not be used anymore after this function was called.
*/
public destroy(): void;
/**
* Creates a new subclass of class sap.ui.model.odata.v4.ODataPropertyBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.PropertyBinding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.odata.v4.ODataPropertyBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the current value.
* @returns {any} The current value
*/
public getValue(): any;
/**
* Determines which type of value list exists for this property.
* @returns {sap.ui.model.odata.v4.ValueListType} The value list type
*/
public getValueListType(): sap.ui.model.odata.v4.ValueListType;
/**
* Returns true
if this binding or its dependent bindings have pending changes,
* meaning updates that have not yet been successfully sent to the server.
* @returns {boolean} true
if the binding has pending changes
*/
public hasPendingChanges(): boolean;
/**
* Method not supported
* @returns {boolean}
*/
public isInitial(): boolean;
/**
* Refreshes the binding. Prompts the model to retrieve data from the server using the given
* group ID and notifies the control that new data is available.
*
* Refresh is supported for bindings which are not relative to a
* {@link sap.ui.model.odata.v4.Context}.
*
* Note: When calling {@link #refresh} multiple times, the result of the request triggered by
* the last call determines the binding's data; it is independent of the order of calls
* to {@link sap.ui.model.odata.v4.ODataModel#submitBatch} with the given group ID.
*
* If there are pending changes, an error is thrown. Use {@link #hasPendingChanges} to check if
* there are pending changes. If there are changes, call
* {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit the changes or
* {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
* {@link #refresh}.
* @param {string} sGroupId - The group ID to be used for refresh; if not specified, the group ID for this binding is used. Valid values are undefined
, '$auto', '$direct' or application group IDs as specified in {@link sap.ui.model.odata.v4.ODataModel#submitBatch}.
*/
public refresh(sGroupId?: string): void;
/**
* This method overload is here just for compatibility reasons to avoid compiler errors,
* because UI5 API doesn't follow all TypeScript method override rules.
* Don't use it. If the definitions are wrong, please open an issue in https://github.com/lmcarreiro/ui5ts/issues instead.
* @param {any[]} args
* @returns {any}
*/
public refresh(...args: any[]): any;
/**
* Requests information to retrieve a value list for this property.
* @returns {Promise} A promise which is resolved with a map of qualifier to value list mapping objects structured as defined by com.sap.vocabularies.Common.v1.ValueListMappingType
; the map entry with key "" represents the mapping without qualifier. Each entry has an additional property "$model" which is the {@link sap.ui.model.odata.v4.ODataModel} instance to read value list data via this mapping. For fixed values, only one mapping is expected and the qualifier is ignored. The mapping is available with key "". The promise is rejected with an error if there is no value list information available for this property. Use {@link #getValueListType} to determine if value list information exists. It is also rejected with an error if the value list metadata is inconsistent. An inconsistency can result from one of the following reasons: - There is a reference, but the referenced service does not contain mappings for the property.
- The referenced service contains annotation targets in the namespace of the data service that are not mappings for the property.
- Two different referenced services contain a mapping using the same qualifier.
- A service is referenced twice.
- No mappings have been found.
*/
public requestValueListInfo(): Promise;
/**
* Determines which type of value list exists for this property.
* @returns {Promise} A promise that is resolved with the type of the value list. It is rejected if the property cannot be found in the metadata.
*/
public requestValueListType(): Promise;
/**
* Resets all pending changes of this binding, see {@link #hasPendingChanges}. Resets also
* invalid user input.
*/
public resetChanges(): void;
/**
* Method not supported
*/
public resume(): void;
/**
* Sets the optional type and internal type for this binding; used for formatting and parsing.
* Fires a change event if the type has changed.
* @param {sap.ui.model.Type} oType - The type for this binding
* @param {string} sInternalType - The internal type of the element property which owns this binding, for example "any", "boolean", "float", "int", "string"; see {@link sap.ui.model.odata.type} for more information
*/
public setType(oType: sap.ui.model.Type, sInternalType: string): void;
/**
* Sets the new current value and updates the cache.
* @param {any} vValue - The new value which must be primitive
* @param {string} sGroupId - The group ID to be used for this update call; if not specified, the update group ID for this binding (or its relevant parent binding) is used, see {@link sap.ui.model.odata.v4.ODataPropertyBinding#constructor}. Valid values are undefined
, '$auto', '$direct' or application group IDs as specified in {@link sap.ui.model.odata.v4.ODataModel#submitBatch}.
*/
public setValue(vValue: any, sGroupId?: string): void;
/**
* Method not supported
*/
public suspend(): void;
/**
* Returns a string representation of this object including the binding path. If the binding is
* relative, the parent path is also given, separated by a '|'.
* @returns {string} A string description of this binding
*/
public toString(): string;
}
/**
* A collection of methods which help to consume OData V4 services.
*/
namespace ODataUtils {
/**
* Compares the given OData values.
* @param {any} vValue1 - The first value to compare
* @param {any} vValue2 - The second value to compare
* @param {boolean|string} vEdmType - If true
or "Decimal", the string values vValue1
and vValue2
are assumed to be valid "Edm.Decimal" or "Edm.Int64" values and are compared as a decimal number (only sign, integer and fraction digits; no exponential format). If "DateTime", the string values vValue1
and vValue2
are assumed to be valid "Edm.DateTimeOffset" values and are compared based on the corresponding number of milliseconds since 1 January, 1970 UTC. Otherwise the values are compared with the JavaScript operators ===
and >
.
* @returns {number} The result of the comparison: 0
if the values are equal, 1
if the first value is larger, -1
if the second value is larger, NaN
if they cannot be compared
*/
function compare(vValue1: any, vValue2: any, vEdmType?: boolean|string): number;
/**
* Parses an "Edm.Date" value and returns the corresponding JavaScript Date
* value (UTC with a time value of "00:00:00").
* @param {string} sDate - The "Edm.Date" value to parse
* @returns {Date} The JavaScript Date
value
*/
function parseDate(sDate: string): Date;
/**
* Parses an "Edm.DateTimeOffset" value and returns the corresponding JavaScript
* Date
value.
* @param {string} sDateTimeOffset - The "Edm.DateTimeOffset" value to parse
* @returns {Date} The JavaScript Date
value
*/
function parseDateTimeOffset(sDateTimeOffset: string): Date;
/**
* Parses an "Edm.TimeOfDay" value and returns the corresponding JavaScript
* Date
value (UTC with a date value of "1970-01-01").
* @param {string} sTimeOfDay - The "Edm.TimeOfDay" value to parse
* @returns {Date} The JavaScript Date
value
*/
function parseTimeOfDay(sTimeOfDay: string): Date;
}
/**
* Specifies the value list type of a property.
*/
export enum ValueListType {
/**
* There is one enumeration of fixed values.
*/
Fixed = "Fixed",
/**
* There is no value list.
*/
None = "None",
/**
* There is a dynamic value list with multiple queries including selection criteria.
*/
Standard = "Standard",
}
}
}
/**
* The PropertyBinding is used to access single data values in the data model.
*/
export class PropertyBinding extends sap.ui.model.Binding {
/**
* Constructor for PropertyBinding
* @param {sap.ui.model.Model} oModel
* @param {string} sPath
* @param {sap.ui.model.Context} oContext
* @param {any} mParameters
*/
public constructor(oModel: sap.ui.model.Model, sPath: string, oContext: sap.ui.model.Context, mParameters?: any);
/**
* Creates a new subclass of class sap.ui.model.PropertyBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.Binding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns the binding mode
* @returns {sap.ui.model.BindingMode} the binding mode
*/
public getBindingMode(): sap.ui.model.BindingMode;
/**
* Returns the current external value of the bound target which is formatted via a type or formatter function.
* @returns {any} the current value of the bound target
*/
public getExternalValue(): any;
/**
* Returns the formatter function
* @returns {Function} the formatter function
*/
public getFormatter(): Function;
/**
* Returns a metadata object for class sap.ui.model.PropertyBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the type if any for the binding.
* @returns {sap.ui.model.Type} the binding type
*/
public getType(): sap.ui.model.Type;
/**
* Returns the current value of the bound target
* @returns {any} the current value of the bound target
*/
public getValue(): any;
/**
* Resumes the binding update. Change events will be fired again.
*
* When the binding is resumed and the control value was changed in the meantime, the control value will be set to the
* current value from the model and a change event will be fired.
*/
public resume(): void;
/**
* Sets the binding mode
* @param {sap.ui.model.BindingMode} sBindingMode - the binding mode
*/
protected setBindingMode(sBindingMode: sap.ui.model.BindingMode): void;
/**
* Sets the value for this binding. The value is parsed and validated against its type and then set to the binding.
* A model implementation should check if the current default binding mode permits
* setting the binding value and if so set the new value also in the model.
* @param {any} oValue - the value to set for this binding
*/
public setExternalValue(oValue: any): void;
/**
* Sets the optional formatter function for the binding.
* @param {Function} fnFormatter - the formatter function for the binding
*/
public setFormatter(fnFormatter: Function): void;
/**
* Sets the optional type and internal type for the binding. The type and internal type are used to do the parsing/formatting correctly.
* The internal type is the property type of the element which the value is formatted to.
* @param {sap.ui.model.Type} oType - the type for the binding
* @param {string} sInternalType - the internal type of the element property which this binding is bound against.
*/
public setType(oType: sap.ui.model.Type, sInternalType: string): void;
/**
* Sets the value for this binding. A model implementation should check if the current default binding mode permits
* setting the binding value and if so set the new value also in the model.
* @param {any} oValue - the value to set for this binding
*/
public setValue(oValue: any): void;
}
/**
* ResourceBundle-based DataBinding
*/
namespace resource {
/**
* Model implementation for resource bundles
*/
export class ResourceModel extends sap.ui.model.Model {
/**
* Constructor for a new ResourceModel.
* @param {any} oData - parameters used to initialize the ResourceModel; at least either bundleUrl or bundleName must be set on this object; if both are set, bundleName wins
*/
public constructor(oData: any);
/**
* Enhances the resource model with a custom resource bundle. The resource model
* can be enhanced with multiple resource bundles. The last enhanced resource
* bundle wins against the previous ones and the original ones. This function
* can be called several times.
* @param {any|typeof jQuery.sap.util.ResourceBundle} oData - parameters used to initialize the ResourceModel; at least either bundleUrl or bundleName must be set on this object; if both are set, bundleName wins - or an instance of an existing {@link jQuery.sap.util.ResourceBundle}
* @returns {Promise} Promise in async case (async ResourceModel) which is resolved when the the enhancement is finished
*/
public enhance(oData: any|typeof jQuery.sap.util.ResourceBundle): Promise;
/**
* Creates a new subclass of class sap.ui.model.resource.ResourceModel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.resource.ResourceModel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the value for the property with the given sPropertyName
* @param {string} sPath - the path to the property
* @returns {string} the value of the property
*/
public getProperty(sPath: string): string;
/**
* Returns the resource bundle of this model
* @returns {typeof jQuery.sap.util.ResourceBundle|Promise} loaded resource bundle or ECMA Script 6 Promise in asynchronous case
*/
public getResourceBundle(): typeof jQuery.sap.util.ResourceBundle|Promise;
}
}
/**
*/
export class SelectionModel extends sap.ui.base.EventProvider {
/**
* SelectionMode: Multi Selection
*/
public static MULTI_SELECTION: any;
/**
* SelectionMode: Single Selection
*/
public static SINGLE_SELECTION: any;
/**
* Constructs an instance of an sap.ui.model.SelectionModel.
* @param {number} iSelectionMode - sap.ui.model.SelectionModel.SINGLE_SELECTION
or sap.ui.model.SelectionModel.MULTI_SELECTION
*/
public constructor(iSelectionMode: number);
/**
* Changes the selection to be the union of the current selection
* and the range between iFromIndex
and iToIndex
inclusive.
* If iFromIndex
is smaller than iToIndex
, both parameters are swapped.
*
* In SINGLE_SELECTION
selection mode, this is equivalent
* to calling setSelectionInterval
, and only the second index
* is used.
*
* If this call results in a change to the current selection or lead selection, then a
* SelectionChanged
event is fired.
* @param {number} iFromIndex - one end of the interval.
* @param {number} iToIndex - other end of the interval
* @returns {sap.ui.model.SelectionModel} this
to allow method chaining
*/
public addSelectionInterval(iFromIndex: number, iToIndex: number): sap.ui.model.SelectionModel;
/**
* Attach event-handler fnFunction
to the 'selectionChanged' event of this sap.ui.model.SelectionModel
.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.model.SelectionModel} this
to allow method chaining
*/
public attachSelectionChanged(fnFunction: Function, oListener?: any): sap.ui.model.SelectionModel;
/**
* Attach event-handler fnFunction
to the 'selectionChanged' event of this sap.ui.model.SelectionModel
.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.model.SelectionModel} this
to allow method chaining
*/
public attachSelectionChanged(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.SelectionModel;
/**
* Change the selection to the empty set and clears the lead selection.
*
* If this call results in a change to the current selection or lead selection, then a
* SelectionChanged
event is fired.
* @returns {sap.ui.model.SelectionModel} this
to allow method chaining
*/
public clearSelection(): sap.ui.model.SelectionModel;
/**
* Detach event-handler fnFunction
from the 'selectionChanged' event of this sap.ui.model.SelectionModel
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.SelectionModel} this
to allow method chaining
*/
public detachSelectionChanged(fnFunction: Function, oListener: any): sap.ui.model.SelectionModel;
/**
* Creates a new subclass of class sap.ui.model.SelectionModel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fire event 'selectionChanged' to attached listeners.
*
* Expects following event parameters:
*
* - 'leadIndex' of type
int
Lead selection index.
* - 'rowIndices' of type
int[]
Other selected indices (if available)
*
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.SelectionModel} this
to allow method chaining
*/
protected fireSelectionChanged(mArguments: any): sap.ui.model.SelectionModel;
/**
* Return the second index argument from the most recent call to
* setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().
* @returns {number} lead selected index
*/
public getLeadSelectedIndex(): number;
/**
* Returns a metadata object for class sap.ui.model.SelectionModel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the selected indices as array.
* @returns {number[]} array of selected indices
*/
public getSelectedIndices(): number[];
/**
* Returns the current selection mode.
* @returns {number} the current selection mode
*/
public getSelectionMode(): number;
/**
* Returns true if the specified index is selected.
* @param {number} iIndex
* @returns {boolean} true if the specified index is selected.
*/
public isSelectedIndex(iIndex: number): boolean;
/**
* Moves all selected indices starting at the position iStartIndex
iMove
* items.
*
* This can be used if new items are inserted to the item set and you want to keep the selection.
* To handle a deletion of items use sliceSelectionInterval
.
*
* If this call results in a change to the current selection or lead selection, then a
* SelectionChanged
event is fired.
* @param {number} iStartIndex - start at this position
* @param {number} iMove
* @returns {sap.ui.model.SelectionModel} this
to allow method chaining
*/
public moveSelectionInterval(iStartIndex: number, iMove: number): sap.ui.model.SelectionModel;
/**
* Changes the selection to be the set difference of the current selection
* and the indices between iFromIndex
and iToIndex
inclusive.
* If iFromIndex
is smaller than iToIndex
, both parameters are swapped.
*
* If the range of removed selection indices includes the current lead selection,
* then the lead selection will be unset (set to -1).
*
* If this call results in a change to the current selection or lead selection, then a
* SelectionChanged
event is fired.
* @param {number} iFromIndex - one end of the interval.
* @param {number} iToIndex - other end of the interval
* @returns {sap.ui.model.SelectionModel} this
to allow method chaining
*/
public removeSelectionInterval(iFromIndex: number, iToIndex: number): sap.ui.model.SelectionModel;
/**
* Selects all rows up to the iToIndex.
*
* If this call results in a change to the current selection, then a
* SelectionChanged
event is fired.
* @param {number} iToIndex - end of the interval
* @returns {sap.ui.model.SelectionModel} this
to allow method chaining
*/
public selectAll(iToIndex: number): sap.ui.model.SelectionModel;
/**
* Changes the selection to be equal to the range iFromIndex
and iToIndex
* inclusive. If iFromIndex
is smaller than iToIndex
, both parameters are swapped.
*
* In SINGLE_SELECTION
selection mode, only iToIndex is used.
*
* If this call results in a change to the current selection, then a
* SelectionChanged
event is fired.
* @param {number} iFromIndex - one end of the interval.
* @param {number} iToIndex - other end of the interval
* @returns {sap.ui.model.SelectionModel} this
to allow method chaining
*/
public setSelectionInterval(iFromIndex: number, iToIndex: number): sap.ui.model.SelectionModel;
/**
* Sets the selection mode. The following list describes the accepted
* selection modes:
*
* sap.ui.model.SelectionModel.SINGLE_SELECTION
-
* Only one list index can be selected at a time. In this mode,
* setSelectionInterval
and addSelectionInterval
are
* equivalent, both replacing the current selection with the index
* represented by the second argument (the "lead").
* sap.ui.model.SelectionModel.MULTI_SELECTION
-
* In this mode, there's no restriction on what can be selected.
*
* @param {number} iSelectionMode - selection mode
*/
public setSelectionMode(iSelectionMode: number): void;
/**
* Slices a the indices between the two indices from the selection.
* If iFromIndex
is smaller than iToIndex
, both parameters are swapped.
*
* If the range of removed selection indices includes the current lead selection,
* then the lead selection will be unset (set to -1).
*
* If this call results in a change to the current selection or lead selection, then a
* SelectionChanged
event is fired.
* @param {number} iFromIndex - one end of the interval.
* @param {number} iToIndex - other end of the interval
* @returns {sap.ui.model.SelectionModel} this
to allow method chaining
*/
public sliceSelectionInterval(iFromIndex: number, iToIndex: number): sap.ui.model.SelectionModel;
}
/**
* This is an abstract base class for simple types.
*/
export class SimpleType extends sap.ui.model.Type {
/**
* Constructor for a new SimpleType.
* @param {any} oFormatOptions - options as provided by concrete subclasses
* @param {any} oConstraints - constraints as supported by concrete subclasses
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.SimpleType with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.Type.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Format the given value in model representation to an output value in the given
* internal type. This happens according to the format options, if target type is 'string'.
* If oValue is not defined or null, null will be returned.
* @param {any} oValue - the value to be formatted
* @param {string} sInternalType - the target type
* @returns {any} the formatted output value
*/
public formatValue(oValue: any, sInternalType: string): any;
/**
* Returns a metadata object for class sap.ui.model.SimpleType.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Parse a value of an internal type to the expected value of the model type.
* @param {any} oValue - the value to be parsed
* @param {string} sInternalType - the source type
* @returns {any} the parse result
*/
public parseValue(oValue: any, sInternalType: string): any;
/**
* Validate whether a given value in model representation is valid and meets the
* defined constraints (if any).
* @param {any} oValue - the value to be validated
*/
public validateValue(oValue: any): void;
}
/**
* Sorter for the list binding
* This object defines the sort order for the list binding.
*/
export class Sorter extends sap.ui.base.Object {
/**
* Constructor for Sorter
* @param {string} sPath - the binding path used for sorting
* @param {boolean} bDescending - whether the sort order should be descending
* @param {boolean|Function} vGroup - configure grouping of the content, can either be true to enable grouping based on the raw model property value, or a function which calculates the group value out of the context (e.g. oContext.getProperty("date").getYear() for year grouping). The control needs to implement the grouping behaviour for the aggregation which you want to group. In case a function is provided it must either return a primitive type value as the group key or an object containing a "key" property and additional properties needed for group visualization.
* @param {Function} fnComparator - a custom comparator function, which is used for clientside sorting instead of the default comparator method.
*/
public constructor(sPath: string, bDescending?: boolean, vGroup?: boolean|Function, fnComparator?: Function);
/**
* Compares two values
*
* This is the default comparator function used for clientside sorting, if no custom comparator is given in the
* constructor. It does compare just by using equal/less than/greater than with automatic type casting, except
* for null values, which are always last, and string values where localeCompare is used.
*
* The comparator method returns -1, 0 or 1, depending on the order of the two items and is
* suitable to be used as a comparator method for Array.sort.
* @param {any} a - the first value to compare
* @param {any} b - the second value to compare
* @returns {number} -1, 0 or 1 depending on the compare result
*/
public static defaultComparator(a: any, b: any): number;
/**
* Creates a new subclass of class sap.ui.model.Sorter with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a group object, at least containing a key property for group detection.
* May contain additional properties as provided by a custom group function.
* @param {sap.ui.model.Context} oContext - the binding context
* @returns {any} An object containing a key property and optional custom properties
*/
public getGroup(oContext: sap.ui.model.Context): any;
/**
* Returns the group function of this Sorter. If grouping is not enabled on this Sorter, it will return
* undefined, if no explicit group function has been defined the default group function is returned.
* The returned function is bound to its Sorter, so it will group according to its own property path,
* even if it is used in the context of another Sorter.
* @returns {Function} The group function
*/
public getGroupFunction(): Function;
/**
* Returns a metadata object for class sap.ui.model.Sorter.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Different modes for setting the auto expand mode on tree or analytical bindings.
*/
export enum TreeAutoExpandMode {
/**
* If supported by a backend provider with analytical capabilities, the requests needed for an automatic
* node expansion are bundled.
*/
Bundled = "Bundled",
/**
* Tree nodes will be expanded in sequence, level by level (Single requests are sent).
*/
Sequential = "Sequential",
}
/**
* The TreeBinding is a specific binding for trees in the model, which can be used
* to populate Trees.
*/
export class TreeBinding extends sap.ui.model.Binding {
/**
* Constructor for TreeBinding
* @param {sap.ui.model.Model} oModel
* @param {string} sPath - the path pointing to the tree / array that should be bound
* @param {any} oContext - the context object for this databinding (optional)
* @param {any[]} aFilters - predefined filter/s contained in an array (optional)
* @param {any} mParameters - additional model specific parameters (optional)
* @param {any[]} aSorters - predefined sap.ui.model.sorter/s contained in an array (optional)
*/
public constructor(oModel: sap.ui.model.Model, sPath: string, oContext?: any, aFilters?: any[], mParameters?: any, aSorters?: any[]);
/**
* Attach event-handler fnFunction
to the '_filter' event of this sap.ui.model.TreeBinding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected attachFilter(fnFunction: Function, oListener?: any): void;
/**
* Detach event-handler fnFunction
from the '_filter' event of this sap.ui.model.TreeBinding
.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - object on which to call the given function.
*/
protected detachFilter(fnFunction: Function, oListener?: any): void;
/**
* Creates a new subclass of class sap.ui.model.TreeBinding with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.Binding.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Filters the tree according to the filter definitions.
* @param {sap.ui.model.Filter[]} aFilters - Array of sap.ui.model.Filter objects
* @param {sap.ui.model.FilterType} sFilterType - Type of the filter which should be adjusted, if it is not given, the standard behaviour applies
*/
public filter(aFilters: sap.ui.model.Filter[], sFilterType: sap.ui.model.FilterType): void;
/**
* Returns the number of child nodes of a specific context
* @param {Object} oContext - the context element of the node
* @returns {number} the number of children
*/
public getChildCount(oContext: Object): number;
/**
* Returns a metadata object for class sap.ui.model.TreeBinding.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the current value of the bound target
* @param {Object} oContext - the context element of the node
* @param {number} iStartIndex - the startIndex where to start the retrieval of contexts
* @param {number} iLength - determines how many contexts to retrieve beginning from the start index.
* @returns {any[]} the array of child contexts for the given node
*/
public getNodeContexts(oContext: Object, iStartIndex: number, iLength: number): any[];
/**
* Returns the current value of the bound target
* @param {number} iStartIndex - the startIndex where to start the retrieval of contexts
* @param {number} iLength - determines how many contexts to retrieve beginning from the start index.
* @returns {any[]} the array of child contexts for the root node
*/
public getRootContexts(iStartIndex: number, iLength: number): any[];
/**
* Returns if the node has child nodes
* @param {Object} oContext - the context element of the node
* @returns {boolean} true if node has children
*/
public hasChildren(oContext: Object): boolean;
/**
* Sorts the tree according to the sorter definitions.
* @param {sap.ui.model.Sorter[]} aSorters - Array of sap.ui.model.Sorter objects
*/
public sort(aSorters: sap.ui.model.Sorter[]): void;
}
/**
*/
export class TreeBindingAdapter {
/**
* Adapter for TreeBindings to add the ListBinding functionality and use the
* tree structure in list based controls.
*/
protected constructor();
/**
* Calculate the request length based on the given information
* @param {number} iMaxGroupSize - the maximum group size
* @param {any} oSection - the information of the current section
*/
protected _calculateRequestLength(iMaxGroupSize: number, oSection: any): void;
/**
* Attach event-handler fnFunction
to the 'selectionChanged' event of this sap.ui.model.SelectionModel
.
* Event is fired if the selection of tree nodes is changed in any way.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.model.SelectionModel} this
to allow method chaining
*/
public attachSelectionChanged(fnFunction: Function, oListener?: any): sap.ui.model.SelectionModel;
/**
* Attach event-handler fnFunction
to the 'selectionChanged' event of this sap.ui.model.SelectionModel
.
* Event is fired if the selection of tree nodes is changed in any way.
* @param {any} oData - The object, that should be passed along with the event-object when firing the event.
* @param {Function} fnFunction - The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
* @param {any} oListener - Object on which to call the given function. If empty, this Model is used.
* @returns {sap.ui.model.SelectionModel} this
to allow method chaining
*/
public attachSelectionChanged(oData: any, fnFunction: Function, oListener?: any): sap.ui.model.SelectionModel;
/**
* Detach event-handler fnFunction
from the 'selectionChanged' event of this sap.ui.model.SelectionModel
.
*
* The passed function and listener object must match the ones previously used for event registration.
* @param {Function} fnFunction - The function to call, when the event occurs.
* @param {any} oListener - Object on which the given function had to be called.
* @returns {sap.ui.model.SelectionModel} this
to allow method chaining
*/
public detachSelectionChanged(fnFunction: Function, oListener: any): sap.ui.model.SelectionModel;
/**
* Fire event 'selectionChanged' to attached listeners.
*
* Expects following event parameters:
*
* - 'leadIndex' of type
int
Lead selection index.
* - 'rowIndices' of type
int[]
Other selected indices (if available)
*
* @param {any} mArguments - the arguments to pass along with the event.
* @returns {sap.ui.model.SelectionModel} this
to allow method chaining
*/
protected fireSelectionChanged(mArguments: any): sap.ui.model.SelectionModel;
/**
* Retrieves the requested part from the tree and returns node objects.
* @param {any} iStartIndex
* @param {any} iLength
* @param {any} iThreshold
* @returns {Object} Tree Node
*/
protected getNodes(iStartIndex: any, iLength: any, iThreshold: any): Object;
}
/**
*/
export class TreeBindingCompatibilityAdapter {
/**
* Adapter for TreeBindings to add the ListBinding functionality and use the
* tree structure in list based controls.
*
* This module is only for experimental and internal use!
*/
protected constructor();
}
/**
*/
namespace TreeBindingUtils {
/**
* Merges together oNewSection into a set of other sections (aSections)
* The array/objects are not modified, the function returns a new section array.
* @param {any[]} aSections - the sections into which oNewSection will be merged
* @param {any} oNewSection - the section which should be merged into aNewSections
* @returns {any[]} a new array containing all sections from aSections merged with oNewSection
*/
function mergeSections(aSections: any[], oNewSection: any): any[];
}
/**
* This is an abstract base class for type objects.
*/
export class Type extends sap.ui.base.Object {
/**
* Constructor for a new Type.
*/
public constructor();
/**
* Creates a new subclass of class sap.ui.model.Type with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.Type.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the name of this type.
* @returns {string} the name of this type
*/
public getName(): string;
}
/**
*/
namespace type {
/**
* This class represents boolean simple types.
*/
export class Boolean extends sap.ui.model.SimpleType {
/**
* Constructor for a Boolean type.
* @param {any} oFormatOptions - formatting options. Boolean doesn't support any specific format options
* @param {any} oConstraints - value constraints. Boolean doesn't support additional constraints
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.type.Boolean with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.SimpleType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.type.Boolean.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* This class represents the currency composite type.
*/
export class Currency extends sap.ui.model.CompositeType {
/**
* Constructor for a Currency type.
* @param {any} oFormatOptions - Formatting options. For a list of all available options, see {@link sap.ui.core.format.NumberFormat#constructor NumberFormat}.
* @param {any} oConstraints - Value constraints
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.type.Currency with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.CompositeType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Format the given array containing amount and currency code to an output value of type string.
* Other internal types than 'string' are not supported by the Currency type.
* If a source format has been defined for this type, the formatValue does also accept
* a string value as input, which will be parsed into an array using the source format.
* If aValues is not defined or null, null will be returned.
* @param {any[]|string} vValue - the array of values or string value to be formatted
* @param {string} sInternalType - the target type
* @returns {any} the formatted output value
*/
public formatValue(vValue: any[]|string, sInternalType: string): any;
/**
* Returns a metadata object for class sap.ui.model.type.Currency.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Parse a string value to an array containing amount and currency. Parsing of other
* internal types than 'string' is not supported by the Currency type.
* In case a source format has been defined, after parsing the currency is formatted
* using the source format and a string value is returned instead.
* @param {any} vValue - the value to be parsed
* @param {string} sInternalType - the source type
* @param {any[]} aCurrentValues - the current values of all binding parts
* @returns {any[]} the parse result array
*/
public parseValue(vValue: any, sInternalType: string, aCurrentValues: any[]): any[];
}
/**
* This class represents date simple types.
*/
export class Date extends sap.ui.model.SimpleType {
/**
* Constructor for a Date type.
* @param {any} oFormatOptions - Formatting options. For a list of all available options, see {@link sap.ui.core.format.DateFormat#getDateInstance DateFormat}.
* @param {any} oConstraints - Value constraints
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.type.Date with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.SimpleType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.type.Date.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* @returns {any}
*/
protected getOutputPattern(): any;
}
/**
* This class represents datetime simple types.
*/
export class DateTime extends sap.ui.model.type.Date {
/**
* Constructor for a DateTime type.
* @param {any} oFormatOptions - Formatting options. For a list of all available options, see {@link sap.ui.core.format.DateFormat#getDateTimeInstance DateFormat}.
* @param {any} oConstraints - Value constraints. Supports the same kind of constraints as its base type Date, but note the different format options (Date vs. DateTime).
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.type.DateTime with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.type.Date.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.type.DateTime.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* This class represents file size simple types.
*/
export class FileSize extends sap.ui.model.SimpleType {
/**
* Constructor for a FileSize type.
* @param {any} oFormatOptions - formatting options. Supports the same options as {@link sap.ui.core.format.FileSizeFormat.getInstance FileSizeFormat.getInstance}
* @param {any} oConstraints - value constraints.
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.type.FileSize with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.SimpleType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.type.FileSize.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* This class represents float simple types.
*/
export class Float extends sap.ui.model.SimpleType {
/**
* Constructor for a Float type.
* @param {any} oFormatOptions - Formatting options. For a list of all available options, see {@link sap.ui.core.format.NumberFormat#constructor NumberFormat}.
* @param {any} oConstraints - Value constraints
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.type.Float with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.SimpleType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.type.Float.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* This class represents integer simple types.
*/
export class Integer extends sap.ui.model.SimpleType {
/**
* Constructor for an Integer type.
* @param {any} oFormatOptions - Formatting options. For a list of all available options, see {@link sap.ui.core.format.NumberFormat#constructor NumberFormat}.
* @param {any} oConstraints - Value constraints
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.type.Integer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.SimpleType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.type.Integer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* This class represents string simple types.
*/
export class String extends sap.ui.model.SimpleType {
/**
* Constructor for a String type.
* @param {any} oFormatOptions - formatting options. String doesn't support any formatting options
* @param {any} oConstraints - value constraints. All given constraints must be fulfilled by a value to be valid
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.type.String with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.SimpleType.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.type.String.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* This class represents time simple types.
*/
export class Time extends sap.ui.model.type.Date {
/**
* Constructor for a Time type.
* @param {any} oFormatOptions - Formatting options. For a list of all available options, see {@link sap.ui.core.format.DateFormat#getTimeInstance DateFormat}.
* @param {any} oConstraints - Value constraints. Supports the same kind of constraints as its base type Date, but note the different format options (Date vs. Time).
*/
public constructor(oFormatOptions?: any, oConstraints?: any);
/**
* Creates a new subclass of class sap.ui.model.type.Time with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.type.Date.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.type.Time.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
}
/**
* XML-based DataBinding
*/
namespace xml {
/**
* Model implementation for XML format
*/
export class XMLModel extends sap.ui.model.ClientModel {
/**
* Constructor for a new XMLModel.
* @param {any} oData - either the URL where to load the XML from or an XML
*/
public constructor(oData: any);
/**
* Creates a new subclass of class sap.ui.model.xml.XMLModel with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.model.ClientModel.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.model.xml.XMLModel.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the object for the given path
* @param {string} sPath - the path to the object
* @param {any} oContext - the context which will be used to retrieve the object
* @returns {any} the object
*/
public getObject(sPath: string, oContext?: any): any;
/**
* Returns the value for the property with the given sPropertyName
* @param {string} sPath - the path to the property
* @param {any} oContext - the context which will be used to retrieve the property
* @returns {any} the value of the property
*/
public getProperty(sPath: string, oContext?: any): any;
/**
* Serializes the current XML data of the model into a string.
* @returns {any} the XML document serialized as string
*/
public getXML(): any;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, mHeaders: any): void;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {string} bCache - force no caching if false. Default is false
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, bCache: string, mHeaders: any): void;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {string} sType - of request. Default is 'GET'
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, sType: string, mHeaders: any): void;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {string} sType - of request. Default is 'GET'
* @param {string} bCache - force no caching if false. Default is false
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, sType: string, bCache: string, mHeaders: any): void;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {boolean} bAsync - if the request should be asynchron or not. Default is true.
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, bAsync: boolean, mHeaders: any): void;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {boolean} bAsync - if the request should be asynchron or not. Default is true.
* @param {string} bCache - force no caching if false. Default is false
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, bAsync: boolean, bCache: string, mHeaders: any): void;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {boolean} bAsync - if the request should be asynchron or not. Default is true.
* @param {string} sType - of request. Default is 'GET'
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, bAsync: boolean, sType: string, mHeaders: any): void;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {boolean} bAsync - if the request should be asynchron or not. Default is true.
* @param {string} sType - of request. Default is 'GET'
* @param {string} bCache - force no caching if false. Default is false
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, bAsync: boolean, sType: string, bCache: string, mHeaders: any): void;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {any|string} oParameters - A map or string that is sent to the server with the request.
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, oParameters: any|string, mHeaders: any): void;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {any|string} oParameters - A map or string that is sent to the server with the request.
* @param {string} bCache - force no caching if false. Default is false
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, oParameters: any|string, bCache: string, mHeaders: any): void;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {any|string} oParameters - A map or string that is sent to the server with the request.
* @param {string} sType - of request. Default is 'GET'
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, oParameters: any|string, sType: string, mHeaders: any): void;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {any|string} oParameters - A map or string that is sent to the server with the request.
* @param {string} sType - of request. Default is 'GET'
* @param {string} bCache - force no caching if false. Default is false
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, oParameters: any|string, sType: string, bCache: string, mHeaders: any): void;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {any|string} oParameters - A map or string that is sent to the server with the request.
* @param {boolean} bAsync - if the request should be asynchron or not. Default is true.
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, oParameters: any|string, bAsync: boolean, mHeaders: any): void;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {any|string} oParameters - A map or string that is sent to the server with the request.
* @param {boolean} bAsync - if the request should be asynchron or not. Default is true.
* @param {string} bCache - force no caching if false. Default is false
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, oParameters: any|string, bAsync: boolean, bCache: string, mHeaders: any): void;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {any|string} oParameters - A map or string that is sent to the server with the request.
* @param {boolean} bAsync - if the request should be asynchron or not. Default is true.
* @param {string} sType - of request. Default is 'GET'
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, oParameters: any|string, bAsync: boolean, sType: string, mHeaders: any): void;
/**
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the model.
* Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin policy,
* the request can not successfully retrieve data from a different domain, subdomain, or protocol.
* @param {string} sURL - A string containing the URL to which the request is sent.
* @param {any|string} oParameters - A map or string that is sent to the server with the request.
* @param {boolean} bAsync - if the request should be asynchron or not. Default is true.
* @param {string} sType - of request. Default is 'GET'
* @param {string} bCache - force no caching if false. Default is false
* @param {any} mHeaders - An object of additional header key/value pairs to send along with the request
*/
public loadData(sURL: string, oParameters: any|string, bAsync: boolean, sType: string, bCache: string, mHeaders: any): void;
/**
* Sets the provided XML encoded data object to the model
* @param {any} oData - the data to set to the model
*/
public setData(oData: any): void;
/**
* Sets an XML namespace to use in the binding path
* @param {string} sNameSpace - the namespace URI
* @param {string} sPrefix - the prefix for the namespace (optional)
*/
public setNameSpace(sNameSpace: string, sPrefix?: string): void;
/**
* Sets a new value for the given property sPropertyName
in the model.
* If the model value changed all interested parties are informed.
* @param {string} sPath - path of the property to set
* @param {any} oValue - value to set the property to
* @param {any} oContext - the context which will be used to set the property
* @param {boolean} bAsyncUpdate - whether to update other bindings dependent on this property asynchronously
* @returns {boolean} true if the value was set correctly and false if errors occurred like the entry was not found.
*/
public setProperty(sPath: string, oValue: any, oContext?: any, bAsyncUpdate?: boolean): boolean;
/**
* Sets the specified XML formatted string text to the model
* @param {string} sXMLText - the XML data as string
*/
public setXML(sXMLText: string): void;
}
/**
* Tree binding implementation for XML format
*/
export class XMLTreeBinding extends sap.ui.model.TreeBinding {
/**
* @param {string} Path - pointing to the tree or array that should be bound
* @param {any} oContext - Context object for this binding
* @param {any[]} aFilters - Predefined filters contained in an array
* @param {any} mParameters - Additional model-specific parameters
*/
public constructor(Path: string, oContext?: any, aFilters?: any[], mParameters?: any);
/**
* @param {sap.ui.model.xml.XMLModel} oModel
* @param {string} Path - pointing to the tree or array that should be bound
* @param {any} oContext - Context object for this binding
* @param {any[]} aFilters - Predefined filters contained in an array
* @param {any} mParameters - Additional model-specific parameters
*/
public constructor(oModel: sap.ui.model.xml.XMLModel, Path: string, oContext?: any, aFilters?: any[], mParameters?: any);
/**
* Return node contexts for the tree
* @param {any} oContext - to use for retrieving the node contexts
* @param {number} iStartIndex - the startIndex where to start the retrieval of contexts
* @param {number} iLength - determines how many contexts to retrieve beginning from the start index.
* @returns {any[]} the contexts array
*/
public getNodeContexts(oContext: any, iStartIndex: number, iLength: number): any[];
}
}
}
/**
* Suite controls library.
*/
namespace suite {
/**
* This control shows a circle which radius and color depends on the given parameters
*/
export class TaskCircle extends sap.ui.core.Control {
/**
* Constructor for a new TaskCircle.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.ui.suite.TaskCircle} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.suite.TaskCircle;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.suite.TaskCircle} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.suite.TaskCircle;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.suite.TaskCircle
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.suite.TaskCircle
itself.
*
* Event is fired when the user clicks the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.suite.TaskCircle
itself
* @returns {sap.ui.suite.TaskCircle} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.ui.suite.TaskCircle;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.suite.TaskCircle
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.suite.TaskCircle
itself.
*
* Event is fired when the user clicks the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.suite.TaskCircle
itself
* @returns {sap.ui.suite.TaskCircle} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.ui.suite.TaskCircle;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.ui.suite.TaskCircle
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.suite.TaskCircle} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.ui.suite.TaskCircle;
/**
* Creates a new subclass of class sap.ui.suite.TaskCircle with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.suite.TaskCircle} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.ui.suite.TaskCircle;
/**
* Puts the focus to the control.
*/
public focus(): void;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getColor color}.
*
* Color of the circle. The default color is red.
*
* Default value is Gray
.
* @returns {sap.ui.suite.TaskCircleColor} Value of property color
*/
public getColor(): sap.ui.suite.TaskCircleColor;
/**
* Gets current value of property {@link #getMaxValue maxValue}.
*
* Upper limit of the displayed values. Default is 100.
*
* Default value is 100
.
* @returns {number} Value of property maxValue
*/
public getMaxValue(): number;
/**
* Returns a metadata object for class sap.ui.suite.TaskCircle.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinValue minValue}.
*
* Lower limit of the displayed values. Default is 0.
*
* Default value is 0
.
* @returns {number} Value of property minValue
*/
public getMinValue(): number;
/**
* Gets current value of property {@link #getValue value}.
*
* Current value of the task circle to be displayed. In dependency of the parameters maxValue and minValue it controls the size of the circle.
*
* Default value is 0
.
* @returns {number} Value of property value
*/
public getValue(): number;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getColor color}.
*
* Color of the circle. The default color is red.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Gray
.
* @param {sap.ui.suite.TaskCircleColor} sColor - New value for property color
* @returns {sap.ui.suite.TaskCircle} Reference to this
in order to allow method chaining
*/
public setColor(sColor: sap.ui.suite.TaskCircleColor): sap.ui.suite.TaskCircle;
/**
* Sets a new value for property {@link #getMaxValue maxValue}.
*
* Upper limit of the displayed values. Default is 100.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100
.
* @param {number} iMaxValue - New value for property maxValue
* @returns {sap.ui.suite.TaskCircle} Reference to this
in order to allow method chaining
*/
public setMaxValue(iMaxValue: number): sap.ui.suite.TaskCircle;
/**
* Sets a new value for property {@link #getMinValue minValue}.
*
* Lower limit of the displayed values. Default is 0.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iMinValue - New value for property minValue
* @returns {sap.ui.suite.TaskCircle} Reference to this
in order to allow method chaining
*/
public setMinValue(iMinValue: number): sap.ui.suite.TaskCircle;
/**
* Sets a new value for property {@link #getValue value}.
*
* Current value of the task circle to be displayed. In dependency of the parameters maxValue and minValue it controls the size of the circle.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iValue - New value for property value
* @returns {sap.ui.suite.TaskCircle} Reference to this
in order to allow method chaining
*/
public setValue(iValue: number): sap.ui.suite.TaskCircle;
}
/**
* Defined color values for the Task Circle Control
*/
export enum TaskCircleColor {
/**
* Default value
*/
Gray = "Gray",
/**
* Green
*/
Green = "Green",
/**
* Red
*/
Red = "Red",
/**
* Yellow
*/
Yellow = "Yellow",
}
/**
* This control shows a vertical progress bar in dependency of the given percentage. Only values between 0 and 100 are valid.
*/
export class VerticalProgressIndicator extends sap.ui.core.Control {
/**
* Constructor for a new VerticalProgressIndicator.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - the ariaDescribedBy to add; if empty, nothing is inserted
* @returns {sap.ui.suite.VerticalProgressIndicator} Reference to this
in order to allow method chaining
*/
public addAriaDescribedBy(vAriaDescribedBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.suite.VerticalProgressIndicator;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.suite.VerticalProgressIndicator} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.suite.VerticalProgressIndicator;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.suite.VerticalProgressIndicator
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.suite.VerticalProgressIndicator
itself.
*
* Event is fired when the user clicks the control.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.suite.VerticalProgressIndicator
itself
* @returns {sap.ui.suite.VerticalProgressIndicator} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.ui.suite.VerticalProgressIndicator;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.suite.VerticalProgressIndicator
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.suite.VerticalProgressIndicator
itself.
*
* Event is fired when the user clicks the control.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.suite.VerticalProgressIndicator
itself
* @returns {sap.ui.suite.VerticalProgressIndicator} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.ui.suite.VerticalProgressIndicator;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.ui.suite.VerticalProgressIndicator
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.suite.VerticalProgressIndicator} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.ui.suite.VerticalProgressIndicator;
/**
* Creates a new subclass of class sap.ui.suite.VerticalProgressIndicator with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.suite.VerticalProgressIndicator} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.ui.suite.VerticalProgressIndicator;
/**
* Puts the focus to the control.
*/
public focus(): void;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaDescribedBy(): sap.ui.core.ID[];
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Returns a metadata object for class sap.ui.suite.VerticalProgressIndicator.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPercentage percentage}.
*
* The numerical value between 0 and 100 which determines the height of the vertical bar. Values higher than 100 will be displayed as 100%, values lower than zero will be displayed as 0%.
* @returns {number} Value of property percentage
*/
public getPercentage(): number;
/**
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaDescribedBy(): sap.ui.core.ID[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaDescribedBy - The ariaDescribedBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaDescribedBy or null
*/
public removeAriaDescribedBy(vAriaDescribedBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Property setter for the Percentage, which determines the height of the vertical bar.
* Values higher than 100 will be displayed as 100%, values lower than zero will be displayed as 0%.
* A new rendering is not necessary, only the bar will be moved
* @param {number} iPercentage
* @returns {sap.ui.suite.VerticalProgressIndicator} this
to allow method chaining
*/
public setPercentage(iPercentage: number): sap.ui.suite.VerticalProgressIndicator;
}
}
/**
* Table-like controls, mainly for desktop scenarios.
*/
namespace table {
/**
* This column adds additional properties to the table column which are needed for the analytical binding and table
*/
export class AnalyticalColumn extends sap.ui.table.Column {
/**
* Constructor for a new AnalyticalColumn.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.table.AnalyticalColumn with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.table.Column.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getGroupHeaderFormatter groupHeaderFormatter}.
*
* If the column is grouped, this formatter is used to format the value in the group header
* @returns {any} Value of property groupHeaderFormatter
*/
public getGroupHeaderFormatter(): any;
/**
* Gets current value of property {@link #getInResult inResult}.
*
* Specifies that the dimension referred to by the column shall be included in the granularity of the data result. It allows a finer distinction between a visible/grouped/(included)inResult column.
*
* Default value is false
.
* @returns {boolean} Value of property inResult
*/
public getInResult(): boolean;
/**
* Gets current value of property {@link #getLeadingProperty leadingProperty}.
*
* Defines the primary model property which is used inside the Column. In case of the analytical extension this means the property which is grouped by for dimensions or the property which is summed for measures.
* @returns {string} Value of property leadingProperty
*/
public getLeadingProperty(): string;
/**
* Returns a metadata object for class sap.ui.table.AnalyticalColumn.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowIfGrouped showIfGrouped}.
*
* Specifies whether the column is displayed within the table even if it is grouped or not. A grouped column has the same value for every rows within the group.
*
* Default value is false
.
* @returns {boolean} Value of property showIfGrouped
*/
public getShowIfGrouped(): boolean;
/**
* Gets current value of property {@link #getSummed summed}.
*
* If defined a sum for this column is calculated
*
* Default value is false
.
* @returns {boolean} Value of property summed
*/
public getSummed(): boolean;
/**
* Sets a new value for property {@link #getGroupHeaderFormatter groupHeaderFormatter}.
*
* If the column is grouped, this formatter is used to format the value in the group header
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oGroupHeaderFormatter - New value for property groupHeaderFormatter
* @returns {sap.ui.table.AnalyticalColumn} Reference to this
in order to allow method chaining
*/
public setGroupHeaderFormatter(oGroupHeaderFormatter: any): sap.ui.table.AnalyticalColumn;
/**
* Sets a new value for property {@link #getInResult inResult}.
*
* Specifies that the dimension referred to by the column shall be included in the granularity of the data result. It allows a finer distinction between a visible/grouped/(included)inResult column.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bInResult - New value for property inResult
* @returns {sap.ui.table.AnalyticalColumn} Reference to this
in order to allow method chaining
*/
public setInResult(bInResult: boolean): sap.ui.table.AnalyticalColumn;
/**
* Sets a new value for property {@link #getLeadingProperty leadingProperty}.
*
* Defines the primary model property which is used inside the Column. In case of the analytical extension this means the property which is grouped by for dimensions or the property which is summed for measures.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sLeadingProperty - New value for property leadingProperty
* @returns {sap.ui.table.AnalyticalColumn} Reference to this
in order to allow method chaining
*/
public setLeadingProperty(sLeadingProperty: string): sap.ui.table.AnalyticalColumn;
/**
* Sets a new value for property {@link #getShowIfGrouped showIfGrouped}.
*
* Specifies whether the column is displayed within the table even if it is grouped or not. A grouped column has the same value for every rows within the group.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowIfGrouped - New value for property showIfGrouped
* @returns {sap.ui.table.AnalyticalColumn} Reference to this
in order to allow method chaining
*/
public setShowIfGrouped(bShowIfGrouped: boolean): sap.ui.table.AnalyticalColumn;
/**
* Sets a new value for property {@link #getSummed summed}.
*
* If defined a sum for this column is calculated
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSummed - New value for property summed
* @returns {sap.ui.table.AnalyticalColumn} Reference to this
in order to allow method chaining
*/
public setSummed(bSummed: boolean): sap.ui.table.AnalyticalColumn;
}
/**
* A column menu which is used by the analytical column
*/
export class AnalyticalColumnMenu extends sap.ui.table.ColumnMenu {
/**
* Constructor for a new AnalyticalColumnMenu.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.table.AnalyticalColumnMenu with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.table.ColumnMenu.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.table.AnalyticalColumnMenu.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Table which handles analytical OData backends. The AnalyticalTable only works with an AnalyticalBinding and
* correctly annotated OData services. Please check on the SAP Annotations for OData Version 2.0 documentation for further details.
*/
export class AnalyticalTable extends sap.ui.table.Table {
/**
* Constructor for a new AnalyticalTable.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Marks a range of tree nodes as selected, starting with iFromIndex going to iToIndex.
* The nodes are referenced via their absolute row index.
* Please be aware that the absolute row index only applies to the tree which is visualized by the AnalyticalTable
control.
* Invisible nodes (collapsed child nodes) will not be taken into account.
*
* Please also take notice of the fact, that "addSelectionInterval" does not change any other selection.
* To override the current selection, please use "setSelctionInterval" or for a single entry use "setSelectedIndex".
* @param {number} iFromIndex - The starting index of the range which will be selected.
* @param {number} iToIndex - The starting index of the range which will be selected.
* @returns {sap.ui.table.AnalyticalTable} a reference to the AnalyticalTable
control, can be used for chaining
*/
public addSelectionInterval(iFromIndex: number, iToIndex: number): sap.ui.table.AnalyticalTable;
/**
* Clears the complete selection (all analytical table rows/nodes will be deselected).
* @returns {sap.ui.table.AnalyticalTable} a reference to the AnalyticalTable
control, can be used for chaining
*/
public clearSelection(): sap.ui.table.AnalyticalTable;
/**
* Collapses all nodes (and lower if collapseRecursive is activated)
* @returns {sap.ui.table.AnalyticalTable} a reference on the AnalyticalTable
control, can be used for chaining
*/
public collapseAll(): sap.ui.table.AnalyticalTable;
/**
* Creates a new subclass of class sap.ui.table.AnalyticalTable with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.table.Table.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAutoExpandMode autoExpandMode}.
*
* The kind of auto expansion algorithm, e.g. optimized filter conditions, per level requests, ...
* Must be a value of sap.ui.table.TreeAutoExpandMode
.
*
* Default value is Bundled
.
* @returns {string} Value of property autoExpandMode
*/
public getAutoExpandMode(): string;
/**
* Gets current value of property {@link #getCollapseRecursive collapseRecursive}.
*
* Setting collapseRecursive to true means, that when collapsing a node all subsequent child nodes will also be collapsed.
*
* Calling the setter of this property only has an effect when the tables rows
aggregation is already bound and
* the binding supports this feature.
*
* Default value is true
.
* @returns {boolean} Value of property collapseRecursive
*/
public getCollapseRecursive(): boolean;
/**
* Gets current value of property {@link #getColumnVisibilityMenuSorter columnVisibilityMenuSorter}.
*
* Functions which is used to sort the column visibility menu entries e.g.: function(ColumnA, ColumnB) { return 0 = equals, <0 lower, >0 greater }; Other values than functions will be ignored.
* @returns {any} Value of property columnVisibilityMenuSorter
*/
public getColumnVisibilityMenuSorter(): any;
/**
* Returns the context of a row by its index.
* @param {number} iIndex - Index of the row to return the context from.
* @returns {any} The context of a row by its index
*/
public getContextByIndex(iIndex: number): any;
/**
* Gets current value of property {@link #getDirty dirty}.
*
* If dirty the content of the Table will be overlayed.
* @returns {boolean} Value of property dirty
*/
public getDirty(): boolean;
/**
* The property enableGrouping
is not supported by the TreeTable
control.
* @returns {boolean}
*/
public getEnableGrouping(): boolean;
/**
* Returns a metadata object for class sap.ui.table.AnalyticalTable.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getNumberOfExpandedLevels numberOfExpandedLevels}.
*
* Number of levels, which should be opened initially (on first load of data).
*
* Default value is 0
.
* @returns {number} Value of property numberOfExpandedLevels
*/
public getNumberOfExpandedLevels(): number;
/**
* Retrieves the lead selection index. The lead selection index is, among other things, used to determine the
* start/end of a selection range, when using Shift-Click to select multiple entries at once.
* @returns {number} an array containing all selected indices (ascending ordered integers)
*/
public getSelectedIndex(): number;
/**
* Returns an array containing the row indices of all selected tree nodes (in ascending order).
*
* Please be aware of the following:
* Due to performance/network traffic reasons, the getSelectedIndices function returns only all indices
* of actually selected rows/tree nodes. Unknown rows/nodes (as in "not yet loaded" to the client), will not be
* returned.
* @returns {number[]} an array containing all selected indices
*/
public getSelectedIndices(): number[];
/**
* Gets current value of property {@link #getSumOnTop sumOnTop}.
*
* Specifies if the total values should be displayed in the group headers or on bottom of the row. Does not affect the total sum.
*
* Default value is false
.
* @returns {boolean} Value of property sumOnTop
*/
public getSumOnTop(): boolean;
/**
* Returns the total size of the data entries.
* @returns {number} The total size of the data entries
*/
public getTotalSize(): number;
/**
* Checks if the row at the given index is selected.
* @param {number} iRowIndex - The row index for which the selection state should be retrieved
* @returns {boolean} true if the index is selected, false otherwise
*/
public isIndexSelected(iRowIndex: number): boolean;
/**
* All rows/tree nodes inside the range (including boundaries) will be deselected.
* The nodes are referenced with their absolute row index.
* Please be aware that the absolute row index only applies to the tree which is visualized by the AnalyticalTable
control.
* Invisible nodes (collapsed child nodes) will not be taken into account.
* @param {number} iFromIndex - The starting index of the range which will be deselected.
* @param {number} iToIndex - The starting index of the range which will be deselected.
* @returns {sap.ui.table.AnalyticalTable} a reference to the AnalyticalTable
control, can be used for chaining
*/
public removeSelectionInterval(iFromIndex: number, iToIndex: number): sap.ui.table.AnalyticalTable;
/**
* This function is used by some composite controls to force updating the AnalyticalInfo
* @param {boolean} bSuppressRefresh - binding shall not refresh data
* @param {boolean} bForceChange - forces the binding to fire a change event
*/
protected resumeUpdateAnalyticalInfo(bSuppressRefresh: boolean, bForceChange: boolean): void;
/**
* Selects all available nodes/rows.
*
* Explanation of the SelectAll function and what to expect from its behavior:
* All rows/nodes stored locally on the client are selected.
* In addition all subsequent rows/tree nodes, which will be paged into view are also immediatly selected.
* However, due to obvious performance/network traffic reasons, the SelectAll function will NOT retrieve any data from the backend.
* @returns {sap.ui.table.AnalyticalTable} a reference to the AnalyticalTable
control, can be used for chaining
*/
public selectAll(): sap.ui.table.AnalyticalTable;
/**
* Sets a new value for property {@link #getAutoExpandMode autoExpandMode}.
*
* The kind of auto expansion algorithm, e.g. optimized filter conditions, per level requests, ...
* Must be a value of sap.ui.table.TreeAutoExpandMode
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Bundled
.
* @param {string} sAutoExpandMode - New value for property autoExpandMode
* @returns {sap.ui.table.AnalyticalTable} Reference to this
in order to allow method chaining
*/
public setAutoExpandMode(sAutoExpandMode: string): sap.ui.table.AnalyticalTable;
/**
* Sets a new value for property {@link #getColumnVisibilityMenuSorter columnVisibilityMenuSorter}.
*
* Functions which is used to sort the column visibility menu entries e.g.: function(ColumnA, ColumnB) { return 0 = equals, <0 lower, >0 greater }; Other values than functions will be ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oColumnVisibilityMenuSorter - New value for property columnVisibilityMenuSorter
* @returns {sap.ui.table.AnalyticalTable} Reference to this
in order to allow method chaining
*/
public setColumnVisibilityMenuSorter(oColumnVisibilityMenuSorter: any): sap.ui.table.AnalyticalTable;
/**
* Sets a new value for property {@link #getDirty dirty}.
*
* If dirty the content of the Table will be overlayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bDirty - New value for property dirty
* @returns {sap.ui.table.AnalyticalTable} Reference to this
in order to allow method chaining
*/
public setDirty(bDirty: boolean): sap.ui.table.AnalyticalTable;
/**
* The property enableGrouping
is not supported by the AnalyticalTable
control.
*/
public setEnableGrouping(): void;
/**
* Sets a new value for property {@link #getNumberOfExpandedLevels numberOfExpandedLevels}.
*
* Number of levels, which should be opened initially (on first load of data).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iNumberOfExpandedLevels - New value for property numberOfExpandedLevels
* @returns {sap.ui.table.AnalyticalTable} Reference to this
in order to allow method chaining
*/
public setNumberOfExpandedLevels(iNumberOfExpandedLevels: number): sap.ui.table.AnalyticalTable;
/**
* In an AnalyticalTable
control you can only select indices, which correspond to the currently visualized tree.
* Invisible nodes (e.g. collapsed child nodes) cannot be selected via Index, because they do not
* correspond to an AnalyticalTable
row.
* @param {number} iRowIndex - The row index which will be selected (in case it exists)
* @returns {sap.ui.table.AnalyticalTable} a reference to the AnalyticalTable
control, can be used for chaining
*/
public setSelectedIndex(iRowIndex: number): sap.ui.table.AnalyticalTable;
/**
* Sets the selection behavior.
* Since the AnalyticalTable relies on the RowSelector for rendering the group headers the SelectionBehavior "RowOnly" is
* not supported and must not be used.
* @param {string} sBehavior - the selection behavior, see sap.ui.table.SelectionBehavior
* @returns {sap.ui.table.Table} this for chaining
*/
public setSelectionBehavior(sBehavior: string): sap.ui.table.Table;
/**
* Sets the selection of the AnalyticalTable
control to the given range (including boundaries).
*
* Note: The previous selection will be lost/overridden. If this is not the required behavior,
* please use addSelectionInterval
and removeSelectionIntervall
.
* @param {number} iFromIndex - the start index of the selection range
* @param {number} iToIndex - the end index of the selection range
* @returns {sap.ui.table.AnalyticalTable} a reference to the AnalyticalTable
control, can be used for chaining
*/
public setSelectionInterval(iFromIndex: number, iToIndex: number): sap.ui.table.AnalyticalTable;
/**
* Sets the selection mode, the current selection is lost.
* Since the AnalyticalTable relies on the RowSelector for rendering the group headers the SelectionMode "None" is
* not supported and must not be used.
* @param {string} sSelectionMode - the selection mode, see sap.ui.table.SelectionMode
* @returns {sap.ui.table.Table} a reference on the table for chaining
*/
public setSelectionMode(sSelectionMode: string): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getSumOnTop sumOnTop}.
*
* Specifies if the total values should be displayed in the group headers or on bottom of the row. Does not affect the total sum.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSumOnTop - New value for property sumOnTop
* @returns {sap.ui.table.AnalyticalTable} Reference to this
in order to allow method chaining
*/
public setSumOnTop(bSumOnTop: boolean): sap.ui.table.AnalyticalTable;
/**
* This function is used by some composite controls to avoid updating the AnalyticalInfo when several column are added to the table.
* In order to finally update the AnalyticalInfo and request data, resumeUpdateAnalyticalInfo must be called.
*/
protected suspendUpdateAnalyticalInfo(): void;
}
/**
* The column allows you to define column specific properties that will be applied when rendering the table.
*/
export class Column extends sap.ui.core.Element {
/**
* Constructor for a new Column.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some multiLabel to the aggregation {@link #getMultiLabels multiLabels}.
* @param {sap.ui.core.Control} oMultiLabel - the multiLabel to add; if empty, nothing is inserted
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public addMultiLabel(oMultiLabel: sap.ui.core.Control): sap.ui.table.Column;
/**
* Attaches event handler fnFunction
to the {@link #event:columnMenuOpen columnMenuOpen} event of this sap.ui.table.Column
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Column
itself.
*
* Fires before the column menu is opened.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Column
itself
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public attachColumnMenuOpen(fnFunction: Function, oListener?: any): sap.ui.table.Column;
/**
* Attaches event handler fnFunction
to the {@link #event:columnMenuOpen columnMenuOpen} event of this sap.ui.table.Column
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Column
itself.
*
* Fires before the column menu is opened.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Column
itself
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public attachColumnMenuOpen(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.Column;
/**
* Destroys the label in the aggregation {@link #getLabel label}.
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public destroyLabel(): sap.ui.table.Column;
/**
* Destroys the menu in the aggregation {@link #getMenu menu}.
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public destroyMenu(): sap.ui.table.Column;
/**
* Destroys all the multiLabels in the aggregation {@link #getMultiLabels multiLabels}.
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public destroyMultiLabels(): sap.ui.table.Column;
/**
* Destroys the template in the aggregation {@link #getTemplate template}.
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public destroyTemplate(): sap.ui.table.Column;
/**
* Detaches event handler fnFunction
from the {@link #event:columnMenuOpen columnMenuOpen} event of this sap.ui.table.Column
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public detachColumnMenuOpen(fnFunction: Function, oListener: any): sap.ui.table.Column;
/**
* Creates a new subclass of class sap.ui.table.Column with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:columnMenuOpen columnMenuOpen} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireColumnMenuOpen(mParameters?: any): boolean;
/**
* Gets current value of property {@link #getAutoResizable autoResizable}.
*
* Enables auto-resizing of the column on double clicking the resize bar. The width is determined on the widest
* currently displayed content. It does not consider rows which are currently not scrolled into view.
* Currently only implemented to work with the following controls:
* sap.m.Text, sap.m.Label, sap.m.Link, sap.m.Input,
* sap.ui.commons.TextView, sap.ui.commons.Label, sap.ui.commons.Link and sap.ui.commons.TextField,
* sap.ui.commons.Checkbox, sap.m.Checkbox
*
* Default value is false
.
* @returns {boolean} Value of property autoResizable
*/
public getAutoResizable(): boolean;
/**
* Gets current value of property {@link #getDefaultFilterOperator defaultFilterOperator}.
*
* If this property is set, the default filter operator of the column is overridden.
* By default Contains
is used for string and EQ
for other types. A valid
* sap.ui.model.FilterOperator
needs to be passed.
* @returns {string} Value of property defaultFilterOperator
*/
public getDefaultFilterOperator(): string;
/**
* Gets current value of property {@link #getFiltered filtered}.
*
* Indicates if the column is filtered. This property only controls if a filter indicator is displayed in the
* column header - it does not trigger the filter function. The column has to be filtered by calling Column.sort()
*
* Default value is false
.
* @returns {boolean} Value of property filtered
*/
public getFiltered(): boolean;
/**
* Gets current value of property {@link #getFilterOperator filterOperator}.
*
* Filter operator to use when filtering this column.
* @returns {string} Value of property filterOperator
*/
public getFilterOperator(): string;
/**
* Gets current value of property {@link #getFilterProperty filterProperty}.
*
* Specifies the binding property on which the column shall be filtered.
* Since the column template may have composite bindings, it's not possible to figure out on which binding
* property the filter shall be applied. Therefore the binding property for filtering must be specified.
* For example, if the first name and last name are displayed in the same column, only one of the two can be defined as
* filterProperty
.
*
* A column menu entry for filtering can only be generated if the filterProperty
is set. The
* default menu entry is a text input field.
* @returns {string} Value of property filterProperty
*/
public getFilterProperty(): string;
/**
* Gets current value of property {@link #getFilterType filterType}.
*
* Type of Filter. This is used to transform the search term to the specified type,
* to make sure that the right columns are displayed. This should be the same as defined
* in binding for this column. As an alternative you can pass a function which does the conversion.
* The function receives the entered filter value as parameter and returns the proper
* value for the filter expression. Another option is to pass the class name of the type,
* e.g.: sap.ui.model.type.Date
or an expression similar to the binding syntax,
* e.g.: "\{type: 'sap.ui.model.type.Date', formatOptions: \{UTC: true\}, constraints: \{\} \}"
.
* Here the escaping is mandatory to avoid handling by the binding parser.
* By default the filter type is sap.ui.model.type.String
.
* @returns {any} Value of property filterType
*/
public getFilterType(): any;
/**
* Gets current value of property {@link #getFilterValue filterValue}.
*
* Specifies the value of the filter as string (will be converted into the proper data type). It is possible
* to provide a filterOperator as string, as shown here:
*
* > 50
* < 100
* >= 150
* <= 200
* = 250
* != 300
* something ends with
* something* starts with
* something* contains
* some..thing between
* 50..100 between
*
* @returns {string} Value of property filterValue
*/
public getFilterValue(): string;
/**
* Gets current value of property {@link #getFlexible flexible}.
*
* If the table is wider than the sum of widths of the visible columns, the columns will be
* resized proportionally to their widths that were set originally. If set to false, the column will be displayed in the
* original width. If all columns are set to not be flexible, an extra "dummy" column will be
* created at the end of the table.
*
* Default value is true
.
* @returns {boolean} Value of property flexible
*/
public getFlexible(): boolean;
/**
* Gets current value of property {@link #getGrouped grouped}.
*
* Indicates if the column is grouped.
*
* Default value is false
.
* @returns {boolean} Value of property grouped
*/
public getGrouped(): boolean;
/**
* Gets current value of property {@link #getHAlign hAlign}.
*
* Horizontal alignment of the column content. Controls with a text align do not inherit
* the horizontal alignment. You have to set the text align directly on the template.
*
* Default value is Begin
.
* @returns {sap.ui.core.HorizontalAlign} Value of property hAlign
*/
public getHAlign(): sap.ui.core.HorizontalAlign;
/**
* Gets current value of property {@link #getHeaderSpan headerSpan}.
*
* If this property is set, a span is applied for the header. When moving columns, all columns
* which are part of the header will be moved. The headerSpan
can be either an integer or an array of
* integers (if you use the multi header feature of the table). If you only specify an integer, this span is
* applied for all header rows, with multiple integers you can specify a separate span for each header row.
*
* Default value is 1
.
* @returns {any} Value of property headerSpan
*/
public getHeaderSpan(): any;
/**
* Gets content of aggregation {@link #getLabel label}.
*
* Label of the column which is displayed in the column header. This aggregation is for the standard behavior,
* where you only want to display one single row header. If a string is supplied, a default label control will be
* created. Which control this is depends on the loaded libraries.
* @returns {sap.ui.core.Control|string}
*/
public getLabel(): sap.ui.core.Control|string;
/**
* Gets content of aggregation {@link #getMenu menu}.
*
* The menu used by the column. By default the {@link sap.ui.table.ColumnMenu} is used.
*
* Note: Applications must not use or change the default sap.ui.table.ColumnMenu
of
* a column in any way or create own instances of sap.ui.table.ColumnMenu
.
* To add a custom menu to a column, use the aggregation menu
with a new instance of
* sap.ui.unified.Menu
.
* @returns {sap.ui.unified.Menu}
*/
public getMenu(): sap.ui.unified.Menu;
/**
* Returns a metadata object for class sap.ui.table.Column.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinWidth minWidth}.
*
* Defines the minimum width of a column in pixels.
* This property only has an effect if the given column width is flexible, for example with width auto
.
*
This property only influences the automatic behavior. If a user adjusts the column width manually, the column width can become
* smaller.
*
Minimal column width is device-dependent, for example on desktop devices the column will not be smaller than 48px.
*
* Default value is 0
.
* @returns {number} Value of property minWidth
*/
public getMinWidth(): number;
/**
* Gets content of aggregation {@link #getMultiLabels multiLabels}.
*
* Labels of the column which are displayed in the column header. Define a control for
* each header row in the table. Use this aggregation if you want to use multiple headers per column.
* @returns {sap.ui.core.Control[]}
*/
public getMultiLabels(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getName name}.
*
* The name of the column which is used in the column visibility menu item as text.
* If not set as a fallback the column menu tries to get the text from the nested Label.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets current value of property {@link #getResizable resizable}.
*
* If set to true, the column can be resized either using the resize bar (by mouse) or using
* the keyboard (SHIFT + Left/Right Arrow keys)
*
* Default value is true
.
* @returns {boolean} Value of property resizable
*/
public getResizable(): boolean;
/**
* Gets current value of property {@link #getShowFilterMenuEntry showFilterMenuEntry}.
*
* Defines if the filter menu entry is displayed
*
* Default value is true
.
* @returns {boolean} Value of property showFilterMenuEntry
*/
public getShowFilterMenuEntry(): boolean;
/**
* Gets current value of property {@link #getShowSortMenuEntry showSortMenuEntry}.
*
* Defines if the sort menu entries are displayed
*
* Default value is true
.
* @returns {boolean} Value of property showSortMenuEntry
*/
public getShowSortMenuEntry(): boolean;
/**
* Gets current value of property {@link #getSorted sorted}.
*
* Indicates if the column is sorted. This property only controls if a sort indicator is displayed in the
* column header - it does not trigger the sort function. The column has to be sorted by calling Column.sort()
*
* Default value is false
.
* @returns {boolean} Value of property sorted
*/
public getSorted(): boolean;
/**
* Gets current value of property {@link #getSortOrder sortOrder}.
*
* This property indicates the sort direction (Ascending or Descending). The corresponding icon will be
* rendered if the property sorted
is true
*
* Default value is Ascending
.
* @returns {sap.ui.table.SortOrder} Value of property sortOrder
*/
public getSortOrder(): sap.ui.table.SortOrder;
/**
* Gets current value of property {@link #getSortProperty sortProperty}.
*
* Specifies the binding property on which the column will sort.
* Since the column template may have composite bindings, it's not possible to figure out on which binding
* property the sort shall be applied. Therefore the binding property for sorting must be specified.
* For example, if the first name and last name are displayed in the same column, only one of the two can be defined as
* sortProperty
.
*
* A column menu entry for sorting can only be generated if the sortProperty
is set.
* @returns {string} Value of property sortProperty
*/
public getSortProperty(): string;
/**
* Gets content of aggregation {@link #getTemplate template}.
*
* Template (cell renderer) of this column. A template is decoupled from the column. Each time
* the template's properties or aggregations have been changed, the template has to be applied again via
* setTemplate
for the changes to take effect. The default template depends on the libraries loaded.
* @returns {sap.ui.core.Control}
*/
public getTemplate(): sap.ui.core.Control;
/**
* Returns a column template clone. It either finds an unused clone or clones a new one from the column template.
* @param {number} iIndex - Index of the column in the column aggregation of the table
* @returns {sap.ui.core.Control|null} Clone of the column template, or null
if no column template is defined
*/
protected getTemplateClone(iIndex: number): sap.ui.core.Control|null;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Invisible controls are not rendered.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the column in CSS units.
* Default value is auto
, see
*
Minimal column width is device-dependent, for example on desktop devices the column will not be smaller than 48px.
*
This property can be changed by the user or by the application configuration/personalization.
*
If a user adjusts the column width manually, the resulting value is always set in pixels.
* In addition, other columns with width auto
get a fixed minimum width and do not shrink after the resizing.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getMultiLabels multiLabels}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oMultiLabel - The multiLabel whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfMultiLabel(oMultiLabel: sap.ui.core.Control): number;
/**
* Inserts a multiLabel into the aggregation {@link #getMultiLabels multiLabels}.
* @param {sap.ui.core.Control} oMultiLabel - the multiLabel to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the multiLabel should be inserted at; for a negative value of iIndex
, the multiLabel is inserted at position 0; for a value greater than the current size of the aggregation, the multiLabel is inserted at the last position
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public insertMultiLabel(oMultiLabel: sap.ui.core.Control, iIndex: number): sap.ui.table.Column;
/**
* Removes all the controls from the aggregation {@link #getMultiLabels multiLabels}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllMultiLabels(): sap.ui.core.Control[];
/**
* Removes a multiLabel from the aggregation {@link #getMultiLabels multiLabels}.
* @param {number|string|sap.ui.core.Control} vMultiLabel - The multiLabel to remove or its index or id
* @returns {sap.ui.core.Control} The removed multiLabel or null
*/
public removeMultiLabel(vMultiLabel: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getAutoResizable autoResizable}.
*
* Enables auto-resizing of the column on double clicking the resize bar. The width is determined on the widest
* currently displayed content. It does not consider rows which are currently not scrolled into view.
* Currently only implemented to work with the following controls:
* sap.m.Text, sap.m.Label, sap.m.Link, sap.m.Input,
* sap.ui.commons.TextView, sap.ui.commons.Label, sap.ui.commons.Link and sap.ui.commons.TextField,
* sap.ui.commons.Checkbox, sap.m.Checkbox
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bAutoResizable - New value for property autoResizable
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setAutoResizable(bAutoResizable: boolean): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getDefaultFilterOperator defaultFilterOperator}.
*
* If this property is set, the default filter operator of the column is overridden.
* By default Contains
is used for string and EQ
for other types. A valid
* sap.ui.model.FilterOperator
needs to be passed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sDefaultFilterOperator - New value for property defaultFilterOperator
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setDefaultFilterOperator(sDefaultFilterOperator: string): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getFiltered filtered}.
*
* Indicates if the column is filtered. This property only controls if a filter indicator is displayed in the
* column header - it does not trigger the filter function. The column has to be filtered by calling Column.sort()
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bFiltered - New value for property filtered
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setFiltered(bFiltered: boolean): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getFilterOperator filterOperator}.
*
* Filter operator to use when filtering this column.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sFilterOperator - New value for property filterOperator
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setFilterOperator(sFilterOperator: string): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getFilterProperty filterProperty}.
*
* Specifies the binding property on which the column shall be filtered.
* Since the column template may have composite bindings, it's not possible to figure out on which binding
* property the filter shall be applied. Therefore the binding property for filtering must be specified.
* For example, if the first name and last name are displayed in the same column, only one of the two can be defined as
* filterProperty
.
*
* A column menu entry for filtering can only be generated if the filterProperty
is set. The
* default menu entry is a text input field.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sFilterProperty - New value for property filterProperty
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setFilterProperty(sFilterProperty: string): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getFilterType filterType}.
*
* Type of Filter. This is used to transform the search term to the specified type,
* to make sure that the right columns are displayed. This should be the same as defined
* in binding for this column. As an alternative you can pass a function which does the conversion.
* The function receives the entered filter value as parameter and returns the proper
* value for the filter expression. Another option is to pass the class name of the type,
* e.g.: sap.ui.model.type.Date
or an expression similar to the binding syntax,
* e.g.: "\{type: 'sap.ui.model.type.Date', formatOptions: \{UTC: true\}, constraints: \{\} \}"
.
* Here the escaping is mandatory to avoid handling by the binding parser.
* By default the filter type is sap.ui.model.type.String
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oFilterType - New value for property filterType
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setFilterType(oFilterType: any): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getFilterValue filterValue}.
*
* Specifies the value of the filter as string (will be converted into the proper data type). It is possible
* to provide a filterOperator as string, as shown here:
*
* > 50
* < 100
* >= 150
* <= 200
* = 250
* != 300
* something ends with
* something* starts with
* something* contains
* some..thing between
* 50..100 between
*
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sFilterValue - New value for property filterValue
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setFilterValue(sFilterValue: string): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getFlexible flexible}.
*
* If the table is wider than the sum of widths of the visible columns, the columns will be
* resized proportionally to their widths that were set originally. If set to false, the column will be displayed in the
* original width. If all columns are set to not be flexible, an extra "dummy" column will be
* created at the end of the table.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bFlexible - New value for property flexible
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setFlexible(bFlexible: boolean): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getGrouped grouped}.
*
* Indicates if the column is grouped.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bGrouped - New value for property grouped
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setGrouped(bGrouped: boolean): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getHAlign hAlign}.
*
* Horizontal alignment of the column content. Controls with a text align do not inherit
* the horizontal alignment. You have to set the text align directly on the template.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Begin
.
* @param {sap.ui.core.HorizontalAlign} sHAlign - New value for property hAlign
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setHAlign(sHAlign: sap.ui.core.HorizontalAlign): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getHeaderSpan headerSpan}.
*
* If this property is set, a span is applied for the header. When moving columns, all columns
* which are part of the header will be moved. The headerSpan
can be either an integer or an array of
* integers (if you use the multi header feature of the table). If you only specify an integer, this span is
* applied for all header rows, with multiple integers you can specify a separate span for each header row.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {any} oHeaderSpan - New value for property headerSpan
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setHeaderSpan(oHeaderSpan: any): sap.ui.table.Column;
/**
* Sets the aggregated {@link #getLabel label}.
* @param {sap.ui.core.Control|string} vLabel - The label to set
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setLabel(vLabel: sap.ui.core.Control|string): sap.ui.table.Column;
/**
* Sets the aggregated {@link #getMenu menu}.
* @param {sap.ui.unified.Menu} oMenu - The menu to set
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setMenu(oMenu: sap.ui.unified.Menu): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getMinWidth minWidth}.
*
* Defines the minimum width of a column in pixels.
* This property only has an effect if the given column width is flexible, for example with width auto
.
*
This property only influences the automatic behavior. If a user adjusts the column width manually, the column width can become
* smaller.
*
Minimal column width is device-dependent, for example on desktop devices the column will not be smaller than 48px.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iMinWidth - New value for property minWidth
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setMinWidth(iMinWidth: number): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getName name}.
*
* The name of the column which is used in the column visibility menu item as text.
* If not set as a fallback the column menu tries to get the text from the nested Label.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getResizable resizable}.
*
* If set to true, the column can be resized either using the resize bar (by mouse) or using
* the keyboard (SHIFT + Left/Right Arrow keys)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bResizable - New value for property resizable
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setResizable(bResizable: boolean): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getShowFilterMenuEntry showFilterMenuEntry}.
*
* Defines if the filter menu entry is displayed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowFilterMenuEntry - New value for property showFilterMenuEntry
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setShowFilterMenuEntry(bShowFilterMenuEntry: boolean): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getShowSortMenuEntry showSortMenuEntry}.
*
* Defines if the sort menu entries are displayed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowSortMenuEntry - New value for property showSortMenuEntry
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setShowSortMenuEntry(bShowSortMenuEntry: boolean): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getSorted sorted}.
*
* Indicates if the column is sorted. This property only controls if a sort indicator is displayed in the
* column header - it does not trigger the sort function. The column has to be sorted by calling Column.sort()
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSorted - New value for property sorted
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setSorted(bSorted: boolean): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getSortOrder sortOrder}.
*
* This property indicates the sort direction (Ascending or Descending). The corresponding icon will be
* rendered if the property sorted
is true
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Ascending
.
* @param {sap.ui.table.SortOrder} sSortOrder - New value for property sortOrder
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setSortOrder(sSortOrder: sap.ui.table.SortOrder): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getSortProperty sortProperty}.
*
* Specifies the binding property on which the column will sort.
* Since the column template may have composite bindings, it's not possible to figure out on which binding
* property the sort shall be applied. Therefore the binding property for sorting must be specified.
* For example, if the first name and last name are displayed in the same column, only one of the two can be defined as
* sortProperty
.
*
* A column menu entry for sorting can only be generated if the sortProperty
is set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sSortProperty - New value for property sortProperty
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setSortProperty(sSortProperty: string): sap.ui.table.Column;
/**
* Sets the aggregated {@link #getTemplate template}.
* @param {sap.ui.core.Control} oTemplate - The template to set
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setTemplate(oTemplate: sap.ui.core.Control): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Invisible controls are not rendered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.table.Column;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of the column in CSS units.
* Default value is auto
, see
*
Minimal column width is device-dependent, for example on desktop devices the column will not be smaller than 48px.
*
This property can be changed by the user or by the application configuration/personalization.
*
If a user adjusts the column width manually, the resulting value is always set in pixels.
* In addition, other columns with width auto
get a fixed minimum width and do not shrink after the resizing.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.table.Column} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.table.Column;
/**
* Returns whether the column should be rendered or not.
* @returns {boolean} true, if the column should be rendered
*/
protected shouldRender(): boolean;
/**
* sorts the current column ascending or descending
* @param {boolean} bDescending - sort order of the column (if undefined the default will be ascending)
* @returns {sap.ui.table.Column}
*/
public sort(bDescending: boolean): sap.ui.table.Column;
/**
* Toggles the sort order of the column.
* @returns {sap.ui.table.Column}
*/
public toggleSort(): sap.ui.table.Column;
}
/**
* The column menu provides all common actions that can be performed on a column.
*/
export class ColumnMenu extends sap.ui.unified.Menu {
/**
* Constructor for a new ColumnMenu.
*
* Note: Applications must not use or change the default sap.ui.table.ColumnMenu
of
* a column in any way or create own instances of sap.ui.table.ColumnMenu
.
* To add a custom menu to a column, use the aggregation menu
with a new instance of
* sap.ui.unified.Menu
.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.table.ColumnMenu with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.unified.Menu.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.table.ColumnMenu.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* Details about the group event to distinguish between different actions associated with grouping
*/
export enum GroupEventType {
/**
* Group Column
*/
group = "group",
/**
* Show grouped column only as group header
*/
hideGroupedColumn = "hideGroupedColumn",
/**
* Change the group order of the columns. Move column one position down in the group sequence
*/
moveDown = "moveDown",
/**
* Change the group order of the columns. Move column one position up in the group sequence
*/
moveUp = "moveUp",
/**
* Show grouped column also as a column, not just as group header
*/
showGroupedColumn = "showGroupedColumn",
/**
* Ungroup Column
*/
ungroup = "ungroup",
/**
* Ungroup All Columns
*/
ungroupAll = "ungroupAll",
}
/**
* Navigation mode of the table
*/
export enum NavigationMode {
/**
* Uses the paginator control.
* This option must no longer be used. Using a scrollbar is the only navigation mode which is supported by
* the sap.ui.table
library. The navigationMode
property has always been a visual representation. No matter which navigation mode
* is used, data fetched from an OData service is loaded page-wise.
*/
Paginator = "Paginator",
/**
* Uses the scrollbar control.
*/
Scrollbar = "Scrollbar",
}
/**
* The row.
*/
export class Row extends sap.ui.core.Element {
/**
* Constructor for a new Row.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some cell to the aggregation {@link #getCells cells}.
* @param {sap.ui.core.Control} oCell - the cell to add; if empty, nothing is inserted
* @returns {sap.ui.table.Row} Reference to this
in order to allow method chaining
*/
public addCell(oCell: sap.ui.core.Control): sap.ui.table.Row;
/**
* Destroys all the cells in the aggregation {@link #getCells cells}.
* @returns {sap.ui.table.Row} Reference to this
in order to allow method chaining
*/
public destroyCells(): sap.ui.table.Row;
/**
* Creates a new subclass of class sap.ui.table.Row with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getCells cells}.
*
* The controls for the cells.
* @returns {sap.ui.core.Control[]}
*/
public getCells(): sap.ui.core.Control[];
/**
* Returns the index of the row in the table or -1 if not added to a table. This
* function considers the scroll position of the table and also takes fixed rows and
* fixed bottom rows into account.
* @returns {number} index of the row (considers scroll position and fixed rows)
*/
public getIndex(): number;
/**
* Returns a metadata object for class sap.ui.table.Row.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getCells cells}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oCell - The cell whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfCell(oCell: sap.ui.core.Control): number;
/**
* Inserts a cell into the aggregation {@link #getCells cells}.
* @param {sap.ui.core.Control} oCell - the cell to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the cell should be inserted at; for a negative value of iIndex
, the cell is inserted at position 0; for a value greater than the current size of the aggregation, the cell is inserted at the last position
* @returns {sap.ui.table.Row} Reference to this
in order to allow method chaining
*/
public insertCell(oCell: sap.ui.core.Control, iIndex: number): sap.ui.table.Row;
/**
* Removes all the controls from the aggregation {@link #getCells cells}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllCells(): sap.ui.core.Control[];
/**
* Removes a cell from the aggregation {@link #getCells cells}.
* @param {number|string|sap.ui.core.Control} vCell - The cell to remove or its index or id
* @returns {sap.ui.core.Control} The removed cell or null
*/
public removeCell(vCell: number|string|sap.ui.core.Control): sap.ui.core.Control;
}
/**
* The RowAction
control allows to display multiple action items which can be selected by the user.
* If more action items are available as the available space allows to display an overflow mechanism is provided.
* This control must only be used in the context of the sap.ui.table.Table
control to define row actions.
*/
export class RowAction extends sap.ui.core.Control {
/**
* Constructor for a new RowAction.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.ui.table.RowActionItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.ui.table.RowAction} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.ui.table.RowActionItem): sap.ui.table.RowAction;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.ui.table.RowAction} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.ui.table.RowAction;
/**
* Creates a new subclass of class sap.ui.table.RowAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getItems items}.
*
* The action items which should be displayed.
* @returns {sap.ui.table.RowActionItem[]}
*/
public getItems(): sap.ui.table.RowActionItem[];
/**
* Returns a metadata object for class sap.ui.table.RowAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Whether the control should be visible on the screen. If set to false
, the control is hidden.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Checks for the provided sap.ui.table.RowActionItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.table.RowActionItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.table.RowActionItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.ui.table.RowActionItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.ui.table.RowAction} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.ui.table.RowActionItem, iIndex: number): sap.ui.table.RowAction;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.table.RowActionItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.ui.table.RowActionItem[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.ui.table.RowActionItem} vItem - The item to remove or its index or id
* @returns {sap.ui.table.RowActionItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.ui.table.RowActionItem): sap.ui.table.RowActionItem;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Whether the control should be visible on the screen. If set to false
, the control is hidden.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.ui.table.RowAction} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.table.RowAction;
}
/**
* An action items to be displayed in a RowAction
control.
* This element must only be used in the context of the sap.ui.table.Table
control to define row actions.
*/
export class RowActionItem extends sap.ui.core.Element {
/**
* Constructor for a new RowActionItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.table.RowActionItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.RowActionItem
itself.
*
* The press
is fired when the user triggers the corresponding action.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.RowActionItem
itself
* @returns {sap.ui.table.RowActionItem} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.ui.table.RowActionItem;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.table.RowActionItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.RowActionItem
itself.
*
* The press
is fired when the user triggers the corresponding action.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.RowActionItem
itself
* @returns {sap.ui.table.RowActionItem} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.RowActionItem;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.ui.table.RowActionItem
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.RowActionItem} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.ui.table.RowActionItem;
/**
* Creates a new subclass of class sap.ui.table.RowActionItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.table.RowActionItem} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.ui.table.RowActionItem;
/**
* Gets current value of property {@link #getIcon icon}.
*
* The icon of the item.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.ui.table.RowActionItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* The text of the item. It is used as tooltip and for accessibility purposes.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getType type}.
*
* The type of the item.
* Setting the type ensures default values for the properties icon
and text
.
* If an icon or text is set explicitly this setting is used.
*
* Default value is Custom
.
* @returns {sap.ui.table.RowActionType} Value of property type
*/
public getType(): sap.ui.table.RowActionType;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Whether the item should be visible on the screen.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* The icon of the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.table.RowActionItem} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.table.RowActionItem;
/**
* Sets a new value for property {@link #getText text}.
*
* The text of the item. It is used as tooltip and for accessibility purposes.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sText - New value for property text
* @returns {sap.ui.table.RowActionItem} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.table.RowActionItem;
/**
* Sets a new value for property {@link #getType type}.
*
* The type of the item.
* Setting the type ensures default values for the properties icon
and text
.
* If an icon or text is set explicitly this setting is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Custom
.
* @param {sap.ui.table.RowActionType} sType - New value for property type
* @returns {sap.ui.table.RowActionItem} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.ui.table.RowActionType): sap.ui.table.RowActionItem;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Whether the item should be visible on the screen.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.ui.table.RowActionItem} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.table.RowActionItem;
}
/**
* Row Action types.
*/
export enum RowActionType {
/**
* Custom defined Row Action.
*/
Custom = "Custom",
/**
* Delete Row Action.
*/
Delete = "Delete",
/**
* Navigation Row Action.
*/
Navigation = "Navigation",
}
/**
* The RowSettings
control allows you to configure a row.
* You can only use this control in the context of the sap.ui.table.Table
control to define row settings.
*/
export class RowSettings extends sap.ui.core.Element {
/**
* Constructor for new RowSettings.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new element, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.table.RowSettings with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getHighlight highlight}.
*
* The highlight state of the rows.
* If the highlight is set to {@link sap.ui.core.MessageType.None} (default), no highlights are visible.
*
* Default value is None
.
* @returns {sap.ui.core.MessageType} Value of property highlight
*/
public getHighlight(): sap.ui.core.MessageType;
/**
* Returns a metadata object for class sap.ui.table.RowSettings.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets a new value for property {@link #getHighlight highlight}.
*
* The highlight state of the rows.
* If the highlight is set to {@link sap.ui.core.MessageType.None} (default), no highlights are visible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.MessageType} sHighlight - New value for property highlight
* @returns {sap.ui.table.RowSettings} Reference to this
in order to allow method chaining
*/
public setHighlight(sHighlight: sap.ui.core.MessageType): sap.ui.table.RowSettings;
}
/**
* Selection behavior of the table
*/
export enum SelectionBehavior {
/**
* Rows can be selected on the complete row.
*/
Row = "Row",
/**
* Rows can only be selected on the row (and the selector is hidden).
*/
RowOnly = "RowOnly",
/**
* Rows can only be selected on the row selector.
*/
RowSelector = "RowSelector",
}
/**
* Selection mode of the table
*/
export enum SelectionMode {
/**
* Select multiple rows at a time.
*/
Multi = "Multi",
/**
* Select multiple rows at a time (toggle behavior).
*/
MultiToggle = "MultiToggle",
/**
* No rows can be selected.
*/
None = "None",
/**
* Select one row at a time.
*/
Single = "Single",
}
/**
* Shared DOM Reference IDs of the table.
*
* Contains IDs of shared DOM references, which should be accessible to inheriting controls via getDomRef() function.
*/
export enum SharedDomRef {
/**
* The element id of the Horizontal Scroll Bar of the sap.ui.table.Table.
*/
HorizontalScrollBar = "HorizontalScrollBar",
/**
* The element id of the Vertical Scroll Bar of the sap.ui.table.Table.
*/
VerticalScrollBar = "VerticalScrollBar",
}
/**
* Sort order of a column
*/
export enum SortOrder {
/**
* Sort Order: ascending.
*/
Ascending = "Ascending",
/**
* Sort Order: descending.
*/
Descending = "Descending",
}
/**
*
* Provides a comprehensive set of features for displaying and dealing with vast amounts of data. The Table control supports
* desktop PCs and tablet devices. On tablets, special consideration should be given to the number of visible columns
* and rows due to the limited performance of some devices.
*
*
* In order to keep the document DOM as lean as possible, the Table control reuses its DOM elements of the rows.
* When the user scrolls, only the row contexts are changed but the rendered controls remain the same. This allows
* the Table control to handle huge amounts of data. Nevertheless, restrictions apply regarding the number of displayed
* columns. Keep the number as low as possible to improve performance. Due to the nature of tables, the used
* control for column templates also has a big influence on the performance.
*
*
* The Table control relies completely on data binding, and its supported feature set is tightly coupled to
* the data model and binding being used.
*
*/
export class Table extends sap.ui.core.Control {
/**
* Constructor for a new Table.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.table.Table;
/**
* Adds some column to the aggregation {@link #getColumns columns}.
* @param {sap.ui.table.Column} oColumn - the column to add; if empty, nothing is inserted
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public addColumn(oColumn: sap.ui.table.Column): sap.ui.table.Table;
/**
* Adds some extension to the aggregation {@link #getExtension extension}.
* @param {sap.ui.core.Control} oExtension - the extension to add; if empty, nothing is inserted
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public addExtension(oExtension: sap.ui.core.Control): sap.ui.table.Table;
/**
* Adds some row to the aggregation {@link #getRows rows}.
* @param {sap.ui.table.Row} oRow - the row to add; if empty, nothing is inserted
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public addRow(oRow: sap.ui.table.Row): sap.ui.table.Table;
/**
* Adds the given selection interval to the selection. In case of single selection the "indexTo" value will be used for as selected index.
* @param {number} iIndexFrom - Index from which .
* @param {number} iIndexTo - Indices of the items that shall additionally be selected.
* @returns {sap.ui.table.Table}
*/
public addSelectionInterval(iIndexFrom: number, iIndexTo: number): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:busyStateChanged busyStateChanged} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* This event gets fired when the busy state of the table changes. It should only be used by composite controls.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachBusyStateChanged(fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:busyStateChanged busyStateChanged} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* This event gets fired when the busy state of the table changes. It should only be used by composite controls.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachBusyStateChanged(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:cellClick cellClick} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when the user clicks a cell of the table (experimental!).
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachCellClick(fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:cellClick cellClick} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when the user clicks a cell of the table (experimental!).
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachCellClick(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:cellContextmenu cellContextmenu} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when the user clicks a cell of the table.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachCellContextmenu(fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:cellContextmenu cellContextmenu} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when the user clicks a cell of the table.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachCellContextmenu(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:columnFreeze columnFreeze} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when a column of the table should be freezed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachColumnFreeze(fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:columnFreeze columnFreeze} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when a column of the table should be freezed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachColumnFreeze(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:columnMove columnMove} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when a table column is moved.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachColumnMove(fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:columnMove columnMove} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when a table column is moved.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachColumnMove(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:columnResize columnResize} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when a table column is resized.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachColumnResize(fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:columnResize columnResize} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when a table column is resized.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachColumnResize(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:columnSelect columnSelect} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when a column of the table has been selected
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachColumnSelect(fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:columnSelect columnSelect} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when a column of the table has been selected
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachColumnSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:columnVisibility columnVisibility} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when the visibility of a table column is changed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachColumnVisibility(fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:columnVisibility columnVisibility} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when the visibility of a table column is changed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachColumnVisibility(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:customFilter customFilter} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* This event is triggered when the custom filter item of the column menu is pressed. The column on which the event was triggered is
* passed as parameter.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachCustomFilter(fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:customFilter customFilter} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* This event is triggered when the custom filter item of the column menu is pressed. The column on which the event was triggered is
* passed as parameter.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachCustomFilter(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:filter filter} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when the table is filtered.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachFilter(fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:filter filter} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when the table is filtered.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachFilter(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:firstVisibleRowChanged firstVisibleRowChanged} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* This event gets fired when the first visible row is changed. It should only be used by composite controls.
* The event even is fired when setFirstVisibleRow is called programmatically.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachFirstVisibleRowChanged(fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:firstVisibleRowChanged firstVisibleRowChanged} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* This event gets fired when the first visible row is changed. It should only be used by composite controls.
* The event even is fired when setFirstVisibleRow is called programmatically.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachFirstVisibleRowChanged(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:group group} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when the table is grouped (experimental!).
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachGroup(fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:group group} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when the table is grouped (experimental!).
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachGroup(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:rowSelectionChange rowSelectionChange} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when the row selection of the table has been changed (the event parameters can be used to determine
* selection changes - to find out the selected rows you should better use the table selection API)
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachRowSelectionChange(fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:rowSelectionChange rowSelectionChange} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when the row selection of the table has been changed (the event parameters can be used to determine
* selection changes - to find out the selected rows you should better use the table selection API)
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachRowSelectionChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:sort sort} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when the table is sorted.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachSort(fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Attaches event handler fnFunction
to the {@link #event:sort sort} event of this sap.ui.table.Table
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.Table
itself.
*
* fired when the table is sorted.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.Table
itself
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public attachSort(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.Table;
/**
* Triggers automatic resizing of a column to the widest content.
* @param {number} iColIndex - The index of the column in the list of visible columns.
*/
public autoResizeColumn(iColIndex: number): void;
/**
* Binds aggregation {@link #getColumns columns} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public bindColumns(oBindingInfo: any): sap.ui.table.Table;
/**
* Binds aggregation {@link #getRows rows} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public bindRows(oBindingInfo: any): sap.ui.table.Table;
/**
* Removes complete selection.
* @returns {sap.ui.table.Table}
*/
public clearSelection(): sap.ui.table.Table;
/**
* Destroys all the columns in the aggregation {@link #getColumns columns}.
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public destroyColumns(): sap.ui.table.Table;
/**
* Destroys all the extension in the aggregation {@link #getExtension extension}.
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public destroyExtension(): sap.ui.table.Table;
/**
* Destroys the footer in the aggregation {@link #getFooter footer}.
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public destroyFooter(): sap.ui.table.Table;
/**
* Destroys the noData in the aggregation {@link #getNoData noData}.
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public destroyNoData(): sap.ui.table.Table;
/**
* Destroys the rowActionTemplate in the aggregation {@link #getRowActionTemplate rowActionTemplate}.
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public destroyRowActionTemplate(): sap.ui.table.Table;
/**
* Destroys all the rows in the aggregation {@link #getRows rows}.
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public destroyRows(): sap.ui.table.Table;
/**
* Destroys the rowSettingsTemplate in the aggregation {@link #getRowSettingsTemplate rowSettingsTemplate}.
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public destroyRowSettingsTemplate(): sap.ui.table.Table;
/**
* Destroys the title in the aggregation {@link #getTitle title}.
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public destroyTitle(): sap.ui.table.Table;
/**
* Destroys the toolbar in the aggregation {@link #getToolbar toolbar}.
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public destroyToolbar(): sap.ui.table.Table;
/**
* Detaches event handler fnFunction
from the {@link #event:busyStateChanged busyStateChanged} event of this sap.ui.table.Table
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public detachBusyStateChanged(fnFunction: Function, oListener: any): sap.ui.table.Table;
/**
* Detaches event handler fnFunction
from the {@link #event:cellClick cellClick} event of this sap.ui.table.Table
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public detachCellClick(fnFunction: Function, oListener: any): sap.ui.table.Table;
/**
* Detaches event handler fnFunction
from the {@link #event:cellContextmenu cellContextmenu} event of this sap.ui.table.Table
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public detachCellContextmenu(fnFunction: Function, oListener: any): sap.ui.table.Table;
/**
* Detaches event handler fnFunction
from the {@link #event:columnFreeze columnFreeze} event of this sap.ui.table.Table
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public detachColumnFreeze(fnFunction: Function, oListener: any): sap.ui.table.Table;
/**
* Detaches event handler fnFunction
from the {@link #event:columnMove columnMove} event of this sap.ui.table.Table
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public detachColumnMove(fnFunction: Function, oListener: any): sap.ui.table.Table;
/**
* Detaches event handler fnFunction
from the {@link #event:columnResize columnResize} event of this sap.ui.table.Table
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public detachColumnResize(fnFunction: Function, oListener: any): sap.ui.table.Table;
/**
* Detaches event handler fnFunction
from the {@link #event:columnSelect columnSelect} event of this sap.ui.table.Table
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public detachColumnSelect(fnFunction: Function, oListener: any): sap.ui.table.Table;
/**
* Detaches event handler fnFunction
from the {@link #event:columnVisibility columnVisibility} event of this sap.ui.table.Table
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public detachColumnVisibility(fnFunction: Function, oListener: any): sap.ui.table.Table;
/**
* Detaches event handler fnFunction
from the {@link #event:customFilter customFilter} event of this sap.ui.table.Table
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public detachCustomFilter(fnFunction: Function, oListener: any): sap.ui.table.Table;
/**
* Detaches event handler fnFunction
from the {@link #event:filter filter} event of this sap.ui.table.Table
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public detachFilter(fnFunction: Function, oListener: any): sap.ui.table.Table;
/**
* Detaches event handler fnFunction
from the {@link #event:firstVisibleRowChanged firstVisibleRowChanged} event of this sap.ui.table.Table
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public detachFirstVisibleRowChanged(fnFunction: Function, oListener: any): sap.ui.table.Table;
/**
* Detaches event handler fnFunction
from the {@link #event:group group} event of this sap.ui.table.Table
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public detachGroup(fnFunction: Function, oListener: any): sap.ui.table.Table;
/**
* Detaches event handler fnFunction
from the {@link #event:rowSelectionChange rowSelectionChange} event of this sap.ui.table.Table
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public detachRowSelectionChange(fnFunction: Function, oListener: any): sap.ui.table.Table;
/**
* Detaches event handler fnFunction
from the {@link #event:sort sort} event of this sap.ui.table.Table
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public detachSort(fnFunction: Function, oListener: any): sap.ui.table.Table;
/**
* Creates a new {@link sap.ui.core.util.Export} object and fills row/column information from the table if not provided. For the cell content,
* the column's "sortProperty" will be used (experimental!)
*
* Please note: The return value was changed from jQuery Promises to standard ES6 Promises.
* jQuery specific Promise methods ('done', 'fail', 'always', 'pipe' and 'state') are still available but should not be used.
* Please use only the standard methods 'then' and 'catch'!
* @param {any} mSettings - settings for the new Export, see {@link sap.ui.core.util.Export} constructor
* @returns {Promise} Promise object
*/
public exportData(mSettings?: any): Promise;
/**
* Creates a new subclass of class sap.ui.table.Table with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Filter the given column by the given value.
* @param {sap.ui.table.Column} oColumn - column to be filtered
* @param {string} sValue - filter value as string (will be converted)
* @returns {sap.ui.table.Table}
*/
public filter(oColumn: sap.ui.table.Column, sValue: string): sap.ui.table.Table;
/**
* Fires event {@link #event:busyStateChanged busyStateChanged} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
protected fireBusyStateChanged(mParameters?: any): sap.ui.table.Table;
/**
* Fires event {@link #event:cellClick cellClick} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireCellClick(mParameters?: any): boolean;
/**
* Fires event {@link #event:cellContextmenu cellContextmenu} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireCellContextmenu(mParameters?: any): boolean;
/**
* Fires event {@link #event:columnFreeze columnFreeze} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireColumnFreeze(mParameters?: any): boolean;
/**
* Fires event {@link #event:columnMove columnMove} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireColumnMove(mParameters?: any): boolean;
/**
* Fires event {@link #event:columnResize columnResize} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireColumnResize(mParameters?: any): boolean;
/**
* Fires event {@link #event:columnSelect columnSelect} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireColumnSelect(mParameters?: any): boolean;
/**
* Fires event {@link #event:columnVisibility columnVisibility} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireColumnVisibility(mParameters?: any): boolean;
/**
* Fires event {@link #event:customFilter customFilter} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
protected fireCustomFilter(mParameters?: any): sap.ui.table.Table;
/**
* Fires event {@link #event:filter filter} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireFilter(mParameters?: any): boolean;
/**
* Fires event {@link #event:firstVisibleRowChanged firstVisibleRowChanged} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
protected fireFirstVisibleRowChanged(mParameters?: any): sap.ui.table.Table;
/**
* Fires event {@link #event:group group} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireGroup(mParameters?: any): boolean;
/**
* Fires event {@link #event:rowSelectionChange rowSelectionChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
protected fireRowSelectionChange(mParameters?: any): sap.ui.table.Table;
/**
* Fires event {@link #event:sort sort} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireSort(mParameters?: any): boolean;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Returns the control inside the cell with the given row index (in the rows
aggregation)
* and column index (in the columns
aggregation or in the list of visible columns only, depending on
* parameter bVisibleColumnIndex
).
* @param {number} iRowIndex - Index of row in the table's rows
aggregation
* @param {number} iColumnIndex - Index of column in the list of visible columns or in the columns
aggregation, as indicated with bVisibleColumnIndex
* @param {boolean} bVisibleColumnIndex - If set to true
, the given column index is interpreted as index in the list of visible columns, otherwise as index in the columns
aggregation
* @returns {sap.ui.core.Control} Control inside the cell with the given row and column index or null
if no such control exists
*/
protected getCellControl(iRowIndex: number, iColumnIndex: number, bVisibleColumnIndex: boolean): sap.ui.core.Control;
/**
* Gets current value of property {@link #getColumnHeaderHeight columnHeaderHeight}.
*
* Height of the column header of the Table in pixel.
* @returns {number} Value of property columnHeaderHeight
*/
public getColumnHeaderHeight(): number;
/**
* Gets current value of property {@link #getColumnHeaderVisible columnHeaderVisible}.
*
* Flag whether the column header is visible or not.
*
* Default value is true
.
* @returns {boolean} Value of property columnHeaderVisible
*/
public getColumnHeaderVisible(): boolean;
/**
* Gets content of aggregation {@link #getColumns columns}.
*
* Columns of the Table
* @returns {sap.ui.table.Column[]}
*/
public getColumns(): sap.ui.table.Column[];
/**
* Returns the context of a row by its index. Please note that for server-based models like OData,
* the supplied index might not have been loaded yet. If the context is not available at the client,
* the binding will trigger a backend request and request this single context. Although this API
* looks synchronous it may not return a context but load it and fire a change event on the binding.
*
* For server-based models you should consider to only make this API call when the index is within
* the currently visible scroll area.
* @param {number} iIndex - Index of the row to return the context from.
* @returns {any}
*/
public getContextByIndex(iIndex: number): any;
/**
* Gets current value of property {@link #getEditable editable}.
*
* Flag whether the controls of the Table are editable or not (currently this only controls the background color in certain themes!)
*
* Default value is true
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets current value of property {@link #getEnableBusyIndicator enableBusyIndicator}.
*
* If set to true
, the table changes its busy state, resulting in showing or hiding the busy indicator.
* The table will switch to busy as soon as data is retrieved to be displayed in the currently visible rows. This happens,
* for example, during scrolling, filtering, or sorting. As soon as the data has been retrieved, the table switches back to not busy.
* The busy state of the table can still be set manually by calling {@link sap.ui.core.Control#setBusy}.
*
* Default value is false
.
* @returns {boolean} Value of property enableBusyIndicator
*/
public getEnableBusyIndicator(): boolean;
/**
* Gets current value of property {@link #getEnableCellFilter enableCellFilter}.
*
* Flag whether to enable or disable the context menu on cells to trigger a filtering with the cell value.
*
* Default value is false
.
* @returns {boolean} Value of property enableCellFilter
*/
public getEnableCellFilter(): boolean;
/**
* Gets current value of property {@link #getEnableColumnFreeze enableColumnFreeze}.
*
* Flag whether to show or hide the column menu item to freeze or unfreeze a column.
*
* Default value is false
.
* @returns {boolean} Value of property enableColumnFreeze
*/
public getEnableColumnFreeze(): boolean;
/**
* Gets current value of property {@link #getEnableColumnReordering enableColumnReordering}.
*
* Flag to enable or disable column reordering
*
* Default value is true
.
* @returns {boolean} Value of property enableColumnReordering
*/
public getEnableColumnReordering(): boolean;
/**
* Gets current value of property {@link #getEnableCustomFilter enableCustomFilter}.
*
* Set this parameter to true to implement your own filter behaviour. Instead of the filter input box a button
* will be rendered for which' press event (customFilter) you can register an event handler.
*
* Default value is false
.
* @returns {boolean} Value of property enableCustomFilter
*/
public getEnableCustomFilter(): boolean;
/**
* Gets current value of property {@link #getEnableGrouping enableGrouping}.
*
* Flag to enable or disable column grouping. (experimental!)
*
* Default value is false
.
* @returns {boolean} Value of property enableGrouping
*/
public getEnableGrouping(): boolean;
/**
* Gets current value of property {@link #getEnableSelectAll enableSelectAll}.
*
* Specifies if a select all button should be displayed in the top left corner. This button is only displayed
* if the row selector is visible and the selection mode is set to any kind of multi selection.
*
* Default value is true
.
* @returns {boolean} Value of property enableSelectAll
*/
public getEnableSelectAll(): boolean;
/**
* Gets content of aggregation {@link #getExtension extension}.
*
* Extension section of the Table (if not set it will be hidden)
* @returns {sap.ui.core.Control[]}
*/
public getExtension(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getFirstVisibleRow firstVisibleRow}.
*
* First visible row.
*
* Default value is 0
.
* @returns {number} Value of property firstVisibleRow
*/
public getFirstVisibleRow(): number;
/**
* Gets current value of property {@link #getFixedBottomRowCount fixedBottomRowCount}.
*
* Number of rows that are fix on the bottom. When you use a vertical scroll bar, only the rows which are not fixed, will scroll.
*
* Default value is 0
.
* @returns {number} Value of property fixedBottomRowCount
*/
public getFixedBottomRowCount(): number;
/**
* Gets current value of property {@link #getFixedColumnCount fixedColumnCount}.
*
* Number of columns that are fix on the left. When you use a horizontal scroll bar, only
* the columns which are not fixed, will scroll. Fixed columns need a defined width for the feature to work.
* Please note that the aggregated width of all fixed columns must not exceed the table width since there
* will be no scrollbar for fixed columns.
*
* Default value is 0
.
* @returns {number} Value of property fixedColumnCount
*/
public getFixedColumnCount(): number;
/**
* Gets current value of property {@link #getFixedRowCount fixedRowCount}.
*
* Number of rows that are fix on the top. When you use a vertical scroll bar, only the rows which are not fixed, will scroll.
*
* Default value is 0
.
* @returns {number} Value of property fixedRowCount
*/
public getFixedRowCount(): number;
/**
* Gets content of aggregation {@link #getFooter footer}.
*
* Control or text of footer section of the Table (if not set it will be hidden)
* @returns {sap.ui.core.Control|string}
*/
public getFooter(): sap.ui.core.Control|string;
/**
* ID of the element which is the current target of the association {@link #getGroupBy groupBy}, or null
.
* @returns {sap.ui.core.ID}
*/
public getGroupBy(): sap.ui.core.ID;
/**
* Returns a metadata object for class sap.ui.table.Table.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinAutoRowCount minAutoRowCount}.
*
* This property is used to set the minimum count of visible rows when the property visibleRowCountMode is set to Auto or Interactive.
* For any other visibleRowCountMode, it is ignored.
*
* Default value is 5
.
* @returns {number} Value of property minAutoRowCount
*/
public getMinAutoRowCount(): number;
/**
* Gets current value of property {@link #getNavigationMode navigationMode}.
*
* This property has been deprecated and must not be used anymore, since Scrollbar
is the only supported option.
*
* Default value is Scrollbar
.
* @returns {sap.ui.table.NavigationMode} Value of property navigationMode
*/
public getNavigationMode(): sap.ui.table.NavigationMode;
/**
* Gets content of aggregation {@link #getNoData noData}.
*
* The value for the noData aggregation can be either a string value or a control instance.
* The control is shown, in case there is no data for the Table available. In case of a string
* value this will simply replace the no data text.
* @returns {sap.ui.core.Control|string}
*/
public getNoData(): sap.ui.core.Control|string;
/**
* Gets current value of property {@link #getRowActionCount rowActionCount}.
*
* Number of row actions made visible which determines the width of the row action column.
* The values 0
, 1
and 2
are possible.
*
* Default value is 0
.
* @returns {number} Value of property rowActionCount
*/
public getRowActionCount(): number;
/**
* Gets content of aggregation {@link #getRowActionTemplate rowActionTemplate}.
*
* Template for row actions. A template is decoupled from the row or table. Each time
* the template's properties or aggregations are changed, the template has to be applied again via
* setRowActionTemplate
for the changes to take effect.
* @returns {sap.ui.table.RowAction}
*/
public getRowActionTemplate(): sap.ui.table.RowAction;
/**
* Gets current value of property {@link #getRowHeight rowHeight}.
*
* Height of a row of the Table in pixel.
* @returns {number} Value of property rowHeight
*/
public getRowHeight(): number;
/**
* Gets content of aggregation {@link #getRows rows}.
*
* Rows of the Table
* @returns {sap.ui.table.Row[]}
*/
public getRows(): sap.ui.table.Row[];
/**
* Gets content of aggregation {@link #getRowSettingsTemplate rowSettingsTemplate}.
*
* Template for row settings. A template is decoupled from the row or table. Each time
* the template's properties or aggregations are changed, the template has to be applied again via
* setRowSettingsTemplate
for the changes to take effect.
* @returns {sap.ui.table.RowSettings}
*/
public getRowSettingsTemplate(): sap.ui.table.RowSettings;
/**
* Gets current value of property {@link #getSelectedIndex selectedIndex}.
*
* Zero-based index of selected item. Index value for no selection is -1.
* When multi-selection is enabled and multiple items are selected, the method returns
* the lead selected item. Sets the zero-based index of the currently selected item. This method
* removes any previous selections. When the given index is invalid, the call is ignored.
*
* Default value is -1
.
* @returns {number} Value of property selectedIndex
*/
public getSelectedIndex(): number;
/**
* Zero-based indices of selected items, wrapped in an array. An empty array means "no selection".
* @returns {any} int[]
*/
public getSelectedIndices(): any;
/**
* Gets current value of property {@link #getSelectionBehavior selectionBehavior}.
*
* Selection behavior of the Table. This property defines whether the row selector is displayed and whether the row, the row selector or
* both can be clicked to select a row.
*
* Default value is RowSelector
.
* @returns {sap.ui.table.SelectionBehavior} Value of property selectionBehavior
*/
public getSelectionBehavior(): sap.ui.table.SelectionBehavior;
/**
* Gets current value of property {@link #getSelectionMode selectionMode}.
*
* Selection mode of the Table. This property controls whether single or multiple rows can be selected and
* how the selection can be extended. It may also influence the visual appearance.
*
* Default value is MultiToggle
.
* @returns {sap.ui.table.SelectionMode} Value of property selectionMode
*/
public getSelectionMode(): sap.ui.table.SelectionMode;
/**
* Gets current value of property {@link #getShowColumnVisibilityMenu showColumnVisibilityMenu}.
*
* Flag to show or hide the column visibility menu. This menu will get displayed in each
* generated column header menu. It allows to show or hide columns
*
* Default value is false
.
* @returns {boolean} Value of property showColumnVisibilityMenu
*/
public getShowColumnVisibilityMenu(): boolean;
/**
* Gets current value of property {@link #getShowNoData showNoData}.
*
* Flag whether to show the no data overlay or not once the table is empty. If set to false
* the table will just show a grid of empty cells
*
* Default value is true
.
* @returns {boolean} Value of property showNoData
*/
public getShowNoData(): boolean;
/**
* Gets current value of property {@link #getShowOverlay showOverlay}.
*
* Setting this property to true will show an overlay on top of the Table content and users cannot click anymore on the Table content.
*
* Default value is false
.
* @returns {boolean} Value of property showOverlay
*/
public getShowOverlay(): boolean;
/**
* Gets sorted columns in the order of which the sort API at the table or column was called.
* Sorting on binding level is not reflected here.
* @returns {any} Array of sorted columns
*/
public getSortedColumns(): any;
/**
* Gets current value of property {@link #getThreshold threshold}.
*
* The threshold
defines how many additional (not yet visible records) shall be pre-fetched to enable smooth
* scrolling. The threshold is always added to the visibleRowCount
. If the visibleRowCount
is 10 and the
* threshold
is 100, there will be 110 records fetched with the initial load.
* If the threshold
is lower than the visibleRowCount
, the visibleRowCount
will be used as
* the threshold
. If the value is 0 then the thresholding is disabled.
*
* Default value is 100
.
* @returns {number} Value of property threshold
*/
public getThreshold(): number;
/**
* Gets content of aggregation {@link #getTitle title}.
*
* Control or text of title section of the Table (if not set it will be hidden)
* @returns {sap.ui.core.Control|string}
*/
public getTitle(): sap.ui.core.Control|string;
/**
* Gets content of aggregation {@link #getToolbar toolbar}.
*
* Toolbar of the Table (if not set it will be hidden)
* @returns {sap.ui.core.Toolbar}
*/
public getToolbar(): sap.ui.core.Toolbar;
/**
* Gets current value of property {@link #getVisibleRowCount visibleRowCount}.
*
* Number of visible rows of the table.
*
* Default value is 10
.
* @returns {number} Value of property visibleRowCount
*/
public getVisibleRowCount(): number;
/**
* Gets current value of property {@link #getVisibleRowCountMode visibleRowCountMode}.
*
* This defines how the table handles the visible rows in the table. The default behavior is,
* that a fixed row count is defined. If you change it to auto the visibleRowCount property is
* changed by the table automatically. It will then adjust its maximum row count to the space it is
* allowed to cover (limited by the surrounding container) and its minimum row count to the value of
* the property minAutoRowCount (default value : 5) In manual mode the user can change
* the visibleRowCount interactively.
*
* Default value is Fixed
.
* @returns {sap.ui.table.VisibleRowCountMode} Value of property visibleRowCountMode
*/
public getVisibleRowCountMode(): sap.ui.table.VisibleRowCountMode;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the Table.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.table.Column
in the aggregation {@link #getColumns columns}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.table.Column} oColumn - The column whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfColumn(oColumn: sap.ui.table.Column): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getExtension extension}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oExtension - The extension whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfExtension(oExtension: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.table.Row
in the aggregation {@link #getRows rows}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.table.Row} oRow - The row whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfRow(oRow: sap.ui.table.Row): number;
/**
* Inserts a column into the aggregation {@link #getColumns columns}.
* @param {sap.ui.table.Column} oColumn - the column to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the column should be inserted at; for a negative value of iIndex
, the column is inserted at position 0; for a value greater than the current size of the aggregation, the column is inserted at the last position
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public insertColumn(oColumn: sap.ui.table.Column, iIndex: number): sap.ui.table.Table;
/**
* Inserts a extension into the aggregation {@link #getExtension extension}.
* @param {sap.ui.core.Control} oExtension - the extension to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the extension should be inserted at; for a negative value of iIndex
, the extension is inserted at position 0; for a value greater than the current size of the aggregation, the extension is inserted at the last position
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public insertExtension(oExtension: sap.ui.core.Control, iIndex: number): sap.ui.table.Table;
/**
* Inserts a row into the aggregation {@link #getRows rows}.
* @param {sap.ui.table.Row} oRow - the row to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the row should be inserted at; for a negative value of iIndex
, the row is inserted at position 0; for a value greater than the current size of the aggregation, the row is inserted at the last position
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public insertRow(oRow: sap.ui.table.Row, iIndex: number): sap.ui.table.Table;
/**
* Returns whether the given index is selected.
* @param {number} iIndex - Index which is checked for selection state.
* @returns {boolean}
*/
public isIndexSelected(iIndex: number): boolean;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getColumns columns}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.table.Column[]} An array of the removed elements (might be empty)
*/
public removeAllColumns(): sap.ui.table.Column[];
/**
* Removes all the controls from the aggregation {@link #getExtension extension}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllExtension(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getRows rows}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.table.Row[]} An array of the removed elements (might be empty)
*/
public removeAllRows(): sap.ui.table.Row[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a column from the aggregation {@link #getColumns columns}.
* @param {number|string|sap.ui.table.Column} vColumn - The column to remove or its index or id
* @returns {sap.ui.table.Column} The removed column or null
*/
public removeColumn(vColumn: number|string|sap.ui.table.Column): sap.ui.table.Column;
/**
* Removes a extension from the aggregation {@link #getExtension extension}.
* @param {number|string|sap.ui.core.Control} vExtension - The extension to remove or its index or id
* @returns {sap.ui.core.Control} The removed extension or null
*/
public removeExtension(vExtension: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a row from the aggregation {@link #getRows rows}.
* @param {number|string|sap.ui.table.Row} vRow - The row to remove or its index or id
* @returns {sap.ui.table.Row} The removed row or null
*/
public removeRow(vRow: number|string|sap.ui.table.Row): sap.ui.table.Row;
/**
* Removes the given selection interval from the selection. In case of single selection this call removeSelectedIndex with the "indexTo" value.
* @param {number} iIndexFrom - Index from which .
* @param {number} iIndexTo - Indices of the items that shall additionally be selected.
* @returns {sap.ui.table.Table}
*/
public removeSelectionInterval(iIndexFrom: number, iIndexTo: number): sap.ui.table.Table;
/**
* Add all rows to the selection.
* Please note that for server based models like OData the indices which are considered to be selected might not
* be available at the client yet. Calling getContextByIndex might not return a result but trigger a roundtrip
* to request this single entity.
* @returns {any} sap.ui.table.Table
*/
public selectAll(): any;
/**
* Sets a new value for property {@link #getColumnHeaderHeight columnHeaderHeight}.
*
* Height of the column header of the Table in pixel.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iColumnHeaderHeight - New value for property columnHeaderHeight
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setColumnHeaderHeight(iColumnHeaderHeight: number): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getColumnHeaderVisible columnHeaderVisible}.
*
* Flag whether the column header is visible or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bColumnHeaderVisible - New value for property columnHeaderVisible
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setColumnHeaderVisible(bColumnHeaderVisible: boolean): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* Flag whether the controls of the Table are editable or not (currently this only controls the background color in certain themes!)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getEnableBusyIndicator enableBusyIndicator}.
*
* If set to true
, the table changes its busy state, resulting in showing or hiding the busy indicator.
* The table will switch to busy as soon as data is retrieved to be displayed in the currently visible rows. This happens,
* for example, during scrolling, filtering, or sorting. As soon as the data has been retrieved, the table switches back to not busy.
* The busy state of the table can still be set manually by calling {@link sap.ui.core.Control#setBusy}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableBusyIndicator - New value for property enableBusyIndicator
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setEnableBusyIndicator(bEnableBusyIndicator: boolean): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getEnableCellFilter enableCellFilter}.
*
* Flag whether to enable or disable the context menu on cells to trigger a filtering with the cell value.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableCellFilter - New value for property enableCellFilter
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setEnableCellFilter(bEnableCellFilter: boolean): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getEnableColumnFreeze enableColumnFreeze}.
*
* Flag whether to show or hide the column menu item to freeze or unfreeze a column.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableColumnFreeze - New value for property enableColumnFreeze
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setEnableColumnFreeze(bEnableColumnFreeze: boolean): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getEnableColumnReordering enableColumnReordering}.
*
* Flag to enable or disable column reordering
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableColumnReordering - New value for property enableColumnReordering
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setEnableColumnReordering(bEnableColumnReordering: boolean): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getEnableCustomFilter enableCustomFilter}.
*
* Set this parameter to true to implement your own filter behaviour. Instead of the filter input box a button
* will be rendered for which' press event (customFilter) you can register an event handler.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableCustomFilter - New value for property enableCustomFilter
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setEnableCustomFilter(bEnableCustomFilter: boolean): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getEnableSelectAll enableSelectAll}.
*
* Specifies if a select all button should be displayed in the top left corner. This button is only displayed
* if the row selector is visible and the selection mode is set to any kind of multi selection.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableSelectAll - New value for property enableSelectAll
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setEnableSelectAll(bEnableSelectAll: boolean): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getFirstVisibleRow firstVisibleRow}.
*
* First visible row.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iFirstVisibleRow - New value for property firstVisibleRow
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setFirstVisibleRow(iFirstVisibleRow: number): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getFixedBottomRowCount fixedBottomRowCount}.
*
* Number of rows that are fix on the bottom. When you use a vertical scroll bar, only the rows which are not fixed, will scroll.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iFixedBottomRowCount - New value for property fixedBottomRowCount
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setFixedBottomRowCount(iFixedBottomRowCount: number): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getFixedColumnCount fixedColumnCount}.
*
* Number of columns that are fix on the left. When you use a horizontal scroll bar, only
* the columns which are not fixed, will scroll. Fixed columns need a defined width for the feature to work.
* Please note that the aggregated width of all fixed columns must not exceed the table width since there
* will be no scrollbar for fixed columns.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iFixedColumnCount - New value for property fixedColumnCount
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setFixedColumnCount(iFixedColumnCount: number): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getFixedRowCount fixedRowCount}.
*
* Number of rows that are fix on the top. When you use a vertical scroll bar, only the rows which are not fixed, will scroll.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iFixedRowCount - New value for property fixedRowCount
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setFixedRowCount(iFixedRowCount: number): sap.ui.table.Table;
/**
* Sets the aggregated {@link #getFooter footer}.
* @param {sap.ui.core.Control|string} vFooter - The footer to set
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setFooter(vFooter: sap.ui.core.Control|string): sap.ui.table.Table;
/**
* Sets the associated {@link #getGroupBy groupBy}.
* @param {sap.ui.core.ID|sap.ui.table.Column} oGroupBy - ID of an element which becomes the new target of this groupBy association; alternatively, an element instance may be given
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setGroupBy(oGroupBy: sap.ui.core.ID|sap.ui.table.Column): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getMinAutoRowCount minAutoRowCount}.
*
* This property is used to set the minimum count of visible rows when the property visibleRowCountMode is set to Auto or Interactive.
* For any other visibleRowCountMode, it is ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 5
.
* @param {number} iMinAutoRowCount - New value for property minAutoRowCount
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setMinAutoRowCount(iMinAutoRowCount: number): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getNavigationMode navigationMode}.
*
* This property has been deprecated and must not be used anymore, since Scrollbar
is the only supported option.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Scrollbar
.
* @param {sap.ui.table.NavigationMode} sNavigationMode - New value for property navigationMode
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setNavigationMode(sNavigationMode: sap.ui.table.NavigationMode): sap.ui.table.Table;
/**
* Sets the aggregated {@link #getNoData noData}.
* @param {sap.ui.core.Control|string} vNoData - The noData to set
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setNoData(vNoData: sap.ui.core.Control|string): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getRowActionCount rowActionCount}.
*
* Number of row actions made visible which determines the width of the row action column.
* The values 0
, 1
and 2
are possible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iRowActionCount - New value for property rowActionCount
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setRowActionCount(iRowActionCount: number): sap.ui.table.Table;
/**
* Sets the aggregated {@link #getRowActionTemplate rowActionTemplate}.
* @param {sap.ui.table.RowAction} oRowActionTemplate - The rowActionTemplate to set
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setRowActionTemplate(oRowActionTemplate: sap.ui.table.RowAction): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getRowHeight rowHeight}.
*
* Height of a row of the Table in pixel.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iRowHeight - New value for property rowHeight
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setRowHeight(iRowHeight: number): sap.ui.table.Table;
/**
* Sets the aggregated {@link #getRowSettingsTemplate rowSettingsTemplate}.
* @param {sap.ui.table.RowSettings} oRowSettingsTemplate - The rowSettingsTemplate to set
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setRowSettingsTemplate(oRowSettingsTemplate: sap.ui.table.RowSettings): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getSelectedIndex selectedIndex}.
*
* Zero-based index of selected item. Index value for no selection is -1.
* When multi-selection is enabled and multiple items are selected, the method returns
* the lead selected item. Sets the zero-based index of the currently selected item. This method
* removes any previous selections. When the given index is invalid, the call is ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {number} iSelectedIndex - New value for property selectedIndex
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setSelectedIndex(iSelectedIndex: number): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getSelectionBehavior selectionBehavior}.
*
* Selection behavior of the Table. This property defines whether the row selector is displayed and whether the row, the row selector or
* both can be clicked to select a row.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is RowSelector
.
* @param {sap.ui.table.SelectionBehavior} sSelectionBehavior - New value for property selectionBehavior
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setSelectionBehavior(sSelectionBehavior: sap.ui.table.SelectionBehavior): sap.ui.table.Table;
/**
* Sets the given selection interval as selection. In case of single selection the "indexTo" value will be used for as selected index.
* @param {number} iIndexFrom - Index from which .
* @param {number} iIndexTo - Indices of the items that shall additionally be selected.
* @returns {sap.ui.table.Table}
*/
public setSelectionInterval(iIndexFrom: number, iIndexTo: number): sap.ui.table.Table;
/**
* Sets the selection mode. The current selection is lost.
* @param {string} sSelectionMode - the selection mode, see sap.ui.table.SelectionMode
* @returns {any} a reference on the table for chaining
*/
public setSelectionMode(sSelectionMode: string): any;
/**
* Sets a new value for property {@link #getShowColumnVisibilityMenu showColumnVisibilityMenu}.
*
* Flag to show or hide the column visibility menu. This menu will get displayed in each
* generated column header menu. It allows to show or hide columns
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowColumnVisibilityMenu - New value for property showColumnVisibilityMenu
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setShowColumnVisibilityMenu(bShowColumnVisibilityMenu: boolean): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getShowNoData showNoData}.
*
* Flag whether to show the no data overlay or not once the table is empty. If set to false
* the table will just show a grid of empty cells
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowNoData - New value for property showNoData
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setShowNoData(bShowNoData: boolean): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getShowOverlay showOverlay}.
*
* Setting this property to true will show an overlay on top of the Table content and users cannot click anymore on the Table content.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowOverlay - New value for property showOverlay
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setShowOverlay(bShowOverlay: boolean): sap.ui.table.Table;
/**
* Sets the threshold value, which will be added to all data requests in
* case the Table is bound against an OData service.
*/
public setThreshold(): void;
/**
* Sets the aggregated {@link #getTitle title}.
* @param {sap.ui.core.Control|string} vTitle - The title to set
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setTitle(vTitle: sap.ui.core.Control|string): sap.ui.table.Table;
/**
* Sets the aggregated {@link #getToolbar toolbar}.
* @param {sap.ui.core.Toolbar} oToolbar - The toolbar to set
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setToolbar(oToolbar: sap.ui.core.Toolbar): sap.ui.table.Table;
/**
* Sets a new tooltip for this object. The tooltip can either be a simple string
* (which in most cases will be rendered as the title
attribute of this
* Element) or an instance of {@link sap.ui.core.TooltipBase}.
*
* If a new tooltip is set, any previously set tooltip is deactivated.
*
* Please note that tooltips are not rendered for the table. The tooltip property will be set
* but it won't effect the DOM.
* @param {string|sap.ui.core.TooltipBase} vTooltip
*/
public setTooltip(vTooltip: string|sap.ui.core.TooltipBase): void;
/**
* Sets a new value for property {@link #getVisibleRowCount visibleRowCount}.
*
* Number of visible rows of the table.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 10
.
* @param {number} iVisibleRowCount - New value for property visibleRowCount
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setVisibleRowCount(iVisibleRowCount: number): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getVisibleRowCountMode visibleRowCountMode}.
*
* This defines how the table handles the visible rows in the table. The default behavior is,
* that a fixed row count is defined. If you change it to auto the visibleRowCount property is
* changed by the table automatically. It will then adjust its maximum row count to the space it is
* allowed to cover (limited by the surrounding container) and its minimum row count to the value of
* the property minAutoRowCount (default value : 5) In manual mode the user can change
* the visibleRowCount interactively.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Fixed
.
* @param {sap.ui.table.VisibleRowCountMode} sVisibleRowCountMode - New value for property visibleRowCountMode
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setVisibleRowCountMode(sVisibleRowCountMode: sap.ui.table.VisibleRowCountMode): sap.ui.table.Table;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of the Table.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.table.Table;
/**
* Sorts the given column ascending or descending.
* @param {sap.ui.table.Column|any} oColumn - column to be sorted or undefined to clear sorting
* @param {sap.ui.table.SortOrder} oSortOrder - sort order of the column (if undefined the default will be ascending)
* @param {boolean} bAdd - Set to true to add the new sort criterion to the existing sort criteria
* @returns {sap.ui.table.Table}
*/
public sort(oColumn: sap.ui.table.Column|any, oSortOrder: sap.ui.table.SortOrder, bAdd: boolean): sap.ui.table.Table;
/**
* Unbinds aggregation {@link #getColumns columns} from model data.
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public unbindColumns(): sap.ui.table.Table;
/**
* Unbinds aggregation {@link #getRows rows} from model data.
* @returns {sap.ui.table.Table} Reference to this
in order to allow method chaining
*/
public unbindRows(): sap.ui.table.Table;
}
/**
* The TablePersoController can be used to connect a table with a persistence service.
*/
export class TablePersoController extends sap.ui.base.ManagedObject {
/**
* Constructor for a new TablePersoController.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.table.TablePersoController with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAutoSave autoSave}.
*
* Auto save state
*
* Default value is true
.
* @returns {boolean} Value of property autoSave
*/
public getAutoSave(): boolean;
/**
* Gets current value of property {@link #getCustomDataKey customDataKey}.
*
* By defining a custom data key the TablePersoController
* will try to get the key for saving the perso data from the custom
* data of the Table and Column instead of creating it by concatenating
* the ID of the Table and the Column. Basically this will be more stable
* than using the auto IDs.
*
* Default value is persoKey
.
* @returns {string} Value of property customDataKey
*/
public getCustomDataKey(): string;
/**
* Returns a metadata object for class sap.ui.table.TablePersoController.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPersoService persoService}.
*
* Personalization Service object. Needs to have the following methods:
*
* - getPersData() :
jQuery Promise
(http://api.jquery.com/promise/)
* - setPersData(oBundle) :
jQuery Promise
(http://api.jquery.com/promise/)
* - delPersData() :
jQuery Promise
(http://api.jquery.com/promise/)
*
* @returns {any} Value of property persoService
*/
public getPersoService(): any;
/**
* ID of the element which is the current target of the association {@link #getTable table}, or null
.
* @returns {sap.ui.core.ID}
*/
public getTable(): sap.ui.core.ID;
/**
* Opens the personalization dialog for the Table to modify the visibility and
* the order of the columns.
*
* Using this functionality will require to load the sap.m library because the
* personalization dialog is only available in this library for now.
* @param {any} mSettings
*/
public openDialog(mSettings: any): void;
/**
* Refresh the personalizations (reloads data from service).
* @returns {JQueryPromise} jQuery Promise
which is resolved once the refresh is finished
*/
public refresh(): JQueryPromise;
/**
* Saves the current personalization state.
* @returns {JQueryPromise} jQuery Promise
which is resolved once the save is finished
*/
public savePersonalizations(): JQueryPromise;
/**
* Sets a new value for property {@link #getAutoSave autoSave}.
*
* Auto save state
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bAutoSave - New value for property autoSave
* @returns {sap.ui.table.TablePersoController} Reference to this
in order to allow method chaining
*/
public setAutoSave(bAutoSave: boolean): sap.ui.table.TablePersoController;
/**
* Sets a new value for property {@link #getCustomDataKey customDataKey}.
*
* By defining a custom data key the TablePersoController
* will try to get the key for saving the perso data from the custom
* data of the Table and Column instead of creating it by concatenating
* the ID of the Table and the Column. Basically this will be more stable
* than using the auto IDs.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is persoKey
.
* @param {string} sCustomDataKey - New value for property customDataKey
* @returns {sap.ui.table.TablePersoController} Reference to this
in order to allow method chaining
*/
public setCustomDataKey(sCustomDataKey: string): sap.ui.table.TablePersoController;
/**
* Sets a new value for property {@link #getPersoService persoService}.
*
* Personalization Service object. Needs to have the following methods:
*
* - getPersData() :
jQuery Promise
(http://api.jquery.com/promise/)
* - setPersData(oBundle) :
jQuery Promise
(http://api.jquery.com/promise/)
* - delPersData() :
jQuery Promise
(http://api.jquery.com/promise/)
*
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oPersoService - New value for property persoService
* @returns {sap.ui.table.TablePersoController} Reference to this
in order to allow method chaining
*/
public setPersoService(oPersoService: any): sap.ui.table.TablePersoController;
/**
* Sets the associated {@link #getTable table}.
* @param {sap.ui.core.ID|sap.ui.table.Table} oTable - ID of an element which becomes the new target of this table association; alternatively, an element instance may be given
* @returns {sap.ui.table.TablePersoController} Reference to this
in order to allow method chaining
*/
public setTable(oTable: sap.ui.core.ID|sap.ui.table.Table): sap.ui.table.TablePersoController;
}
/**
* Different modes for setting the auto expand mode on tree or analytical bindings.
*/
export enum TreeAutoExpandMode {
}
/**
* The TreeTable control provides a comprehensive set of features to display hierarchical data.
*/
export class TreeTable extends sap.ui.table.Table {
/**
* Constructor for a new TreeTable.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Marks a range of tree nodes as selected, starting with iFromIndex going to iToIndex.
* The TreeNodes are referenced via their absolute row index.
* Please be aware, that the absolute row index only applies to the the tree which is visualized by the TreeTable.
* Invisible nodes (collapsed child nodes) will not be regarded.
*
* Please also take notice of the fact, that "addSelectionInterval" does not change any other selection.
* To override the current selection, please use "setSelctionInterval" or for a single entry use "setSelectedIndex".
* @param {number} iFromIndex - The starting index of the range which will be selected.
* @param {number} iToIndex - The starting index of the range which will be selected.
* @returns {sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
*/
public addSelectionInterval(iFromIndex: number, iToIndex: number): sap.ui.table.TreeTable;
/**
* Attaches event handler fnFunction
to the {@link #event:toggleOpenState toggleOpenState} event of this sap.ui.table.TreeTable
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.TreeTable
itself.
*
* fired when a node has been expanded or collapsed (only available in hierachical mode)
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.TreeTable
itself
* @returns {sap.ui.table.TreeTable} Reference to this
in order to allow method chaining
*/
public attachToggleOpenState(fnFunction: Function, oListener?: any): sap.ui.table.TreeTable;
/**
* Attaches event handler fnFunction
to the {@link #event:toggleOpenState toggleOpenState} event of this sap.ui.table.TreeTable
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.table.TreeTable
itself.
*
* fired when a node has been expanded or collapsed (only available in hierachical mode)
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.table.TreeTable
itself
* @returns {sap.ui.table.TreeTable} Reference to this
in order to allow method chaining
*/
public attachToggleOpenState(oData: any, fnFunction: Function, oListener?: any): sap.ui.table.TreeTable;
/**
* Clears the complete selection (all tree table rows/nodes will lose their selection)
* @returns {sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
*/
public clearSelection(): sap.ui.table.TreeTable;
/**
* collapses the row for the given row index
* @param {number} iRowIndex - index of the row to collapse
* @returns {sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
*/
public collapse(iRowIndex: number): sap.ui.table.TreeTable;
/**
* Collapses all nodes (and lower if collapseRecursive is activated)
* @returns {sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
*/
public collapseAll(): sap.ui.table.TreeTable;
/**
* Detaches event handler fnFunction
from the {@link #event:toggleOpenState toggleOpenState} event of this sap.ui.table.TreeTable
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.table.TreeTable} Reference to this
in order to allow method chaining
*/
public detachToggleOpenState(fnFunction: Function, oListener: any): sap.ui.table.TreeTable;
/**
* expands the row for the given row index
* @param {number} iRowIndex - index of the row to expand
* @returns {sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
*/
public expand(iRowIndex: number): sap.ui.table.TreeTable;
/**
* Expands all nodes starting from the root level to the given level 'iLevel'.
*
* Only supported with ODataModel v2, when running in OperationMode.Client or OperationMode.Auto.
* Fully supported for sap.ui.model.ClientTreeBinding
, e.g. if you are using a sap.ui.model.json.JSONModel
.
*
* Please also see sap.ui.model.odata.OperationMode
.
* @param {number} iLevel - the level to which the trees shall be expanded
* @returns {sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
*/
public expandToLevel(iLevel: number): sap.ui.table.TreeTable;
/**
* Creates a new subclass of class sap.ui.table.TreeTable with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.table.Table.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:toggleOpenState toggleOpenState} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.table.TreeTable} Reference to this
in order to allow method chaining
*/
protected fireToggleOpenState(mParameters?: any): sap.ui.table.TreeTable;
/**
* Gets current value of property {@link #getCollapseRecursive collapseRecursive}.
*
* Setting collapseRecursive to true means, that when collapsing a node all subsequent child nodes will also be collapsed.
* This property is only supported with sap.ui.model.odata.v2.ODataModel.
* Note: collapseRecursive is currently not supported if your OData service exposes the hierarchy annotation hierarchy-descendant-count-for
.
* In this case the value of the collapseRecursive property is ignored.
* For more information about the OData hierarchy annotations, please see the SAP Annotations for OData Version 2.0 specification.
*
* Default value is true
.
* @returns {boolean} Value of property collapseRecursive
*/
public getCollapseRecursive(): boolean;
/**
* Gets current value of property {@link #getExpandFirstLevel expandFirstLevel}.
*
* Specifies whether the first level is expanded.
*
* Default value is false
.
* @returns {boolean} Value of property expandFirstLevel
*/
public getExpandFirstLevel(): boolean;
/**
* Gets current value of property {@link #getGroupHeaderProperty groupHeaderProperty}.
*
* The property name of the rows data which will be displayed as a group header if the group mode is enabled
* @returns {string} Value of property groupHeaderProperty
*/
public getGroupHeaderProperty(): string;
/**
* Returns a metadata object for class sap.ui.table.TreeTable.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getRootLevel rootLevel}.
*
* The root level is the level of the topmost tree nodes, which will be used as an entry point for OData services.
* This property is only supported when the TreeTable uses an underlying odata services with hierarchy annotations.
* This property is only supported with sap.ui.model.odata.v2.ODataModel
* The hierarchy annotations may also be provided locally as a parameter for the ODataTreeBinding.
*
* Default value is 0
.
* @returns {number} Value of property rootLevel
*/
public getRootLevel(): number;
/**
* Retrieves the lead selection index. The lead selection index is, among other things, used to determine the
* start/end of a selection range, when using Shift-Click to select multiple entries at once.
* @returns {number} index of lead selected row
*/
public getSelectedIndex(): number;
/**
* Returns an array containing the row indices of all selected tree nodes (ordered ascending).
*
* Please be aware of the following:
* Due to performance/network traffic reasons, the getSelectedIndices function returns only all indices
* of actually selected rows/tree nodes. Unknown rows/nodes (as in "not yet loaded" to the client), will not be
* returned.
* @returns {number[]} an array containing all selected indices
*/
public getSelectedIndices(): number[];
/**
* Gets current value of property {@link #getUseGroupMode useGroupMode}.
*
* If group mode is enabled nodes with subitems are rendered as if they were group headers.
* This can be used to do the grouping for an OData service on the backend and visualize this in a table.
*
* Default value is false
.
* @returns {boolean} Value of property useGroupMode
*/
public getUseGroupMode(): boolean;
/**
* Returns whether the row is expanded or collapsed.
* @param {number} iRowIndex - index of the row to check
* @returns {boolean} true if the node at "iRowIndex" is expanded, false otherwise (meaning it is collapsed)
*/
public isExpanded(iRowIndex: number): boolean;
/**
* Checks if the row at the given index is selected.
* @param {number} iRowIndex - The row index for which the selection state should be retrieved
* @returns {boolean} true if the index is selected, false otherwise
*/
public isIndexSelected(iRowIndex: number): boolean;
/**
* All rows/tree nodes inside the range (including boundaries) will be deselected.
* Tree nodes are referenced with theit absolute row index inside the tree-
* Please be aware, that the absolute row index only applies to the the tree which is visualized by the TreeTable.
* Invisible nodes (collapsed child nodes) will not be regarded.
* @param {number} iFromIndex - The starting index of the range which will be deselected.
* @param {number} iToIndex - The starting index of the range which will be deselected.
* @returns {sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
*/
public removeSelectionInterval(iFromIndex: number, iToIndex: number): sap.ui.table.TreeTable;
/**
* Selects all available nodes/rows.
*
* All rows/tree nodes that are locally stored on the client and that are part of the currently visible tree are selected.
* Additional rows or tree nodes that come into view through scrolling or paging are also selected immediately as soon as they get visible.
* However, SelectAll
does not retrieve any data from the back end in order to improve performance and reduce the network traffic.
* @returns {sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
*/
public selectAll(): sap.ui.table.TreeTable;
/**
* The property enableGrouping
is not supported by the TreeTable
control.
*/
public setEnableGrouping(): void;
/**
* Sets a new value for property {@link #getExpandFirstLevel expandFirstLevel}.
*
* Specifies whether the first level is expanded.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bExpandFirstLevel - New value for property expandFirstLevel
* @returns {sap.ui.table.TreeTable} Reference to this
in order to allow method chaining
*/
public setExpandFirstLevel(bExpandFirstLevel: boolean): sap.ui.table.TreeTable;
/**
* Setter for property fixedRowCount
.
*
* This property is not supportd for the TreeTable and will be ignored!
*
* Default value is 0
* @param {number} iFixedRowCount - new value for property fixedRowCount
* @returns {sap.ui.table.TreeTable} this
to allow method chaining
*/
public setFixedRowCount(iFixedRowCount: number): sap.ui.table.TreeTable;
/**
* Sets a new value for property {@link #getGroupHeaderProperty groupHeaderProperty}.
*
* The property name of the rows data which will be displayed as a group header if the group mode is enabled
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sGroupHeaderProperty - New value for property groupHeaderProperty
* @returns {sap.ui.table.TreeTable} Reference to this
in order to allow method chaining
*/
public setGroupHeaderProperty(sGroupHeaderProperty: string): sap.ui.table.TreeTable;
/**
* Overridden from Table.js base class.
* In a TreeTable you can only select indices, which correspond to the currently visualized tree.
* Invisible tree nodes (e.g. collapsed child nodes) can not be selected via Index, because they do not
* correspond to a TreeTable row.
* @param {number} iRowIndex - The row index which will be selected (if existing)
* @returns {sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
*/
public setSelectedIndex(iRowIndex: number): sap.ui.table.TreeTable;
/**
* Sets the selection of the TreeTable to the given range (including boundaries).
* Beware: The previous selection will be lost/overriden. If this is not wanted, please use "addSelectionInterval" and
* "removeSelectionIntervall".
* @param {number} iFromIndex - the start index of the selection range
* @param {number} iToIndex - the end index of the selection range
* @returns {sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
*/
public setSelectionInterval(iFromIndex: number, iToIndex: number): sap.ui.table.TreeTable;
/**
* Sets the selection mode. The current selection is lost.
* @param {string} sSelectionMode - the selection mode, see sap.ui.table.SelectionMode
* @returns {any} a reference on the table for chaining
*/
public setSelectionMode(sSelectionMode: string): any;
/**
* Sets a new value for property {@link #getUseGroupMode useGroupMode}.
*
* If group mode is enabled nodes with subitems are rendered as if they were group headers.
* This can be used to do the grouping for an OData service on the backend and visualize this in a table.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bUseGroupMode - New value for property useGroupMode
* @returns {sap.ui.table.TreeTable} Reference to this
in order to allow method chaining
*/
public setUseGroupMode(bUseGroupMode: boolean): sap.ui.table.TreeTable;
}
/**
* VisibleRowCountMode of the table
*/
export enum VisibleRowCountMode {
/**
* The table automatically fills the height of the surrounding container.
* The visibleRowCount property is automatically changed accordingly.
* All rows need the same height, otherwise the auto mode doesn't always work as expected.
* The height of all siblings within the same layout container of the table will be subtracted from the available height.
* For performance reasons, it is recommended to add no siblings in the table's parent container.
*/
Auto = "Auto",
/**
* The table always has as many rows as defined in the visibleRowCount property.
*/
Fixed = "Fixed",
/**
* After rendering the table has as many rows as defined in visibleRowCount property. The user is able to change the visible rows by moving a grip with the mouse. The visibleRowCount property is changed accordingly.
*/
Interactive = "Interactive",
}
}
/**
*/
namespace test {
/**
*/
namespace actions {
/**
* Actions for Opa5 - needs to implement an executeOn function that should simulate a user interaction on a control
*/
export class Action extends sap.ui.base.ManagedObject {
/**
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
*/
public constructor();
/**
* Checks if the matcher is matching - will get an instance of sap.ui.core.Control as parameter
* Should be overwritten by subclasses
* @param {sap.ui.core.Control} element - the {@link sap.ui.core.Element} or a control (extends element) the action will be executed on
*/
protected executeOn(element: sap.ui.core.Control): void;
/**
* Creates a new subclass of class sap.ui.test.actions.Action with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getIdSuffix idSuffix}.
* @returns {string} Value of property idSuffix
*/
public getIdSuffix(): string;
/**
* Returns a metadata object for class sap.ui.test.actions.Action.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets a new value for property {@link #getIdSuffix idSuffix}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sIdSuffix - New value for property idSuffix
* @returns {sap.ui.test.actions.Action} Reference to this
in order to allow method chaining
*/
public setIdSuffix(sIdSuffix: string): sap.ui.test.actions.Action;
}
/**
*/
export class EnterText extends sap.ui.test.actions.Action {
/**
* The EnterText action is used to simulate a user entering texts to inputs.
* EnterText will be executed on a control's focus dom ref.
* Supported controls are (for other controls this action still might work):
*
* - sap.m.Input
* - sap.m.SearchField
* - sap.m.TextArea
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
*/
public constructor();
/**
* Sets focus on given control and triggers Multiple keyboard events on it, one event for every character in the text.
* Logs an error if control has no focusable dom ref or is not visible.
* @param {sap.ui.core.Control} oControl - the control on which the text event should be entered in.
*/
public executeOn(oControl: sap.ui.core.Control): void;
/**
* Creates a new subclass of class sap.ui.test.actions.EnterText with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.test.actions.Action.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getClearTextFirst clearTextFirst}.
*
* Default value is true
.
* @returns {boolean} Value of property clearTextFirst
*/
public getClearTextFirst(): boolean;
/**
* Returns a metadata object for class sap.ui.test.actions.EnterText.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* The Text that is going to be typed to the control. If you are entering an empty string, the value will be cleared.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Sets a new value for property {@link #getClearTextFirst clearTextFirst}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bClearTextFirst - New value for property clearTextFirst
* @returns {sap.ui.test.actions.EnterText} Reference to this
in order to allow method chaining
*/
public setClearTextFirst(bClearTextFirst: boolean): sap.ui.test.actions.EnterText;
/**
* Sets a new value for property {@link #getText text}.
*
* The Text that is going to be typed to the control. If you are entering an empty string, the value will be cleared.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.test.actions.EnterText} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.test.actions.EnterText;
}
/**
*/
export class Press extends sap.ui.test.actions.Action {
/**
* The Press action is used to simulate a press interaction on a Control's dom ref.
* This will work out of the box for most of the controls (even custom controls).
*
* Here is a List of supported controls (some controls will trigger the press on a specific region):
*
*
* - sap.m.Button
* - sap.m.Link
* - sap.m.StandardListItem
* - sap.m.IconTabFilter
* - sap.m.Input - Value help
* - sap.m.SearchField - Search Button
* - sap.m.Page - Back Button
* - sap.m.semantic.FullscreenPage - Back Button
* - sap.m.semantic.DetailPage - Back Button
* - sap.m.List - More Button
* - sap.m.Table - More Button
* - sap.m.StandardTile
* - sap.m.ComboBox
* - sap.m.ObjectIdentifier
* - sap.ui.comp.smartfilterbar.SmartFilterBar - Go Button
*
*/
public constructor();
/**
* Sets focus on given control and triggers a 'tap' event on it (which is
* internally translated into a 'press' event).
* Logs an error if control is not visible (i.e. has no dom representation)
* @param {sap.ui.core.Control} oControl - the control on which the 'press' event is triggered
*/
public executeOn(oControl: sap.ui.core.Control): void;
/**
* Creates a new subclass of class sap.ui.test.actions.Press with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.test.actions.Action.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.test.actions.Press.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
}
/**
*/
namespace gherkin {
/**
* Provides utility functions for formatting 2D arrays of strings (such as the raw data loaded from a Gherkin
* feature file) into a more useful format such as an array of objects or a single object. Also handles normalization
* of the raw strings.
*/
namespace dataTableUtils {
/**
* Takes the inputed 2D array "aData" and returns an equivalent object. Each row of data is expected to
* be a property-value pair. To create nested objects, add extra columns to the data. E.g.
*
* [
* ["Name", "Alice"],
* ["Mass", "135 lbs"],
* ["Telephone Number", "Home", "123-456-7890"],
* ["Telephone Number", "Work", "123-456-0987"]
* ]
*
* For each data row, the right-most element becomes a property value, and everything else is a property
* name. The property names get normalized according to the strategy defined by the parameter "vNorm".
* E.g. using camelCase strategy
*
* {
* name: "Alice",
* mass: "135 lbs",
* telephoneNumber: {
* home: "123-456-7890",
* work: "123-456-0987"
* }
* }
*
* @param {string[]} aData - the 2D array of strings to be converted
* @param {string|Function} vNorm - the normalization function to use to normalize property names. Can also be a string with values "titleCase", "pascalCase", "camelCase", "hyphenated" or "none".
* @returns {any} - an object equivalent to the input data, with property names normalized
*/
function toObject(aData: string[], vNorm?: string|Function): any;
/**
* Takes the inputed 2D array "aData" and returns an equivalent array of objects. The data is expected to
* have a header row, with each subsequent row being an entity, and each column being a property of that
* entity. E.g.
*
* [
* ["Their Name", "Their Age"],
* ["Alice", "16"],
* ["Bob", "22"]
* ]
*
*
* The data's column headers become the returned objects' property names. The property names get normalized
* according to the strategy defined by the parameter "vNorm". E.g. using hyphenation strategy this is returned:
*
* [
* {their-name: "Alice", their-age: "16"},
* {their-name: "Bob", their-age: "22"}
* ]
*
* @param {string[]} aData - the 2D array of strings to be converted, with a header row
* @param {string|Function} vNorm - the normalization function to use to normalize property names. Can also be a String with values "titleCase", "pascalCase", "camelCase", "hyphenated" or "none".
* @returns {any[]} - an array of objects equivalent to the input data, with property names normalized
*/
function toTable(aData: string[], vNorm?: string|Function): any[];
/**
* A simple object containing a series of normalization functions that change a string according to a
* particular strategy. All strategies do the following normalization as a minimum:
*
*
* - Trim spaces off the string on both sides. For example:
" hello "
becomes
* "hello"
.
* - Assume that dashes and underscores are analogs for a space. For example:
"sold-to party"
and
* "sold to party"
are equivalent, and would both convert to the camelCase
* "soldToParty"
.
* - Trim multiple spaces between words. For example:
"hello____world"
becomes
* "hello world"
.
* - Remove any characters that are not alphanumeric or whitespace. For example:
"(hello)"
becomes
* "hello"
.
*
*/
namespace normalization {
/**
* For example: "First Name" -> "firstName"
* @param {string} sString - the string to normalize
* @returns {string} the normalized input string with all words after the first capitalized and all spaces removed
*/
function camelCase(sString: string): string;
/**
* For example: "First Name" -> "first-name"
* @param {string} sString - the string to normalize
* @returns {string} the normalized input string changed to lower case and with space between words replaced by a hyphen ("-")
*/
function hyphenated(sString: string): string;
/**
* For example: "First Name" -> "First Name"
* @param {string} sString - the string to normalize
* @returns {string} the original unchanged input string
*/
function none(sString: string): string;
/**
* For example: "first name" -> "FirstName"
* @param {string} sString - the string to normalize
* @returns {string} the normalized input string with all words capitalized and all spaces removed
*/
function pascalCase(sString: string): string;
/**
* For example: "first name" -> "First Name"
* @param {string} sString - the string to normalize
* @returns {string} the normalized input string with all words capitalized
*/
function titleCase(sString: string): string;
}
}
/**
* Dynamically generates and executes Opa5 tests based on a Gherkin feature file and step definitions.
*
* Logs activity to Opa5, and some debug information to the console with the prefix "[GHERKIN]"
*/
namespace opa5TestHarness {
/**
* Dynamically generates Opa5 tests
*
* If a test step is missing and args.generateMissingSteps is true then the Gherkin step will be converted into Opa
* Page Object code and executed. The text will be converted to camelCase and have any non-alphanumeric character
* removed. Here are two pertinent examples:
*
* (1) The simple step "Given I start my app" will be converted into the call "Given.iStartMyApp();"
*
* (2) The step "Then on page 1: I should see the page 1 text" will become the call
* "Then.onPage1.iShouldSeeThePage1Text();"
*
* Chaining function calls, such as "Then.iStartMyApp().and.iCloseMyApp()" is not possible at this time.
* @param {any} args - the arguments to the function
*/
function test(args: any): void;
}
/**
* Dynamically generates and executes QUnit tests based on a Gherkin feature file and step definitions
*
* Logs activity to QUnit, and some debug information to the console with the prefix "[GHERKIN]"
*/
namespace qUnitTestHarness {
/**
* Dynamically generates and executes QUnit tests
* @param {any} args - the arguments to the function
*/
function test(args: any): void;
}
/**
*/
export class StepDefinitions extends sap.ui.base.Object {
/**
* A Gherkin feature file is human-readable, and the computer does not know how to execute its steps. This
* StepDefinitions class provides the interface between human and machine. It defines what each step in the Gherkin
* feature file will actually do when it is executed.
*
* Meant to be implemented/overridden by a child object. Specifically, the functions "init" and "closeApplication"
* need to be overridden.
*/
public constructor();
/**
* Closes the application and cleans up any mess made by the tests. To avoid erroneous exceptions during test
* execution, make sure that it is safe to run this method even if the application was never started.
*/
public closeApplication(): void;
/**
* Creates a new subclass of class sap.ui.test.gherkin.StepDefinitions with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.test.gherkin.StepDefinitions.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Registers the step definitions by calling the method "register".
*/
public init(): void;
/**
* Registers a step definition.
* @param {RegExp} rRegex - the regular expression that matches the feature file step (with leading "Given", "When", "Then", "But" or "*" removed). E.g. if the feature file has the step "Then I should be served a coffee" it will be truncated to "I should be served a coffee" and tested against "rRegex" to check for a match. The simple regular expression /^I should be served a coffee$/i would match this text. The regular expression can specify capturing groups, which will be passed as parameters to "fnFunc".
* @param {Function} fnFunc - the function to execute in the event that the regular expression matches. Receives regular expression capturing groups as parameters in the same order that they are specified in the regular expression. If a data table is specified for the step, it will be passed as an additional final parameter. At execution time, all functions within a particular scenario will execute within the same "this" context.
*/
public register(rRegex: RegExp, fnFunc: Function): void;
}
}
/**
*/
namespace matchers {
/**
* AggregationContainsPropertyEqual - checks if an aggregation contains at least one item that has a Property set to a certain value
*/
export class AggregationContainsPropertyEqual extends sap.ui.test.matchers.Matcher {
/**
* AggregationContainsPropertyEqual - checks if an aggregation contains at least one item that has a Property set to a certain value.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {any} mSettings - optional map/JSON-object with initial settings for the new AggregationContainsPropertyEqualMatcher
*/
public constructor(mSettings?: any);
/**
* Creates a new subclass of class sap.ui.test.matchers.AggregationContainsPropertyEqual with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.test.matchers.Matcher.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getAggregationName aggregationName}.
*
* The Name of the aggregation that is used for matching.
* @returns {string} Value of property aggregationName
*/
public getAggregationName(): string;
/**
* Returns a metadata object for class sap.ui.test.matchers.AggregationContainsPropertyEqual.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPropertyName propertyName}.
*
* The Name of the property that is used for matching.
* @returns {string} Value of property propertyName
*/
public getPropertyName(): string;
/**
* Gets current value of property {@link #getPropertyValue propertyValue}.
*
* The value of the Property that is used for matching.
* @returns {any} Value of property propertyValue
*/
public getPropertyValue(): any;
/**
* Checks if the control has a filled aggregation with at least one control that have a property equaling propertyName/Value.
* @param {sap.ui.core.Control} oControl - the control that is checked by the matcher
* @returns {boolean} true if the Aggregation set in the property aggregationName is filled, false if it is not.
*/
public isMatching(oControl: sap.ui.core.Control): boolean;
/**
* Sets a new value for property {@link #getAggregationName aggregationName}.
*
* The Name of the aggregation that is used for matching.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAggregationName - New value for property aggregationName
* @returns {sap.ui.test.matchers.AggregationContainsPropertyEqual} Reference to this
in order to allow method chaining
*/
public setAggregationName(sAggregationName: string): sap.ui.test.matchers.AggregationContainsPropertyEqual;
/**
* Sets a new value for property {@link #getPropertyName propertyName}.
*
* The Name of the property that is used for matching.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sPropertyName - New value for property propertyName
* @returns {sap.ui.test.matchers.AggregationContainsPropertyEqual} Reference to this
in order to allow method chaining
*/
public setPropertyName(sPropertyName: string): sap.ui.test.matchers.AggregationContainsPropertyEqual;
/**
* Sets a new value for property {@link #getPropertyValue propertyValue}.
*
* The value of the Property that is used for matching.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oPropertyValue - New value for property propertyValue
* @returns {sap.ui.test.matchers.AggregationContainsPropertyEqual} Reference to this
in order to allow method chaining
*/
public setPropertyValue(oPropertyValue: any): sap.ui.test.matchers.AggregationContainsPropertyEqual;
}
/**
* AggregationEmpty - checks if an aggregation is empty
*/
export class AggregationEmpty extends sap.ui.test.matchers.Matcher {
/**
* AggregationEmpty - checks if an aggregation is empty.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {any} mSettings - optional map/JSON-object with initial settings for the new AggregationEmptyMatcher
*/
public constructor(mSettings?: any);
/**
* Creates a new subclass of class sap.ui.test.matchers.AggregationEmpty with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.test.matchers.Matcher.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.test.matchers.AggregationEmpty.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* The name of the aggregation that is used for matching.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Checks if the control has an empty aggregation.
* @param {sap.ui.core.Control} oControl - the control that is checked by the matcher
* @returns {boolean} true if the Aggregation set in the property aggregationName is empty, false if it is not.
*/
public isMatching(oControl: sap.ui.core.Control): boolean;
/**
* Sets a new value for property {@link #getName name}.
*
* The name of the aggregation that is used for matching.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.ui.test.matchers.AggregationEmpty} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.ui.test.matchers.AggregationEmpty;
}
/**
* AggregationFilled - checks if an aggregation contains at least one entry
*/
export class AggregationFilled extends sap.ui.test.matchers.Matcher {
/**
* AggregationFilled - checks if an aggregation contains at least one entry.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {any} mSettings - optional map/JSON-object with initial settings for the new AggregationFilledMatcher
*/
public constructor(mSettings?: any);
/**
* Creates a new subclass of class sap.ui.test.matchers.AggregationFilled with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.test.matchers.Matcher.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.test.matchers.AggregationFilled.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* The name of the aggregation that is used for matching.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Checks if the control has a filled aggregation.
* @param {sap.ui.core.Control} oControl - the control that is checked by the matcher
* @returns {boolean} true if the Aggregation set in the property aggregationName is filled, false if it is not.
*/
public isMatching(oControl: sap.ui.core.Control): boolean;
/**
* Sets a new value for property {@link #getName name}.
*
* The name of the aggregation that is used for matching.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.ui.test.matchers.AggregationFilled} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.ui.test.matchers.AggregationFilled;
}
/**
* AggregationLengthEquals - checks if an aggregation contains at least one entry
*/
export class AggregationLengthEquals extends sap.ui.test.matchers.Matcher {
/**
* AggregationLengthEquals - checks if an aggregation contains at least one entry.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {any} mSettings - optional map/JSON-object with initial settings for the new AggregationLengthEqualsMatcher
*/
public constructor(mSettings?: any);
/**
* Creates a new subclass of class sap.ui.test.matchers.AggregationLengthEquals with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.test.matchers.Matcher.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getLength length}.
*
* The length that aggregation name
should have.
* @returns {number} Value of property length
*/
public getLength(): number;
/**
* Returns a metadata object for class sap.ui.test.matchers.AggregationLengthEquals.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* The name of the aggregation that is used for matching.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Checks if the control's aggregation name
has length length
.
* @param {sap.ui.core.Control} oControl - the control that is checked by the matcher
* @returns {boolean} true if the length of aggregation name
is the same as length
, false if it is not.
*/
public isMatching(oControl: sap.ui.core.Control): boolean;
/**
* Sets a new value for property {@link #getLength length}.
*
* The length that aggregation name
should have.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iLength - New value for property length
* @returns {sap.ui.test.matchers.AggregationLengthEquals} Reference to this
in order to allow method chaining
*/
public setLength(iLength: number): sap.ui.test.matchers.AggregationLengthEquals;
/**
* Sets a new value for property {@link #getName name}.
*
* The name of the aggregation that is used for matching.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.ui.test.matchers.AggregationLengthEquals} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.ui.test.matchers.AggregationLengthEquals;
}
/**
* Ancestor - checks if a control has a defined ancestor
*/
export class Ancestor {
/**
* @param {any} oAncestorControl - the ancestor control to check, if undefined, validates every control to true
* @param {boolean} bDirect - specifies if the ancestor should be a direct ancestor (parent)
*/
public constructor(oAncestorControl: any, bDirect?: boolean);
}
/**
* BindingPath - checks if a control has a binding context with the exact same binding path
*/
export class BindingPath extends sap.ui.test.matchers.Matcher {
/**
* BindingPath - checks if a control has a binding context with the exact same binding path.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {any} mSettings - Map/JSON-object with initial settings for the new BindingPath.
*/
public constructor(mSettings?: any);
/**
* Creates a new subclass of class sap.ui.test.matchers.BindingPath with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.test.matchers.Matcher.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.test.matchers.BindingPath.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getModelName modelName}.
*
* The name of the binding model that is used for matching.
* @returns {string} Value of property modelName
*/
public getModelName(): string;
/**
* Gets current value of property {@link #getPath path}.
*
* The value of the binding path that is used for matching.
* @returns {string} Value of property path
*/
public getPath(): string;
/**
* Checks if the control has a binding context that matches the path
* @param {sap.ui.core.Control} oControl - the control that is checked by the matcher
* @returns {boolean} true if the binding path has a strictly matching value.
*/
public isMatching(oControl: sap.ui.core.Control): boolean;
/**
* Sets a new value for property {@link #getModelName modelName}.
*
* The name of the binding model that is used for matching.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sModelName - New value for property modelName
* @returns {sap.ui.test.matchers.BindingPath} Reference to this
in order to allow method chaining
*/
public setModelName(sModelName: string): sap.ui.test.matchers.BindingPath;
/**
* Sets a new value for property {@link #getPath path}.
*
* The value of the binding path that is used for matching.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sPath - New value for property path
* @returns {sap.ui.test.matchers.BindingPath} Reference to this
in order to allow method chaining
*/
public setPath(sPath: string): sap.ui.test.matchers.BindingPath;
}
/**
* The I18NText matcher checks if a control property has the same value as a text from an I18N file.
* The matcher does automatically
*
* -
* retrieve the text from the assigned 'i18n' model (name can be changed)
*
* -
* check that the I18N key does actually exist in the file
*
* -
* check if asynchronously loaded I18N have actually been loaded
*
*
*/
export class I18NText extends sap.ui.test.matchers.Matcher {
/**
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {any} mSettings - optional map/JSON-object with initial settings for the new I18NText
*/
public constructor(mSettings?: any);
/**
* Creates a new subclass of class sap.ui.test.matchers.I18NText with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.test.matchers.Matcher.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getKey key}.
*
* The key of the I18N text in the containing {@link jQuery.sap.util.ResourceBundle}.
* @returns {string} Value of property key
*/
public getKey(): string;
/**
* Returns a metadata object for class sap.ui.test.matchers.I18NText.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getModelName modelName}.
*
* The name of the {@link sap.ui.model.resource.ResourceModel} assigned to the control.
*
* Default value is i18n
.
* @returns {string} Value of property modelName
*/
public getModelName(): string;
/**
* Gets current value of property {@link #getParameters parameters}.
*
* The parameters for replacing the placeholders of the I18N text. See {@link jQuery.sap.util.ResourceBundle#getText}.
* @returns {any} Value of property parameters
*/
public getParameters(): any;
/**
* Gets current value of property {@link #getPropertyName propertyName}.
*
* The name of the control property to match the I18N text with.
* @returns {string} Value of property propertyName
*/
public getPropertyName(): string;
/**
* Checks if the control has a property that matches the I18N text
* @param {sap.ui.core.Control} oControl - the control that is checked by the matcher
* @returns {boolean} true if the property has a strictly matching value.
*/
public isMatching(oControl: sap.ui.core.Control): boolean;
/**
* Sets a new value for property {@link #getKey key}.
*
* The key of the I18N text in the containing {@link jQuery.sap.util.ResourceBundle}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sKey - New value for property key
* @returns {sap.ui.test.matchers.I18NText} Reference to this
in order to allow method chaining
*/
public setKey(sKey: string): sap.ui.test.matchers.I18NText;
/**
* Sets a new value for property {@link #getModelName modelName}.
*
* The name of the {@link sap.ui.model.resource.ResourceModel} assigned to the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is i18n
.
* @param {string} sModelName - New value for property modelName
* @returns {sap.ui.test.matchers.I18NText} Reference to this
in order to allow method chaining
*/
public setModelName(sModelName: string): sap.ui.test.matchers.I18NText;
/**
* Sets a new value for property {@link #getParameters parameters}.
*
* The parameters for replacing the placeholders of the I18N text. See {@link jQuery.sap.util.ResourceBundle#getText}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oParameters - New value for property parameters
* @returns {sap.ui.test.matchers.I18NText} Reference to this
in order to allow method chaining
*/
public setParameters(oParameters: any): sap.ui.test.matchers.I18NText;
/**
* Sets a new value for property {@link #getPropertyName propertyName}.
*
* The name of the control property to match the I18N text with.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sPropertyName - New value for property propertyName
* @returns {sap.ui.test.matchers.I18NText} Reference to this
in order to allow method chaining
*/
public setPropertyName(sPropertyName: string): sap.ui.test.matchers.I18NText;
}
/**
* Interactable - check if a control is currently able to take user interactions.
* OPA5 will automatically apply this matcher if you specify actions in {@link sap.ui.test.Opa5#waitFor}.
* A control will be filtered out by this matcher when:
*
* -
* There are unfinished XMLHttpRequests (globally).
* That means, the Opa can wait for pending requests to finish that would probably update the UI.
* Also detects sinon.FakeXMLHttpRequests that are not responded yet.
*
* -
* The control is invisible (using the visible matcher)
*
* -
* The control is hidden behind a dialog
*
* -
* The control is in a navigating nav container
*
* -
* The control or its parents are busy
*
* -
* The control or its parents are not enabled
*
* -
* The UIArea of the control needs new rendering
*
*
*/
export class Interactable extends sap.ui.test.matchers.Matcher {
/**
*/
public constructor();
/**
* Creates a new subclass of class sap.ui.test.matchers.Interactable with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.test.matchers.Matcher.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.test.matchers.Interactable.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* The LabelFor matcher searches for given control associated with labelFor property.
* The matcher does automatically
*
* -
* retrieve control associated by label by given text
*
* -
* retrieve control associated by label by given i18n key, modelName, parameters or propertyName. See {@link sap.ui.test.matchers.I18NText}
*
* -
* combination of text and key is not possible
*
*
*/
export class LabelFor extends sap.ui.test.matchers.Matcher {
/**
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {any} mSettings - optional map/JSON-object with initial settings for the new LabelFor
*/
public constructor(mSettings?: any);
/**
* Creates a new subclass of class sap.ui.test.matchers.LabelFor with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.test.matchers.Matcher.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getKey key}.
*
* The key of the I18N text in the containing {@link jQuery.sap.util.ResourceBundle}.
* @returns {string} Value of property key
*/
public getKey(): string;
/**
* Returns a metadata object for class sap.ui.test.matchers.LabelFor.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getModelName modelName}.
*
* The name of the {@link sap.ui.model.resource.ResourceModel} assigned to the control.
*
* Default value is i18n
.
* @returns {string} Value of property modelName
*/
public getModelName(): string;
/**
* Gets current value of property {@link #getParameters parameters}.
*
* The parameters for replacing the placeholders of the I18N text. See {@link jQuery.sap.util.ResourceBundle#getText}.
* @returns {any} Value of property parameters
*/
public getParameters(): any;
/**
* Gets current value of property {@link #getPropertyName propertyName}.
*
* The name of the control property to match the I18N text with.
*
* Default value is text
.
* @returns {string} Value of property propertyName
*/
public getPropertyName(): string;
/**
* Gets current value of property {@link #getText text}.
*
* The text of the {@link sap.m.Label} which have the labelFor property.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Checks for control with labelFor property annotating other control
* @param {sap.ui.core.Control} oControl - the control that is checked by the matcher
* @returns {boolean} true if the Control has a label that matches the criteria
*/
public isMatching(oControl: sap.ui.core.Control): boolean;
/**
* Sets a new value for property {@link #getKey key}.
*
* The key of the I18N text in the containing {@link jQuery.sap.util.ResourceBundle}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sKey - New value for property key
* @returns {sap.ui.test.matchers.LabelFor} Reference to this
in order to allow method chaining
*/
public setKey(sKey: string): sap.ui.test.matchers.LabelFor;
/**
* Sets a new value for property {@link #getModelName modelName}.
*
* The name of the {@link sap.ui.model.resource.ResourceModel} assigned to the control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is i18n
.
* @param {string} sModelName - New value for property modelName
* @returns {sap.ui.test.matchers.LabelFor} Reference to this
in order to allow method chaining
*/
public setModelName(sModelName: string): sap.ui.test.matchers.LabelFor;
/**
* Sets a new value for property {@link #getParameters parameters}.
*
* The parameters for replacing the placeholders of the I18N text. See {@link jQuery.sap.util.ResourceBundle#getText}.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oParameters - New value for property parameters
* @returns {sap.ui.test.matchers.LabelFor} Reference to this
in order to allow method chaining
*/
public setParameters(oParameters: any): sap.ui.test.matchers.LabelFor;
/**
* Sets a new value for property {@link #getPropertyName propertyName}.
*
* The name of the control property to match the I18N text with.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is text
.
* @param {string} sPropertyName - New value for property propertyName
* @returns {sap.ui.test.matchers.LabelFor} Reference to this
in order to allow method chaining
*/
public setPropertyName(sPropertyName: string): sap.ui.test.matchers.LabelFor;
/**
* Sets a new value for property {@link #getText text}.
*
* The text of the {@link sap.m.Label} which have the labelFor property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.test.matchers.LabelFor} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.test.matchers.LabelFor;
}
/**
* Matchers for Opa5 - needs to implement an isMatching function that returns a boolean and will get a control instance as parameter
*/
export class Matcher extends sap.ui.base.ManagedObject {
/**
*/
public constructor();
/**
* Creates a new subclass of class sap.ui.test.matchers.Matcher with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.test.matchers.Matcher.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks if the matcher is matching - will get an instance of sap.ui.core.Control as parameter.
*
* Should be overwritten by subclasses
* @param {sap.ui.core.Control} oControl - the control that is checked by the matcher
* @returns {boolean} true if the Control is matching the condition of the matcher
*/
protected isMatching(oControl: sap.ui.core.Control): boolean;
}
/**
* Properties - checks if a control's properties have the provided values - all properties have to match their values.
*/
export class Properties {
/**
* @param {any} oProperties - the object with the properties to be checked. Example: // Would filter for an enabled control with the text "Accept". new Properties({ // The property text has the exact value "Accept" text: "Accept", // The property enabled also has to be true enabled: true })
If the value is a RegExp, it tests the RegExp with the value. RegExp only works with string properties.
*/
public constructor(oProperties: any);
}
/**
* PropertyStrictEquals - checks if a property has the exact same value
*/
export class PropertyStrictEquals extends sap.ui.test.matchers.Matcher {
/**
* PropertyStrictEquals - checks if a property has the exact same value.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {any} mSettings - optional map/JSON-object with initial settings for the new PropertyStrictEquals
*/
public constructor(mSettings?: any);
/**
* Creates a new subclass of class sap.ui.test.matchers.PropertyStrictEquals with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.test.matchers.Matcher.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.test.matchers.PropertyStrictEquals.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* The Name of the property that is used for matching.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets current value of property {@link #getValue value}.
*
* The value of the property that is used for matching.
* @returns {any} Value of property value
*/
public getValue(): any;
/**
* Checks if the control has a property that matches the value
* @param {sap.ui.core.Control} oControl - the control that is checked by the matcher
* @returns {boolean} true if the property has a strictly matching value.
*/
public isMatching(oControl: sap.ui.core.Control): boolean;
/**
* Sets a new value for property {@link #getName name}.
*
* The Name of the property that is used for matching.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.ui.test.matchers.PropertyStrictEquals} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.ui.test.matchers.PropertyStrictEquals;
/**
* Sets a new value for property {@link #getValue value}.
*
* The value of the property that is used for matching.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oValue - New value for property value
* @returns {sap.ui.test.matchers.PropertyStrictEquals} Reference to this
in order to allow method chaining
*/
public setValue(oValue: any): sap.ui.test.matchers.PropertyStrictEquals;
}
}
/**
* One Page Acceptance testing.
*/
export class Opa {
/**
* the global configuration of Opa.
* All of the global values can be overwritten in an individual waitFor call.
* The default values are:
*
* - arrangements: A new Opa instance
* - actions: A new Opa instance
* - assertions: A new Opa instance
* - timeout : 15 seconds, 0 for infinite timeout
* - pollingInterval: 400 milliseconds
* - debugTimeout: 0 seconds, infinite timeout by default. This will be used instead of timeout if running in debug mode.
*
* You can either directly manipulate the config, or extend it using {@link sap.ui.test.Opa.extendConfig}
*/
public static config: any;
/**
* This class will help you write acceptance tests in one page or single page applications.
* You can wait for certain conditions to be met.
* @param {any} extensionObject - An object containing properties and functions. The newly created Opa will be extended by these properties and functions using jQuery.extend.
*/
public constructor(extensionObject?: any);
/**
* Calls the static emptyQueue function in the Opa namespace {@link sap.ui.test.Opa.emptyQueue}
*/
public emptyQueue(): void;
/**
* Waits until all waitFor calls are done.
* @returns {JQueryPromise} If the waiting was successful, the promise will be resolved. If not it will be rejected
*/
public static emptyQueue(): JQueryPromise;
/**
* Calls the static extendConfig function in the Opa namespace {@link sap.ui.test.Opa.extendConfig}
*/
public extendConfig(): void;
/**
* Extends and overwrites default values of the {@link sap.ui.test.Opa.config}.
* Sample usage:
*
*
* var oOpa = new Opa();
*
* // this statement will will time out after 15 seconds and poll every 400ms.
* // those two values come from the defaults of {@link sap.ui.test.Opa.config}.
* oOpa.waitFor({
* });
*
* // All wait for statements added after this will take other defaults
* Opa.extendConfig({
* timeout: 10,
* pollingInterval: 100
* });
*
* // this statement will time out after 10 seconds and poll every 100 ms
* oOpa.waitFor({
* });
*
* // this statement will time out after 20 seconds and poll every 100 ms
* oOpa.waitFor({
* timeout: 20;
* });
*
*
* @param {any} options - The values to be added to the existing config
*/
public static extendConfig(options: any): void;
/**
* Gives access to a singleton object you can save values in.
* This object will only be created once and it will never be destroyed.
* That means you can use it to save values you need in multiple separated tests.
* @returns {any} the context object
*/
public getContext(): any;
/**
* Gives access to a singleton object you can save values in.
* Same as {@link sap.ui.test.Opa#getContext}
* @returns {any} the context object
*/
public static getContext(): any;
/**
* Reset Opa.config to its default values.
* All of the global values can be overwritten in an individual waitFor call.
*
* The default values are:
*
* - arrangements: A new Opa instance
* - actions: A new Opa instance
* - assertions: A new Opa instance
* - timeout : 15 seconds, 0 for infinite timeout
* - pollingInterval: 400 milliseconds
* - debugTimeout: 0 seconds, infinite timeout by default. This will be used instead of timeout if running in debug mode.
* -
* executionDelay: 0 or 50 (depending on the browser). The value is a number representing milliseconds.
* The executionDelay will slow down the execution of every single waitFor statement to be delayed by the number of milliseconds.
* This does not effect the polling interval it just adds an initial pause.
* Use this parameter to slow down OPA when you want to watch your test during development or checking the UI of your app.
* It is not recommended to use this parameter in any automated test executions.
*
*
*/
public static resetConfig(): void;
/**
* Clears the queue and stops running tests so that new tests can be run.
* This means all waitFor statements registered by {@link sap.ui.test.Opa#waitFor} will not be invoked anymore and
* the promise returned by {@link sap.ui.test.Opa.emptyQueue}
* will be rejected or resolved depending on the failTest parameter.
* When its called inside of a check in {@link sap.ui.test.Opa#waitFor}
* the success function of this waitFor will not be called.
*/
public static stopQueue(): void;
/**
* Queues up a waitFor command for Opa.
* The Queue will not be emptied until {@link sap.ui.test.Opa.emptyQueue} is called.
* If you are using {@link sap.ui.test.opaQunit}, emptyQueue will be called by the wrapped tests.
*
* If you are using Opa5, waitFor takes additional parameters.
* They can be found here: {@link sap.ui.test.Opa5#waitFor}.
* Waits for a check condition to return true, in which case a success function will be called.
* If the timeout is reached before the check returns true, an error function will be called.
* @param {any} options - These contain check, success and error functions
* @returns {JQueryPromise} A promise that gets resolved on success
*/
public waitFor(options: any): JQueryPromise;
}
/**
* UI5 extension of the OPA framework
*/
export class Opa5 extends sap.ui.base.Object {
/**
* Helps you when writing tests for UI5 applications.
* Provides convenience to wait and retrieve for UI5 controls without relying on global IDs.
* Makes it easy to wait until your UI is in the state you need for testing, e.g.: waiting for backend data.
*/
public constructor();
/**
* Create a page object configured as arrangement, action and assertion to the Opa.config.
* Use it to structure your arrangement, action and assertion based on parts of the screen to avoid name clashes and help to structure your tests.
* @param {{ [key: string]: any }} mPageObjects
* @returns {{ [key: string]: any }} mPageObject The created page object. It will look like this: { <your-page-object-name> : { actions: // an instance of baseClass or Opa5 with all the actions defined above assertions: // an instance of baseClass or Opa5 with all the assertions defined above } }
*/
public static createPageObjects(mPageObjects: { [key: string]: any }): { [key: string]: any };
/**
* Waits until all waitFor calls are done
* See {@link sap.ui.test.Opa.emptyQueue} for the description
* @returns {JQueryPromise} If the waiting was successful, the promise will be resolved. If not it will be rejected
*/
public static emptyQueue(): JQueryPromise;
/**
* Extends and overwrites default values of the {@link sap.ui.test.Opa.config}.
* Most frequent usecase:
*
*
* // Every waitFor will append this namespace in front of your viewName
* Opa5.extendConfig({
* viewNamespace: "namespace.of.my.views."
* });
*
* var oOpa = new Opa5();
*
* // Looks for a control with the id "myButton" in a View with the name "namespace.of.my.views.Detail"
* oOpa.waitFor({
* id: "myButton",
* viewName: "Detail"
* });
*
* // Looks for a control with the id "myList" in a View with the name "namespace.of.my.views.Master"
* oOpa.waitFor({
* id: "myList",
* viewName: "Master"
* });
*
*
*
* Sample usage:
*
*
* var oOpa = new Opa5();
*
* // this statement will will time out after 15 seconds and poll every 400ms.
* // those two values come from the defaults of {@link sap.ui.test.Opa.config}.
* oOpa.waitFor({
* });
*
* // All wait for statements added after this will take other defaults
* Opa5.extendConfig({
* timeout: 10,
* pollingInterval: 100
* });
*
* // this statement will time out after 10 seconds and poll every 100 ms
* oOpa.waitFor({
* });
*
* // this statement will time out after 20 seconds and poll every 100 ms
* oOpa.waitFor({
* timeout: 20;
* });
*
*
* @param {any} options - The values to be added to the existing config
*/
public static extendConfig(options: any): void;
/**
* Gives access to a singleton object you can save values in.
* See {@link sap.ui.test.Opa.getContext} for the description
* @returns {any} the context object
*/
public static getContext(): any;
/**
* Returns HashChanger object of the IFrame. If the IFrame is not loaded it will return null.
* @returns {sap.ui.core.routing.HashChanger} The HashChanger instance
*/
public static getHashChanger(): sap.ui.core.routing.HashChanger;
/**
* Returns the jQuery object of the IFrame. If the IFrame is not loaded it will return null.
* @returns {JQuery} The jQuery object
*/
public static getJQuery(): JQuery;
/**
* Returns the Opa plugin used for retrieving controls. If an IFrame is used it will return the iFrame's plugin.
* @returns {sap.ui.test.OpaPlugin} The plugin instance
*/
public static getPlugin(): sap.ui.test.OpaPlugin;
/**
* Return particular test lib config object.
* This method is intended to be used by test libraries to
* access their configuration provided by the test in
* the testLibs section in {@link sap.ui.test.Opa5#extendConfig}
* @param {string} sTestLibName - test library name
* @returns {any} this test library config object or empty object if configuration is not provided
*/
public static getTestLibConfig(sTestLibName: string): any;
/**
* Returns QUnit utils object of the IFrame. If the IFrame is not loaded it will return null.
* @returns {any} The QUnit utils
*/
public static getUtils(): any;
/**
* Returns the window object of the IFrame or the current window. If the IFrame is not loaded it will return null.
* @returns {Window} The window of the IFrame
*/
public static getWindow(): Window;
/**
* Starts an app in an IFrame. Only works reliably if running on the same server.
* @param {string} sSource - The source of the IFrame
* @param {number} iTimeout - The timeout for loading the IFrame in seconds - default is 80
* @returns {JQueryPromise} A promise that gets resolved on success
*/
public iStartMyAppInAFrame(sSource: string, iTimeout?: number): JQueryPromise;
/**
* Starts an app in an IFrame. Only works reliably if running on the same server.
* @param {string} sSource - The source of the IFrame
* @param {number} iTimeout - The timeout for loading the IFrame in seconds - default is 80
* @returns {JQueryPromise} A promise that gets resolved on success
*/
public static iStartMyAppInAFrame(sSource: string, iTimeout?: number): JQueryPromise;
/**
* Starts a UIComponent.
* @param {any} oOptions - An Object that contains the configuration for starting up a UIComponent.
* @returns {JQueryPromise} A promise that gets resolved on success.
*/
public iStartMyUIComponent(oOptions: any): JQueryPromise;
/**
* Removes the IFrame from the DOM and removes all the references to its objects
* @returns {JQueryPromise} A promise that gets resolved on success
*/
public iTeardownMyAppFrame(): JQueryPromise;
/**
* Removes the IFrame from the DOM and removes all the references to its objects
* @returns {JQueryPromise} A promise that gets resolved on success
*/
public static iTeardownMyAppFrame(): JQueryPromise;
/**
* Destroys the UIComponent and removes the div from the dom like all the references on its objects
* @returns {JQueryPromise} a promise that gets resolved on success.
*/
public iTeardownMyUIComponent(): JQueryPromise;
/**
* Resets Opa.config to its default values.
* See {@link sap.ui.test.Opa5#waitFor} for the description
* Default values for OPA5 are:
*
* - viewNamespace: empty string
* - arrangements: instance of OPA5
* - actions: instance of OPA5
* - assertions: instance of OPA5
* - visible: true
* - timeout : 15 seconds, 0 for infinite timeout
* - pollingInterval: 400 milliseconds
* - debugTimeout: 0 seconds, infinite timeout by default. This will be used instead of timeout if running in debug mode.
* - autoWait: false - since 1.42
* - appParams: object with URI parameters for the tested app - since 1.48
*
*/
public static resetConfig(): void;
/**
* Clears the queue and stops running tests so that new tests can be run.
* This means all waitFor statements registered by {@link sap.ui.test.Opa5#waitFor} will not be invoked anymore and
* the promise returned by {@link sap.ui.test.Opa5.emptyQueue} will be rejected.
* When its called inside of a check in {@link sap.ui.test.Opa5#waitFor}
* the success function of this waitFor will not be called.
*/
public static stopQueue(): void;
/**
* Takes the same parameters as {@link sap.ui.test.Opa#waitFor}. Also allows you to specify additional parameters:
* @param {any} options - An Object containing conditions for waiting and callbacks
* @returns {JQueryPromise} A promise that gets resolved on success
*/
public waitFor(options: any): JQueryPromise;
}
/**
* OPA extension interface.
*/
export class OpaExtension {
/**
* OPA extension interface.
*/
public constructor();
/**
* Creates a new subclass of class sap.ui.test.OpaExtension with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.test.OpaExtension.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
}
/**
* A Plugin to search UI5 controls.
*/
export class OpaPlugin {
/**
*/
public constructor();
/**
* Creates a new subclass of class sap.ui.test.OpaPlugin with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.base.Object.extend Object.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets all the controls of a certain type that are currently instantiated.
* If the control type is omitted, nothing is returned.
* @param {Function} fnConstructorType - the control type, e.g: sap.m.CheckBox
* @returns {any[]} an array of the found controls (can be empty)
*/
public getAllControls(fnConstructorType?: Function): any[];
/**
* Returns a control by its id
* accepts an object with an ID property the ID can be
* will check a control type also, if defined
*
* - a single string - function will return the control instance or undefined
* - an array of strings - function will return an array of found controls or an empty array
* - a regexp - function will return an array of found controls or an empty array
*
* @param {any} oOptions - should contain an ID property. It can be of the type string or regex. If contains controlType property, will check it as well
* @returns {sap.ui.core.Element[]} all controls matched by the regex or the control matched by the string or null
*/
public getControlByGlobalId(oOptions: any): sap.ui.core.Element[];
/**
* Gets the constructor function of a certain controlType
* @param {string} sControlType - the name of the type eg: "sap.m.Button"
* @returns {null|Function} When the type is loaded, the contstructor is returned, if it is a lazy stub or not yet loaded, null will be returned and there will be a log entry.
*/
public getControlConstructor(sControlType: string): null|Function;
/**
* Gets a control inside of the view (same as calling oView.byId)
* If no ID is provided, it will return all the controls inside of a view (also nested views and their children).
* eg : { id : "foo" } will search globally for a control with the ID foo
* eg : { id : "foo" , viewName : "bar" } will search for a control with the ID foo inside the view with the name bar
* eg : { viewName : "bar" } will return all the controls inside the view with the name bar
* eg : { viewName : "bar", controlType : sap.m.Button } will return all the Buttons inside a view with the name bar
* eg : { viewName : "bar", viewNamespace : "baz." } will return all the Controls in the view with the name baz.bar
* @param {any} oOptions - that may contain a viewName, id, viewNamespace and controlType properties.
* @returns {sap.ui.core.Element|sap.ui.core.Element[]|null} If the passed id is a string it returns the found control or null. Else an array of matching controls, if the view is not found or no control is found for multiple ids an empty array is returned.
*/
public getControlInView(oOptions: any): sap.ui.core.Element|sap.ui.core.Element[]|null;
/**
* Tries to find a control depending on the options provided.
* @param {any} oOptions - a map of options used to describe the control you are looking for.
* @returns {sap.ui.core.Element|sap.ui.core.Element[]|null} - an array of found Controls depending on the options
- an empty array if no id was given
- the found control/element when an id as a string is specified
- null if an id as string was specified
*/
public getMatchingControls(oOptions?: any): sap.ui.core.Element|sap.ui.core.Element[]|null;
/**
* Returns a metadata object for class sap.ui.test.OpaPlugin.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the view with a specific name - if there are multiple views with that name only the first one is returned.
* @param {string} sViewName - the name of the view
* @returns {sap.ui.core.mvc.View} or undefined
*/
public getView(sViewName: string): sap.ui.core.mvc.View;
}
/**
* Page Object Factory
*/
export class PageObjectFactory extends sap.ui.base.Object {
/**
*/
public constructor();
/**
* Create a page object configured as arrangement, action and assertion to the Opa.config.
* Use it to structure your arrangement, action and assertion based on parts of the screen to avoid name clashes and help structuring your tests.
*/
protected static create(): void;
}
}
/**
* Unified controls intended for both, mobile and desktop scenarios
*/
namespace unified {
/**
* Calendar Utility Class
*/
namespace calendar {
/**
* renders a row of days with ItemNavigation
* This is used inside the calendar. Not for stand alone usage
* If used inside the calendar the properties and aggregation are directly taken from the parent
* (To not duplicate and sync DateRanges and so on...)
*/
export class DatesRow extends sap.ui.unified.calendar.Month {
/**
* Constructor for a new calendar/DatesRow.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* displays the a given date without setting the focus
*
* Property date
date to be focused or displayed. It must be in the displayed date range
* beginning with startDate
and days
days
* So set this properties before setting the date.
* @param {any} oDate - JavaScript date object for focused date.
* @returns {sap.ui.unified.calendar.DatesRow} this
to allow method chaining
*/
public displayDate(oDate: any): sap.ui.unified.calendar.DatesRow;
/**
* Creates a new subclass of class sap.ui.unified.calendar.DatesRow with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.unified.calendar.Month.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getDays days}.
*
* number of days displayed
*
* Default value is 7
.
* @returns {number} Value of property days
*/
public getDays(): number;
/**
* Returns a metadata object for class sap.ui.unified.calendar.DatesRow.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowDayNamesLine showDayNamesLine}.
*
* If set the day names are shown in a separate line.
* If not set the day names are shown inside the single days.
*
* Default value is true
.
* @returns {boolean} Value of property showDayNamesLine
*/
public getShowDayNamesLine(): boolean;
/**
* Gets current value of property {@link #getStartDate startDate}.
*
* Start date of the row
* If in rendering phase the date property is not in the range startDate + days,
* it is set to the start date
* So after setting the start date the date should be set to be in the range of the start date
* @returns {any} Value of property startDate
*/
public getStartDate(): any;
/**
* Setter for property date
.
*
* Property date
date to be focused or displayed. It must be in the displayed date range
* beginning with startDate
and days
days
* So set this properties before setting the date.
* @param {any} oDate - JavaScript date object for start date.
* @returns {sap.ui.unified.calendar.DatesRow} this
to allow method chaining
*/
public setDate(oDate: any): sap.ui.unified.calendar.DatesRow;
/**
* Sets a new value for property {@link #getDays days}.
*
* number of days displayed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 7
.
* @param {number} iDays - New value for property days
* @returns {sap.ui.unified.calendar.DatesRow} Reference to this
in order to allow method chaining
*/
public setDays(iDays: number): sap.ui.unified.calendar.DatesRow;
/**
* Setter for property firstDayOfWeek
.
*
* Property firstDayOfWeek
is not supported in sap.ui.unified.calendar.DatesRow
control.
* @param {number} iFirstDayOfWeek - first day of the week
* @returns {sap.ui.unified.calendar.DatesRow}
*/
public setFirstDayOfWeek(iFirstDayOfWeek?: number): sap.ui.unified.calendar.DatesRow;
/**
* Sets a new value for property {@link #getShowDayNamesLine showDayNamesLine}.
*
* If set the day names are shown in a separate line.
* If not set the day names are shown inside the single days.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowDayNamesLine - New value for property showDayNamesLine
* @returns {sap.ui.unified.calendar.DatesRow} Reference to this
in order to allow method chaining
*/
public setShowDayNamesLine(bShowDayNamesLine: boolean): sap.ui.unified.calendar.DatesRow;
/**
* Sets a new value for property {@link #getStartDate startDate}.
*
* Start date of the row
* If in rendering phase the date property is not in the range startDate + days,
* it is set to the start date
* So after setting the start date the date should be set to be in the range of the start date
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oStartDate - New value for property startDate
* @returns {sap.ui.unified.calendar.DatesRow} Reference to this
in order to allow method chaining
*/
public setStartDate(oStartDate: any): sap.ui.unified.calendar.DatesRow;
}
/**
* renders a calendar header
*
* The calendar header consists of 3 buttons where the text can be set and a previous and a next button.
* In the normal calendar the first button contains the displayed day, the second button the displayed month and the third button the displayed year.
*
* Note: This is used inside the calendar. Not for standalone usage
*/
export class Header extends sap.ui.core.Control {
/**
* Constructor for a new Header.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:pressButton0 pressButton0} event of this sap.ui.unified.calendar.Header
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.Header
itself.
*
* First button pressed (normally day)
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.Header
itself
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public attachPressButton0(fnFunction: Function, oListener?: any): sap.ui.unified.calendar.Header;
/**
* Attaches event handler fnFunction
to the {@link #event:pressButton0 pressButton0} event of this sap.ui.unified.calendar.Header
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.Header
itself.
*
* First button pressed (normally day)
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.Header
itself
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public attachPressButton0(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.calendar.Header;
/**
* Attaches event handler fnFunction
to the {@link #event:pressButton1 pressButton1} event of this sap.ui.unified.calendar.Header
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.Header
itself.
*
* Second button pressed (normally month)
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.Header
itself
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public attachPressButton1(fnFunction: Function, oListener?: any): sap.ui.unified.calendar.Header;
/**
* Attaches event handler fnFunction
to the {@link #event:pressButton1 pressButton1} event of this sap.ui.unified.calendar.Header
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.Header
itself.
*
* Second button pressed (normally month)
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.Header
itself
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public attachPressButton1(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.calendar.Header;
/**
* Attaches event handler fnFunction
to the {@link #event:pressButton2 pressButton2} event of this sap.ui.unified.calendar.Header
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.Header
itself.
*
* Third button pressed (normally year)
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.Header
itself
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public attachPressButton2(fnFunction: Function, oListener?: any): sap.ui.unified.calendar.Header;
/**
* Attaches event handler fnFunction
to the {@link #event:pressButton2 pressButton2} event of this sap.ui.unified.calendar.Header
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.Header
itself.
*
* Third button pressed (normally year)
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.Header
itself
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public attachPressButton2(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.calendar.Header;
/**
* Attaches event handler fnFunction
to the {@link #event:pressNext pressNext} event of this sap.ui.unified.calendar.Header
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.Header
itself.
*
* Next button pressed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.Header
itself
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public attachPressNext(fnFunction: Function, oListener?: any): sap.ui.unified.calendar.Header;
/**
* Attaches event handler fnFunction
to the {@link #event:pressNext pressNext} event of this sap.ui.unified.calendar.Header
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.Header
itself.
*
* Next button pressed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.Header
itself
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public attachPressNext(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.calendar.Header;
/**
* Attaches event handler fnFunction
to the {@link #event:pressPrevious pressPrevious} event of this sap.ui.unified.calendar.Header
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.Header
itself.
*
* Previous button pressed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.Header
itself
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public attachPressPrevious(fnFunction: Function, oListener?: any): sap.ui.unified.calendar.Header;
/**
* Attaches event handler fnFunction
to the {@link #event:pressPrevious pressPrevious} event of this sap.ui.unified.calendar.Header
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.Header
itself.
*
* Previous button pressed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.Header
itself
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public attachPressPrevious(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.calendar.Header;
/**
* Detaches event handler fnFunction
from the {@link #event:pressButton0 pressButton0} event of this sap.ui.unified.calendar.Header
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public detachPressButton0(fnFunction: Function, oListener: any): sap.ui.unified.calendar.Header;
/**
* Detaches event handler fnFunction
from the {@link #event:pressButton1 pressButton1} event of this sap.ui.unified.calendar.Header
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public detachPressButton1(fnFunction: Function, oListener: any): sap.ui.unified.calendar.Header;
/**
* Detaches event handler fnFunction
from the {@link #event:pressButton2 pressButton2} event of this sap.ui.unified.calendar.Header
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public detachPressButton2(fnFunction: Function, oListener: any): sap.ui.unified.calendar.Header;
/**
* Detaches event handler fnFunction
from the {@link #event:pressNext pressNext} event of this sap.ui.unified.calendar.Header
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public detachPressNext(fnFunction: Function, oListener: any): sap.ui.unified.calendar.Header;
/**
* Detaches event handler fnFunction
from the {@link #event:pressPrevious pressPrevious} event of this sap.ui.unified.calendar.Header
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public detachPressPrevious(fnFunction: Function, oListener: any): sap.ui.unified.calendar.Header;
/**
* Creates a new subclass of class sap.ui.unified.calendar.Header with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:pressButton0 pressButton0} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
protected firePressButton0(mParameters?: any): sap.ui.unified.calendar.Header;
/**
* Fires event {@link #event:pressButton1 pressButton1} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
protected firePressButton1(mParameters?: any): sap.ui.unified.calendar.Header;
/**
* Fires event {@link #event:pressButton2 pressButton2} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
protected firePressButton2(mParameters?: any): sap.ui.unified.calendar.Header;
/**
* Fires event {@link #event:pressNext pressNext} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
protected firePressNext(mParameters?: any): sap.ui.unified.calendar.Header;
/**
* Fires event {@link #event:pressPrevious pressPrevious} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
protected firePressPrevious(mParameters?: any): sap.ui.unified.calendar.Header;
/**
* Gets current value of property {@link #getAdditionalTextButton0 additionalTextButton0}.
*
* Additional text of the first button (normally day)
* @returns {string} Value of property additionalTextButton0
*/
public getAdditionalTextButton0(): string;
/**
* Gets current value of property {@link #getAdditionalTextButton1 additionalTextButton1}.
*
* Additional text of the second button (normally month)
* @returns {string} Value of property additionalTextButton1
*/
public getAdditionalTextButton1(): string;
/**
* Gets current value of property {@link #getAdditionalTextButton2 additionalTextButton2}.
*
* Additional text of the third button (normally year)
* @returns {string} Value of property additionalTextButton2
*/
public getAdditionalTextButton2(): string;
/**
* Gets current value of property {@link #getAriaLabelButton0 ariaLabelButton0}.
*
* aria-label of the first button (normally day)
* @returns {string} Value of property ariaLabelButton0
*/
public getAriaLabelButton0(): string;
/**
* Gets current value of property {@link #getAriaLabelButton1 ariaLabelButton1}.
*
* aria-label of the second button (normally month)
* @returns {string} Value of property ariaLabelButton1
*/
public getAriaLabelButton1(): string;
/**
* Gets current value of property {@link #getAriaLabelButton2 ariaLabelButton2}.
*
* aria-label of the third button (normally year)
* @returns {string} Value of property ariaLabelButton2
*/
public getAriaLabelButton2(): string;
/**
* Gets current value of property {@link #getEnabledNext enabledNext}.
*
* Enables the Next button
*
* Default value is true
.
* @returns {boolean} Value of property enabledNext
*/
public getEnabledNext(): boolean;
/**
* Gets current value of property {@link #getEnabledPrevious enabledPrevious}.
*
* Enables the previous button
*
* Default value is true
.
* @returns {boolean} Value of property enabledPrevious
*/
public getEnabledPrevious(): boolean;
/**
* Returns a metadata object for class sap.ui.unified.calendar.Header.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTextButton0 textButton0}.
*
* Text of the first button (normally day)
* @returns {string} Value of property textButton0
*/
public getTextButton0(): string;
/**
* Gets current value of property {@link #getTextButton1 textButton1}.
*
* Text of the second button (normally month)
* @returns {string} Value of property textButton1
*/
public getTextButton1(): string;
/**
* Gets current value of property {@link #getTextButton2 textButton2}.
*
* Text of the third button (normally year)
* @returns {string} Value of property textButton2
*/
public getTextButton2(): string;
/**
* Gets current value of property {@link #getVisibleButton0 visibleButton0}.
*
* If set, the first button will be displayed
*
* Note: The default is set to false to be compatible to older versions
*
* Default value is false
.
* @returns {boolean} Value of property visibleButton0
*/
public getVisibleButton0(): boolean;
/**
* Gets current value of property {@link #getVisibleButton1 visibleButton1}.
*
* If set, the second button will be displayed
*
* Default value is true
.
* @returns {boolean} Value of property visibleButton1
*/
public getVisibleButton1(): boolean;
/**
* Gets current value of property {@link #getVisibleButton2 visibleButton2}.
*
* If set, the third button will be displayed
*
* Default value is true
.
* @returns {boolean} Value of property visibleButton2
*/
public getVisibleButton2(): boolean;
/**
* Sets a new value for property {@link #getAdditionalTextButton0 additionalTextButton0}.
*
* Additional text of the first button (normally day)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAdditionalTextButton0 - New value for property additionalTextButton0
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public setAdditionalTextButton0(sAdditionalTextButton0: string): sap.ui.unified.calendar.Header;
/**
* Sets a new value for property {@link #getAdditionalTextButton1 additionalTextButton1}.
*
* Additional text of the second button (normally month)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAdditionalTextButton1 - New value for property additionalTextButton1
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public setAdditionalTextButton1(sAdditionalTextButton1: string): sap.ui.unified.calendar.Header;
/**
* Sets a new value for property {@link #getAdditionalTextButton2 additionalTextButton2}.
*
* Additional text of the third button (normally year)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAdditionalTextButton2 - New value for property additionalTextButton2
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public setAdditionalTextButton2(sAdditionalTextButton2: string): sap.ui.unified.calendar.Header;
/**
* Sets a new value for property {@link #getAriaLabelButton0 ariaLabelButton0}.
*
* aria-label of the first button (normally day)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAriaLabelButton0 - New value for property ariaLabelButton0
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public setAriaLabelButton0(sAriaLabelButton0: string): sap.ui.unified.calendar.Header;
/**
* Sets a new value for property {@link #getAriaLabelButton1 ariaLabelButton1}.
*
* aria-label of the second button (normally month)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAriaLabelButton1 - New value for property ariaLabelButton1
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public setAriaLabelButton1(sAriaLabelButton1: string): sap.ui.unified.calendar.Header;
/**
* Sets a new value for property {@link #getAriaLabelButton2 ariaLabelButton2}.
*
* aria-label of the third button (normally year)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAriaLabelButton2 - New value for property ariaLabelButton2
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public setAriaLabelButton2(sAriaLabelButton2: string): sap.ui.unified.calendar.Header;
/**
* Sets a new value for property {@link #getEnabledNext enabledNext}.
*
* Enables the Next button
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabledNext - New value for property enabledNext
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public setEnabledNext(bEnabledNext: boolean): sap.ui.unified.calendar.Header;
/**
* Sets a new value for property {@link #getEnabledPrevious enabledPrevious}.
*
* Enables the previous button
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabledPrevious - New value for property enabledPrevious
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public setEnabledPrevious(bEnabledPrevious: boolean): sap.ui.unified.calendar.Header;
/**
* Sets a new value for property {@link #getTextButton0 textButton0}.
*
* Text of the first button (normally day)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTextButton0 - New value for property textButton0
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public setTextButton0(sTextButton0: string): sap.ui.unified.calendar.Header;
/**
* Sets a new value for property {@link #getTextButton1 textButton1}.
*
* Text of the second button (normally month)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTextButton1 - New value for property textButton1
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public setTextButton1(sTextButton1: string): sap.ui.unified.calendar.Header;
/**
* Sets a new value for property {@link #getTextButton2 textButton2}.
*
* Text of the third button (normally year)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTextButton2 - New value for property textButton2
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public setTextButton2(sTextButton2: string): sap.ui.unified.calendar.Header;
/**
* Sets a new value for property {@link #getVisibleButton0 visibleButton0}.
*
* If set, the first button will be displayed
*
* Note: The default is set to false to be compatible to older versions
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bVisibleButton0 - New value for property visibleButton0
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public setVisibleButton0(bVisibleButton0: boolean): sap.ui.unified.calendar.Header;
/**
* Sets a new value for property {@link #getVisibleButton1 visibleButton1}.
*
* If set, the second button will be displayed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisibleButton1 - New value for property visibleButton1
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public setVisibleButton1(bVisibleButton1: boolean): sap.ui.unified.calendar.Header;
/**
* Sets a new value for property {@link #getVisibleButton2 visibleButton2}.
*
* If set, the third button will be displayed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisibleButton2 - New value for property visibleButton2
* @returns {sap.ui.unified.calendar.Header} Reference to this
in order to allow method chaining
*/
public setVisibleButton2(bVisibleButton2: boolean): sap.ui.unified.calendar.Header;
}
/**
* renders a month with ItemNavigation
* This is used inside the calendar. Not for stand alone usage
* If used inside the calendar the properties and aggregation are directly taken from the parent
* (To not duplicate and sync DateRanges and so on...)
*/
export class Month extends sap.ui.core.Control {
/**
* Constructor for a new calendar/Month.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.unified.calendar.Month;
/**
* Adds some disabledDate to the aggregation {@link #getDisabledDates disabledDates}.
* @param {sap.ui.unified.DateRange} oDisabledDate - the disabledDate to add; if empty, nothing is inserted
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public addDisabledDate(oDisabledDate: sap.ui.unified.DateRange): sap.ui.unified.calendar.Month;
/**
* Adds some selectedDate to the aggregation {@link #getSelectedDates selectedDates}.
* @param {sap.ui.unified.DateRange} oSelectedDate - the selectedDate to add; if empty, nothing is inserted
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public addSelectedDate(oSelectedDate: sap.ui.unified.DateRange): sap.ui.unified.calendar.Month;
/**
* Adds some specialDate to the aggregation {@link #getSpecialDates specialDates}.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to add; if empty, nothing is inserted
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public addSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): sap.ui.unified.calendar.Month;
/**
* Attaches event handler fnFunction
to the {@link #event:focus focus} event of this sap.ui.unified.calendar.Month
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.Month
itself.
*
* Date focus changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.Month
itself
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public attachFocus(fnFunction: Function, oListener?: any): sap.ui.unified.calendar.Month;
/**
* Attaches event handler fnFunction
to the {@link #event:focus focus} event of this sap.ui.unified.calendar.Month
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.Month
itself.
*
* Date focus changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.Month
itself
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public attachFocus(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.calendar.Month;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.calendar.Month
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.Month
itself.
*
* Date selection changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.Month
itself
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.unified.calendar.Month;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.calendar.Month
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.Month
itself.
*
* Date selection changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.Month
itself
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.calendar.Month;
/**
* checks if a date is focusable in the current rendered output.
* So if not rendered or in other month it is not focusable.
* @param {any} oDate - JavaScript date object for focused date.
* @returns {boolean} flag if focusable
*/
public checkDateFocusable(oDate: any): boolean;
/**
* Destroys all the disabledDates in the aggregation {@link #getDisabledDates disabledDates}.
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public destroyDisabledDates(): sap.ui.unified.calendar.Month;
/**
* Destroys all the selectedDates in the aggregation {@link #getSelectedDates selectedDates}.
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public destroySelectedDates(): sap.ui.unified.calendar.Month;
/**
* Destroys all the specialDates in the aggregation {@link #getSpecialDates specialDates}.
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public destroySpecialDates(): sap.ui.unified.calendar.Month;
/**
* Detaches event handler fnFunction
from the {@link #event:focus focus} event of this sap.ui.unified.calendar.Month
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public detachFocus(fnFunction: Function, oListener: any): sap.ui.unified.calendar.Month;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.unified.calendar.Month
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.unified.calendar.Month;
/**
* displays the month of a given date without setting the focus
* @param {any} oDate - JavaScript date object for focused date.
* @returns {sap.ui.unified.calendar.Month} this
to allow method chaining
*/
public displayDate(oDate: any): sap.ui.unified.calendar.Month;
/**
* Creates a new subclass of class sap.ui.unified.calendar.Month with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:focus focus} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
protected fireFocus(mParameters?: any): sap.ui.unified.calendar.Month;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.unified.calendar.Month;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getDate date}.
*
* A date as JavaScript Date object.
* The month including this date is rendered and this date is focused initially (if no other focus is set).
* @returns {any} Value of property date
*/
public getDate(): any;
/**
* Gets content of aggregation {@link #getDisabledDates disabledDates}.
*
* Date Ranges for disabled dates
* @returns {sap.ui.unified.DateRange[]}
*/
public getDisabledDates(): sap.ui.unified.DateRange[];
/**
* Gets current value of property {@link #getFirstDayOfWeek firstDayOfWeek}.
*
* If set, the first day of the displayed week is this day. Valid values are 0 to 6.
* If not a valid value is set, the default of the used locale is used.
*
* Default value is -1
.
* @returns {number} Value of property firstDayOfWeek
*/
public getFirstDayOfWeek(): number;
/**
* Gets current value of property {@link #getIntervalSelection intervalSelection}.
*
* If set, interval selection is allowed
*
* Default value is false
.
* @returns {boolean} Value of property intervalSelection
*/
public getIntervalSelection(): boolean;
/**
* ID of the element which is the current target of the association {@link #getLegend legend}, or null
.
* @returns {sap.ui.core.ID}
*/
public getLegend(): sap.ui.core.ID;
/**
* Returns a metadata object for class sap.ui.unified.calendar.Month.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getNonWorkingDays nonWorkingDays}.
*
* If set, the provided weekdays are displayed as non-working days.
* Valid values inside the array are 0 to 6.
* If not set, the weekend defined in the locale settings is displayed as non-working days.
* @returns {number[]} Value of property nonWorkingDays
*/
public getNonWorkingDays(): number[];
/**
* Gets current value of property {@link #getPrimaryCalendarType primaryCalendarType}.
*
* If set, the calendar type is used for display.
* If not set, the calendar type of the global configuration is used.
* @returns {sap.ui.core.CalendarType} Value of property primaryCalendarType
*/
public getPrimaryCalendarType(): sap.ui.core.CalendarType;
/**
* Gets current value of property {@link #getSecondaryCalendarType secondaryCalendarType}.
*
* If set, the days are also displayed in this calendar type
* If not set, the dates are only displayed in the primary calendar type
* @returns {sap.ui.core.CalendarType} Value of property secondaryCalendarType
*/
public getSecondaryCalendarType(): sap.ui.core.CalendarType;
/**
* Gets content of aggregation {@link #getSelectedDates selectedDates}.
*
* Date Ranges for selected dates of the DatePicker
* @returns {sap.ui.unified.DateRange[]}
*/
public getSelectedDates(): sap.ui.unified.DateRange[];
/**
* Gets current value of property {@link #getShowHeader showHeader}.
*
* If set, a header with the month name is shown
*
* Default value is false
.
* @returns {boolean} Value of property showHeader
*/
public getShowHeader(): boolean;
/**
* Gets current value of property {@link #getShowWeekNumbers showWeekNumbers}.
*
* Determines whether the week numbers in the months are displayed.
*
* Note: For Islamic calendars, the week numbers are not displayed
* regardless of what is set to this property.
*
* Default value is true
.
* @returns {boolean} Value of property showWeekNumbers
*/
public getShowWeekNumbers(): boolean;
/**
* Gets current value of property {@link #getSingleSelection singleSelection}.
*
* If set, only a single date or interval, if intervalSelection is enabled, can be selected
*
* Default value is true
.
* @returns {boolean} Value of property singleSelection
*/
public getSingleSelection(): boolean;
/**
* Gets content of aggregation {@link #getSpecialDates specialDates}.
*
* Date Range with type to visualize special days in the Calendar.
* If one day is assigned to more than one Type, only the first one will be used.
* @returns {sap.ui.unified.DateTypeRange[]}
*/
public getSpecialDates(): sap.ui.unified.DateTypeRange[];
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of Month
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.unified.DateRange
in the aggregation {@link #getDisabledDates disabledDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.DateRange} oDisabledDate - The disabledDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfDisabledDate(oDisabledDate: sap.ui.unified.DateRange): number;
/**
* Checks for the provided sap.ui.unified.DateRange
in the aggregation {@link #getSelectedDates selectedDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.DateRange} oSelectedDate - The selectedDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSelectedDate(oSelectedDate: sap.ui.unified.DateRange): number;
/**
* Checks for the provided sap.ui.unified.DateTypeRange
in the aggregation {@link #getSpecialDates specialDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - The specialDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): number;
/**
* Inserts a disabledDate into the aggregation {@link #getDisabledDates disabledDates}.
* @param {sap.ui.unified.DateRange} oDisabledDate - the disabledDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the disabledDate should be inserted at; for a negative value of iIndex
, the disabledDate is inserted at position 0; for a value greater than the current size of the aggregation, the disabledDate is inserted at the last position
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public insertDisabledDate(oDisabledDate: sap.ui.unified.DateRange, iIndex: number): sap.ui.unified.calendar.Month;
/**
* Inserts a selectedDate into the aggregation {@link #getSelectedDates selectedDates}.
* @param {sap.ui.unified.DateRange} oSelectedDate - the selectedDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the selectedDate should be inserted at; for a negative value of iIndex
, the selectedDate is inserted at position 0; for a value greater than the current size of the aggregation, the selectedDate is inserted at the last position
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public insertSelectedDate(oSelectedDate: sap.ui.unified.DateRange, iIndex: number): sap.ui.unified.calendar.Month;
/**
* Inserts a specialDate into the aggregation {@link #getSpecialDates specialDates}.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the specialDate should be inserted at; for a negative value of iIndex
, the specialDate is inserted at position 0; for a value greater than the current size of the aggregation, the specialDate is inserted at the last position
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public insertSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange, iIndex: number): sap.ui.unified.calendar.Month;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getDisabledDates disabledDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.DateRange[]} An array of the removed elements (might be empty)
*/
public removeAllDisabledDates(): sap.ui.unified.DateRange[];
/**
* Removes all the controls from the aggregation {@link #getSelectedDates selectedDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.DateRange[]} An array of the removed elements (might be empty)
*/
public removeAllSelectedDates(): sap.ui.unified.DateRange[];
/**
* Removes all the controls from the aggregation {@link #getSpecialDates specialDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.DateTypeRange[]} An array of the removed elements (might be empty)
*/
public removeAllSpecialDates(): sap.ui.unified.DateTypeRange[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a disabledDate from the aggregation {@link #getDisabledDates disabledDates}.
* @param {number|string|sap.ui.unified.DateRange} vDisabledDate - The disabledDate to remove or its index or id
* @returns {sap.ui.unified.DateRange} The removed disabledDate or null
*/
public removeDisabledDate(vDisabledDate: number|string|sap.ui.unified.DateRange): sap.ui.unified.DateRange;
/**
* Removes a selectedDate from the aggregation {@link #getSelectedDates selectedDates}.
* @param {number|string|sap.ui.unified.DateRange} vSelectedDate - The selectedDate to remove or its index or id
* @returns {sap.ui.unified.DateRange} The removed selectedDate or null
*/
public removeSelectedDate(vSelectedDate: number|string|sap.ui.unified.DateRange): sap.ui.unified.DateRange;
/**
* Removes a specialDate from the aggregation {@link #getSpecialDates specialDates}.
* @param {number|string|sap.ui.unified.DateTypeRange} vSpecialDate - The specialDate to remove or its index or id
* @returns {sap.ui.unified.DateTypeRange} The removed specialDate or null
*/
public removeSpecialDate(vSpecialDate: number|string|sap.ui.unified.DateTypeRange): sap.ui.unified.DateTypeRange;
/**
* Sets a new value for property {@link #getDate date}.
*
* A date as JavaScript Date object.
* The month including this date is rendered and this date is focused initially (if no other focus is set).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oDate - New value for property date
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public setDate(oDate: any): sap.ui.unified.calendar.Month;
/**
* Sets a new value for property {@link #getFirstDayOfWeek firstDayOfWeek}.
*
* If set, the first day of the displayed week is this day. Valid values are 0 to 6.
* If not a valid value is set, the default of the used locale is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {number} iFirstDayOfWeek - New value for property firstDayOfWeek
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public setFirstDayOfWeek(iFirstDayOfWeek: number): sap.ui.unified.calendar.Month;
/**
* Sets a new value for property {@link #getIntervalSelection intervalSelection}.
*
* If set, interval selection is allowed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bIntervalSelection - New value for property intervalSelection
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public setIntervalSelection(bIntervalSelection: boolean): sap.ui.unified.calendar.Month;
/**
* Sets the associated {@link #getLegend legend}.
* @param {sap.ui.core.ID|sap.ui.unified.CalendarLegend} oLegend - ID of an element which becomes the new target of this legend association; alternatively, an element instance may be given
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public setLegend(oLegend: sap.ui.core.ID|sap.ui.unified.CalendarLegend): sap.ui.unified.calendar.Month;
/**
* Sets a new value for property {@link #getNonWorkingDays nonWorkingDays}.
*
* If set, the provided weekdays are displayed as non-working days.
* Valid values inside the array are 0 to 6.
* If not set, the weekend defined in the locale settings is displayed as non-working days.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number[]} sNonWorkingDays - New value for property nonWorkingDays
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public setNonWorkingDays(sNonWorkingDays: number[]): sap.ui.unified.calendar.Month;
/**
* Sets a new value for property {@link #getPrimaryCalendarType primaryCalendarType}.
*
* If set, the calendar type is used for display.
* If not set, the calendar type of the global configuration is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CalendarType} sPrimaryCalendarType - New value for property primaryCalendarType
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public setPrimaryCalendarType(sPrimaryCalendarType: sap.ui.core.CalendarType): sap.ui.unified.calendar.Month;
/**
* Sets a new value for property {@link #getSecondaryCalendarType secondaryCalendarType}.
*
* If set, the days are also displayed in this calendar type
* If not set, the dates are only displayed in the primary calendar type
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CalendarType} sSecondaryCalendarType - New value for property secondaryCalendarType
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public setSecondaryCalendarType(sSecondaryCalendarType: sap.ui.core.CalendarType): sap.ui.unified.calendar.Month;
/**
* Sets a new value for property {@link #getShowHeader showHeader}.
*
* If set, a header with the month name is shown
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowHeader - New value for property showHeader
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public setShowHeader(bShowHeader: boolean): sap.ui.unified.calendar.Month;
/**
* Sets a new value for property {@link #getShowWeekNumbers showWeekNumbers}.
*
* Determines whether the week numbers in the months are displayed.
*
* Note: For Islamic calendars, the week numbers are not displayed
* regardless of what is set to this property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowWeekNumbers - New value for property showWeekNumbers
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public setShowWeekNumbers(bShowWeekNumbers: boolean): sap.ui.unified.calendar.Month;
/**
* Sets a new value for property {@link #getSingleSelection singleSelection}.
*
* If set, only a single date or interval, if intervalSelection is enabled, can be selected
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bSingleSelection - New value for property singleSelection
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public setSingleSelection(bSingleSelection: boolean): sap.ui.unified.calendar.Month;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of Month
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.unified.calendar.Month} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.unified.calendar.Month;
}
/**
* renders a MonthPicker with ItemNavigation
* This is used inside the calendar. Not for stand alone usage
*/
export class MonthPicker extends sap.ui.core.Control {
/**
* Constructor for a new MonthPicker.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:pageChange pageChange} event of this sap.ui.unified.calendar.MonthPicker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.MonthPicker
itself.
*
* If less than 12 months are displayed the pageChange
event is fired
* if the displayed months are changed by user navigation.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.MonthPicker
itself
* @returns {sap.ui.unified.calendar.MonthPicker} Reference to this
in order to allow method chaining
*/
public attachPageChange(fnFunction: Function, oListener?: any): sap.ui.unified.calendar.MonthPicker;
/**
* Attaches event handler fnFunction
to the {@link #event:pageChange pageChange} event of this sap.ui.unified.calendar.MonthPicker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.MonthPicker
itself.
*
* If less than 12 months are displayed the pageChange
event is fired
* if the displayed months are changed by user navigation.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.MonthPicker
itself
* @returns {sap.ui.unified.calendar.MonthPicker} Reference to this
in order to allow method chaining
*/
public attachPageChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.calendar.MonthPicker;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.calendar.MonthPicker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.MonthPicker
itself.
*
* Month selection changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.MonthPicker
itself
* @returns {sap.ui.unified.calendar.MonthPicker} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.unified.calendar.MonthPicker;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.calendar.MonthPicker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.MonthPicker
itself.
*
* Month selection changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.MonthPicker
itself
* @returns {sap.ui.unified.calendar.MonthPicker} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.calendar.MonthPicker;
/**
* Detaches event handler fnFunction
from the {@link #event:pageChange pageChange} event of this sap.ui.unified.calendar.MonthPicker
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.calendar.MonthPicker} Reference to this
in order to allow method chaining
*/
public detachPageChange(fnFunction: Function, oListener: any): sap.ui.unified.calendar.MonthPicker;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.unified.calendar.MonthPicker
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.calendar.MonthPicker} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.unified.calendar.MonthPicker;
/**
* Creates a new subclass of class sap.ui.unified.calendar.MonthPicker with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:pageChange pageChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.calendar.MonthPicker} Reference to this
in order to allow method chaining
*/
protected firePageChange(mParameters?: any): sap.ui.unified.calendar.MonthPicker;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.calendar.MonthPicker} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.unified.calendar.MonthPicker;
/**
* Gets current value of property {@link #getColumns columns}.
*
* number of months in each row
* The value must be between 0 and 12 (0 means just to have all months in one row, independent of the number)
*
* Default value is 3
.
* @returns {number} Value of property columns
*/
public getColumns(): number;
/**
* Returns a metadata object for class sap.ui.unified.calendar.MonthPicker.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMonth month}.
*
* The month is initial focused and selected
* The value must be between 0 and 11
*
* Default value is 0
.
* @returns {number} Value of property month
*/
public getMonth(): number;
/**
* Gets current value of property {@link #getMonths months}.
*
* number of displayed months
* The value must be between 1 and 12
*
* Default value is 12
.
* @returns {number} Value of property months
*/
public getMonths(): number;
/**
* Gets current value of property {@link #getPrimaryCalendarType primaryCalendarType}.
*
* If set, the calendar type is used for display.
* If not set, the calendar type of the global configuration is used.
* @returns {sap.ui.core.CalendarType} Value of property primaryCalendarType
*/
public getPrimaryCalendarType(): sap.ui.core.CalendarType;
/**
* displays the next page
* @returns {sap.ui.unified.calendar.MonthPicker} this
to allow method chaining
*/
public nextPage(): sap.ui.unified.calendar.MonthPicker;
/**
* displays the previous page
* @returns {sap.ui.unified.calendar.MonthPicker} this
to allow method chaining
*/
public previousPage(): sap.ui.unified.calendar.MonthPicker;
/**
* Sets a new value for property {@link #getColumns columns}.
*
* number of months in each row
* The value must be between 0 and 12 (0 means just to have all months in one row, independent of the number)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 3
.
* @param {number} iColumns - New value for property columns
* @returns {sap.ui.unified.calendar.MonthPicker} Reference to this
in order to allow method chaining
*/
public setColumns(iColumns: number): sap.ui.unified.calendar.MonthPicker;
/**
* sets a minimum and maximum month
* @param {number} iMin - minimum month as integer (starting with 0)
* @param {number} iMax - maximum month as integer (starting with 0)
* @returns {sap.ui.unified.calendar.MonthPicker} this
to allow method chaining
*/
public setMinMax(iMin?: number, iMax?: number): sap.ui.unified.calendar.MonthPicker;
/**
* Sets a new value for property {@link #getMonth month}.
*
* The month is initial focused and selected
* The value must be between 0 and 11
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iMonth - New value for property month
* @returns {sap.ui.unified.calendar.MonthPicker} Reference to this
in order to allow method chaining
*/
public setMonth(iMonth: number): sap.ui.unified.calendar.MonthPicker;
/**
* Sets a new value for property {@link #getMonths months}.
*
* number of displayed months
* The value must be between 1 and 12
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 12
.
* @param {number} iMonths - New value for property months
* @returns {sap.ui.unified.calendar.MonthPicker} Reference to this
in order to allow method chaining
*/
public setMonths(iMonths: number): sap.ui.unified.calendar.MonthPicker;
/**
* Sets a new value for property {@link #getPrimaryCalendarType primaryCalendarType}.
*
* If set, the calendar type is used for display.
* If not set, the calendar type of the global configuration is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CalendarType} sPrimaryCalendarType - New value for property primaryCalendarType
* @returns {sap.ui.unified.calendar.MonthPicker} Reference to this
in order to allow method chaining
*/
public setPrimaryCalendarType(sPrimaryCalendarType: sap.ui.core.CalendarType): sap.ui.unified.calendar.MonthPicker;
}
/**
* Renders a row of months using ItemNavigation. There is no paging or navigation outside the rendered area implemented.
* This is done inside the CalendarMonthInterval.
* If used inside the CalendarMonthInterval the properties and aggregation are directly taken from the parent
* (to not duplicate and synchronize DateRanges and so on...).
*
* The MontsRow works with JavaScript Date objects, but only the month and the year are used to display and interact.
* As representation for a month, the 1st of the month will always be returned in the API.
*/
export class MonthsRow extends sap.ui.core.Control {
/**
* Constructor for a new MonthsRow
.
* It shows a calendar with month granularity
*
* Note: This is used inside the CalendarMonthInterval, not for standalone usage.
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.unified.calendar.MonthsRow;
/**
* Adds some selectedDate to the aggregation {@link #getSelectedDates selectedDates}.
* @param {sap.ui.unified.DateRange} oSelectedDate - the selectedDate to add; if empty, nothing is inserted
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public addSelectedDate(oSelectedDate: sap.ui.unified.DateRange): sap.ui.unified.calendar.MonthsRow;
/**
* Adds some specialDate to the aggregation {@link #getSpecialDates specialDates}.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to add; if empty, nothing is inserted
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public addSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): sap.ui.unified.calendar.MonthsRow;
/**
* Attaches event handler fnFunction
to the {@link #event:focus focus} event of this sap.ui.unified.calendar.MonthsRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.MonthsRow
itself.
*
* Month focus changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.MonthsRow
itself
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public attachFocus(fnFunction: Function, oListener?: any): sap.ui.unified.calendar.MonthsRow;
/**
* Attaches event handler fnFunction
to the {@link #event:focus focus} event of this sap.ui.unified.calendar.MonthsRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.MonthsRow
itself.
*
* Month focus changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.MonthsRow
itself
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public attachFocus(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.calendar.MonthsRow;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.calendar.MonthsRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.MonthsRow
itself.
*
* Month selection changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.MonthsRow
itself
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.unified.calendar.MonthsRow;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.calendar.MonthsRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.MonthsRow
itself.
*
* Month selection changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.MonthsRow
itself
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.calendar.MonthsRow;
/**
* Checks if a date is focusable in the current rendered output.
* This means that if it is not rendered, it is not focusable.
* @param {any} oDateTime - JavaScript Date object for focused date.
* @returns {boolean} flag if focusable
*/
public checkDateFocusable(oDateTime: any): boolean;
/**
* Destroys all the selectedDates in the aggregation {@link #getSelectedDates selectedDates}.
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public destroySelectedDates(): sap.ui.unified.calendar.MonthsRow;
/**
* Destroys all the specialDates in the aggregation {@link #getSpecialDates specialDates}.
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public destroySpecialDates(): sap.ui.unified.calendar.MonthsRow;
/**
* Detaches event handler fnFunction
from the {@link #event:focus focus} event of this sap.ui.unified.calendar.MonthsRow
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public detachFocus(fnFunction: Function, oListener: any): sap.ui.unified.calendar.MonthsRow;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.unified.calendar.MonthsRow
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.unified.calendar.MonthsRow;
/**
* Displays the month of a given date without setting the focus
* @param {any} oDate - JavaScript Date object for focused date.
* @returns {sap.ui.unified.calendar.MonthsRow} this
to allow method chaining
*/
public displayDate(oDate: any): sap.ui.unified.calendar.MonthsRow;
/**
* Creates a new subclass of class sap.ui.unified.calendar.MonthsRow with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:focus focus} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
protected fireFocus(mParameters?: any): sap.ui.unified.calendar.MonthsRow;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.unified.calendar.MonthsRow;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getDate date}.
*
* A date as JavaScript Date object. The month including this date is rendered and this date is focused initially (if no other focus is set).
* If the date property is not in the range startDate
+ months
in the rendering phase,
* it is set to the startDate
.
* So after setting the startDate
the date should be set to be in the visible range.
* @returns {any} Value of property date
*/
public getDate(): any;
/**
* Gets current value of property {@link #getIntervalSelection intervalSelection}.
*
* If set, interval selection is allowed
*
* Default value is false
.
* @returns {boolean} Value of property intervalSelection
*/
public getIntervalSelection(): boolean;
/**
* ID of the element which is the current target of the association {@link #getLegend legend}, or null
.
* @returns {sap.ui.core.ID}
*/
public getLegend(): sap.ui.core.ID;
/**
* Returns a metadata object for class sap.ui.unified.calendar.MonthsRow.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMonths months}.
*
* Number of months displayed
*
* Default value is 12
.
* @returns {number} Value of property months
*/
public getMonths(): number;
/**
* Gets content of aggregation {@link #getSelectedDates selectedDates}.
*
* Date ranges for selected dates.
* If singleSelection
is set, only the first entry is used.
*
* Note: Even if only one day is selected, the whole corresponding month is selected.
* @returns {sap.ui.unified.DateRange[]}
*/
public getSelectedDates(): sap.ui.unified.DateRange[];
/**
* Gets current value of property {@link #getShowHeader showHeader}.
*
* If set, a header with the years is shown to visualize what month belongs to what year.
*
* Default value is false
.
* @returns {boolean} Value of property showHeader
*/
public getShowHeader(): boolean;
/**
* Gets current value of property {@link #getSingleSelection singleSelection}.
*
* If set, only a single month or interval, if intervalSelection is enabled, can be selected
*
* Note: Selection of multiple intervals is not supported in the current version.
*
* Default value is true
.
* @returns {boolean} Value of property singleSelection
*/
public getSingleSelection(): boolean;
/**
* Gets content of aggregation {@link #getSpecialDates specialDates}.
*
* Date ranges with type to visualize special months in the row.
* If one day is assigned to more than one type, only the first one will be used.
*
* Note: Even if only one day is set as a special day, the whole corresponding month is displayed in this way.
* @returns {sap.ui.unified.DateTypeRange[]}
*/
public getSpecialDates(): sap.ui.unified.DateTypeRange[];
/**
* Gets current value of property {@link #getStartDate startDate}.
*
* Start date, as JavaScript Date object, of the row. The month of this date is the first month of the displayed row.
* @returns {any} Value of property startDate
*/
public getStartDate(): any;
/**
* Checks for the provided sap.ui.unified.DateRange
in the aggregation {@link #getSelectedDates selectedDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.DateRange} oSelectedDate - The selectedDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSelectedDate(oSelectedDate: sap.ui.unified.DateRange): number;
/**
* Checks for the provided sap.ui.unified.DateTypeRange
in the aggregation {@link #getSpecialDates specialDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - The specialDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): number;
/**
* Inserts a selectedDate into the aggregation {@link #getSelectedDates selectedDates}.
* @param {sap.ui.unified.DateRange} oSelectedDate - the selectedDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the selectedDate should be inserted at; for a negative value of iIndex
, the selectedDate is inserted at position 0; for a value greater than the current size of the aggregation, the selectedDate is inserted at the last position
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public insertSelectedDate(oSelectedDate: sap.ui.unified.DateRange, iIndex: number): sap.ui.unified.calendar.MonthsRow;
/**
* Inserts a specialDate into the aggregation {@link #getSpecialDates specialDates}.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the specialDate should be inserted at; for a negative value of iIndex
, the specialDate is inserted at position 0; for a value greater than the current size of the aggregation, the specialDate is inserted at the last position
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public insertSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange, iIndex: number): sap.ui.unified.calendar.MonthsRow;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getSelectedDates selectedDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.DateRange[]} An array of the removed elements (might be empty)
*/
public removeAllSelectedDates(): sap.ui.unified.DateRange[];
/**
* Removes all the controls from the aggregation {@link #getSpecialDates specialDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.DateTypeRange[]} An array of the removed elements (might be empty)
*/
public removeAllSpecialDates(): sap.ui.unified.DateTypeRange[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a selectedDate from the aggregation {@link #getSelectedDates selectedDates}.
* @param {number|string|sap.ui.unified.DateRange} vSelectedDate - The selectedDate to remove or its index or id
* @returns {sap.ui.unified.DateRange} The removed selectedDate or null
*/
public removeSelectedDate(vSelectedDate: number|string|sap.ui.unified.DateRange): sap.ui.unified.DateRange;
/**
* Removes a specialDate from the aggregation {@link #getSpecialDates specialDates}.
* @param {number|string|sap.ui.unified.DateTypeRange} vSpecialDate - The specialDate to remove or its index or id
* @returns {sap.ui.unified.DateTypeRange} The removed specialDate or null
*/
public removeSpecialDate(vSpecialDate: number|string|sap.ui.unified.DateTypeRange): sap.ui.unified.DateTypeRange;
/**
* Sets a new value for property {@link #getDate date}.
*
* A date as JavaScript Date object. The month including this date is rendered and this date is focused initially (if no other focus is set).
* If the date property is not in the range startDate
+ months
in the rendering phase,
* it is set to the startDate
.
* So after setting the startDate
the date should be set to be in the visible range.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oDate - New value for property date
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public setDate(oDate: any): sap.ui.unified.calendar.MonthsRow;
/**
* Sets a new value for property {@link #getIntervalSelection intervalSelection}.
*
* If set, interval selection is allowed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bIntervalSelection - New value for property intervalSelection
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public setIntervalSelection(bIntervalSelection: boolean): sap.ui.unified.calendar.MonthsRow;
/**
* Sets the associated {@link #getLegend legend}.
* @param {sap.ui.core.ID|sap.ui.unified.CalendarLegend} oLegend - ID of an element which becomes the new target of this legend association; alternatively, an element instance may be given
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public setLegend(oLegend: sap.ui.core.ID|sap.ui.unified.CalendarLegend): sap.ui.unified.calendar.MonthsRow;
/**
* Sets a new value for property {@link #getMonths months}.
*
* Number of months displayed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 12
.
* @param {number} iMonths - New value for property months
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public setMonths(iMonths: number): sap.ui.unified.calendar.MonthsRow;
/**
* Sets a new value for property {@link #getShowHeader showHeader}.
*
* If set, a header with the years is shown to visualize what month belongs to what year.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowHeader - New value for property showHeader
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public setShowHeader(bShowHeader: boolean): sap.ui.unified.calendar.MonthsRow;
/**
* Sets a new value for property {@link #getSingleSelection singleSelection}.
*
* If set, only a single month or interval, if intervalSelection is enabled, can be selected
*
* Note: Selection of multiple intervals is not supported in the current version.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bSingleSelection - New value for property singleSelection
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public setSingleSelection(bSingleSelection: boolean): sap.ui.unified.calendar.MonthsRow;
/**
* Sets a new value for property {@link #getStartDate startDate}.
*
* Start date, as JavaScript Date object, of the row. The month of this date is the first month of the displayed row.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oStartDate - New value for property startDate
* @returns {sap.ui.unified.calendar.MonthsRow} Reference to this
in order to allow method chaining
*/
public setStartDate(oStartDate: any): sap.ui.unified.calendar.MonthsRow;
}
/**
* Renders a row of time items using ItemNavigation. There is no paging or navigation outside the rendered area implemented.
* This is done inside the CalendarTimeInterval.
* If used inside the CalendarTimeInterval the properties and aggregation are directly taken from the parent
* (to not duplicate and synchronize DateRanges and so on...).
*
* The TimesRow works with JavaScript Date objects.
*/
export class TimesRow extends sap.ui.core.Control {
/**
* Constructor for a new TimesRow
.
* It shows a calendar with time granularity (normally hours)
*
* Note: This is used inside the CalendarTimeInterval, not for standalone usage.
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.unified.calendar.TimesRow;
/**
* Adds some selectedDate to the aggregation {@link #getSelectedDates selectedDates}.
* @param {sap.ui.unified.DateRange} oSelectedDate - the selectedDate to add; if empty, nothing is inserted
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public addSelectedDate(oSelectedDate: sap.ui.unified.DateRange): sap.ui.unified.calendar.TimesRow;
/**
* Adds some specialDate to the aggregation {@link #getSpecialDates specialDates}.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to add; if empty, nothing is inserted
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public addSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): sap.ui.unified.calendar.TimesRow;
/**
* Attaches event handler fnFunction
to the {@link #event:focus focus} event of this sap.ui.unified.calendar.TimesRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.TimesRow
itself.
*
* Time focus changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.TimesRow
itself
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public attachFocus(fnFunction: Function, oListener?: any): sap.ui.unified.calendar.TimesRow;
/**
* Attaches event handler fnFunction
to the {@link #event:focus focus} event of this sap.ui.unified.calendar.TimesRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.TimesRow
itself.
*
* Time focus changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.TimesRow
itself
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public attachFocus(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.calendar.TimesRow;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.calendar.TimesRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.TimesRow
itself.
*
* Time selection changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.TimesRow
itself
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.unified.calendar.TimesRow;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.calendar.TimesRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.TimesRow
itself.
*
* Time selection changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.TimesRow
itself
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.calendar.TimesRow;
/**
* Checks if a date is focusable in the current rendered output.
* This means that if it is not rendered, it is not focusable.
* @param {any} oDate - JavaScript Date object for focused date.
* @returns {boolean} flag if focusable
*/
public checkDateFocusable(oDate: any): boolean;
/**
* Destroys all the selectedDates in the aggregation {@link #getSelectedDates selectedDates}.
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public destroySelectedDates(): sap.ui.unified.calendar.TimesRow;
/**
* Destroys all the specialDates in the aggregation {@link #getSpecialDates specialDates}.
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public destroySpecialDates(): sap.ui.unified.calendar.TimesRow;
/**
* Detaches event handler fnFunction
from the {@link #event:focus focus} event of this sap.ui.unified.calendar.TimesRow
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public detachFocus(fnFunction: Function, oListener: any): sap.ui.unified.calendar.TimesRow;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.unified.calendar.TimesRow
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.unified.calendar.TimesRow;
/**
* Displays the given date without setting the focus
* @param {any} oDate - JavaScript Date object for focused date.
* @returns {sap.ui.unified.calendar.TimesRow} this
to allow method chaining
*/
public displayDate(oDate: any): sap.ui.unified.calendar.TimesRow;
/**
* Creates a new subclass of class sap.ui.unified.calendar.TimesRow with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:focus focus} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
protected fireFocus(mParameters?: any): sap.ui.unified.calendar.TimesRow;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.unified.calendar.TimesRow;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getDate date}.
*
* A date as JavaScript Date object. The month including this date is rendered and this date is focused initially (if no other focus is set).
* If the date property is not in the range startDate
+ items
in the rendering phase,
* it is set to the startDate
.
* So after setting the startDate
the date should be set to be in the visible range.
* @returns {any} Value of property date
*/
public getDate(): any;
/**
* Gets current value of property {@link #getIntervalMinutes intervalMinutes}.
*
* Size of on time interval in minutes, default is 60 minutes.
*
* Note: the start of the interval calculation is always startDat
at 00:00.
*
* An interval longer then 720 minutes is not allowed. Please use the DatesRow
instead.
*
* A day must be divisible by this interval size. One interval must not include more than one day.
*
* Default value is 60
.
* @returns {number} Value of property intervalMinutes
*/
public getIntervalMinutes(): number;
/**
* Gets current value of property {@link #getIntervalSelection intervalSelection}.
*
* If set, interval selection is allowed
*
* Default value is false
.
* @returns {boolean} Value of property intervalSelection
*/
public getIntervalSelection(): boolean;
/**
* Gets current value of property {@link #getItems items}.
*
* Number of time items displayed
*
* Default value is 12
.
* @returns {number} Value of property items
*/
public getItems(): number;
/**
* ID of the element which is the current target of the association {@link #getLegend legend}, or null
.
* @returns {sap.ui.core.ID}
*/
public getLegend(): sap.ui.core.ID;
/**
* Returns a metadata object for class sap.ui.unified.calendar.TimesRow.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getSelectedDates selectedDates}.
*
* Date ranges for selected dates.
* If singleSelection
is set, only the first entry is used.
* @returns {sap.ui.unified.DateRange[]}
*/
public getSelectedDates(): sap.ui.unified.DateRange[];
/**
* Gets current value of property {@link #getShowHeader showHeader}.
*
* If set, a header with the years is shown to visualize what month belongs to what year.
*
* Default value is false
.
* @returns {boolean} Value of property showHeader
*/
public getShowHeader(): boolean;
/**
* Gets current value of property {@link #getSingleSelection singleSelection}.
*
* If set, only a single month or interval, if intervalSelection is enabled, can be selected
*
* Note: Selection of multiple intervals is not supported in the current version.
*
* Default value is true
.
* @returns {boolean} Value of property singleSelection
*/
public getSingleSelection(): boolean;
/**
* Gets content of aggregation {@link #getSpecialDates specialDates}.
*
* Date ranges with type to visualize special item in the row.
* If one day is assigned to more than one type, only the first one will be used.
* @returns {sap.ui.unified.DateTypeRange[]}
*/
public getSpecialDates(): sap.ui.unified.DateTypeRange[];
/**
* Gets current value of property {@link #getStartDate startDate}.
*
* Start date, as JavaScript Date object, of the row.
* @returns {any} Value of property startDate
*/
public getStartDate(): any;
/**
* Checks for the provided sap.ui.unified.DateRange
in the aggregation {@link #getSelectedDates selectedDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.DateRange} oSelectedDate - The selectedDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSelectedDate(oSelectedDate: sap.ui.unified.DateRange): number;
/**
* Checks for the provided sap.ui.unified.DateTypeRange
in the aggregation {@link #getSpecialDates specialDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - The specialDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): number;
/**
* Inserts a selectedDate into the aggregation {@link #getSelectedDates selectedDates}.
* @param {sap.ui.unified.DateRange} oSelectedDate - the selectedDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the selectedDate should be inserted at; for a negative value of iIndex
, the selectedDate is inserted at position 0; for a value greater than the current size of the aggregation, the selectedDate is inserted at the last position
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public insertSelectedDate(oSelectedDate: sap.ui.unified.DateRange, iIndex: number): sap.ui.unified.calendar.TimesRow;
/**
* Inserts a specialDate into the aggregation {@link #getSpecialDates specialDates}.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the specialDate should be inserted at; for a negative value of iIndex
, the specialDate is inserted at position 0; for a value greater than the current size of the aggregation, the specialDate is inserted at the last position
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public insertSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange, iIndex: number): sap.ui.unified.calendar.TimesRow;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getSelectedDates selectedDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.DateRange[]} An array of the removed elements (might be empty)
*/
public removeAllSelectedDates(): sap.ui.unified.DateRange[];
/**
* Removes all the controls from the aggregation {@link #getSpecialDates specialDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.DateTypeRange[]} An array of the removed elements (might be empty)
*/
public removeAllSpecialDates(): sap.ui.unified.DateTypeRange[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a selectedDate from the aggregation {@link #getSelectedDates selectedDates}.
* @param {number|string|sap.ui.unified.DateRange} vSelectedDate - The selectedDate to remove or its index or id
* @returns {sap.ui.unified.DateRange} The removed selectedDate or null
*/
public removeSelectedDate(vSelectedDate: number|string|sap.ui.unified.DateRange): sap.ui.unified.DateRange;
/**
* Removes a specialDate from the aggregation {@link #getSpecialDates specialDates}.
* @param {number|string|sap.ui.unified.DateTypeRange} vSpecialDate - The specialDate to remove or its index or id
* @returns {sap.ui.unified.DateTypeRange} The removed specialDate or null
*/
public removeSpecialDate(vSpecialDate: number|string|sap.ui.unified.DateTypeRange): sap.ui.unified.DateTypeRange;
/**
* Sets a new value for property {@link #getDate date}.
*
* A date as JavaScript Date object. The month including this date is rendered and this date is focused initially (if no other focus is set).
* If the date property is not in the range startDate
+ items
in the rendering phase,
* it is set to the startDate
.
* So after setting the startDate
the date should be set to be in the visible range.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oDate - New value for property date
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public setDate(oDate: any): sap.ui.unified.calendar.TimesRow;
/**
* Sets a new value for property {@link #getIntervalMinutes intervalMinutes}.
*
* Size of on time interval in minutes, default is 60 minutes.
*
* Note: the start of the interval calculation is always startDat
at 00:00.
*
* An interval longer then 720 minutes is not allowed. Please use the DatesRow
instead.
*
* A day must be divisible by this interval size. One interval must not include more than one day.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 60
.
* @param {number} iIntervalMinutes - New value for property intervalMinutes
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public setIntervalMinutes(iIntervalMinutes: number): sap.ui.unified.calendar.TimesRow;
/**
* Sets a new value for property {@link #getIntervalSelection intervalSelection}.
*
* If set, interval selection is allowed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bIntervalSelection - New value for property intervalSelection
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public setIntervalSelection(bIntervalSelection: boolean): sap.ui.unified.calendar.TimesRow;
/**
* Sets a new value for property {@link #getItems items}.
*
* Number of time items displayed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 12
.
* @param {number} iItems - New value for property items
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public setItems(iItems: number): sap.ui.unified.calendar.TimesRow;
/**
* Sets the associated {@link #getLegend legend}.
* @param {sap.ui.core.ID|sap.ui.unified.CalendarLegend} oLegend - ID of an element which becomes the new target of this legend association; alternatively, an element instance may be given
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public setLegend(oLegend: sap.ui.core.ID|sap.ui.unified.CalendarLegend): sap.ui.unified.calendar.TimesRow;
/**
* Sets a new value for property {@link #getShowHeader showHeader}.
*
* If set, a header with the years is shown to visualize what month belongs to what year.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowHeader - New value for property showHeader
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public setShowHeader(bShowHeader: boolean): sap.ui.unified.calendar.TimesRow;
/**
* Sets a new value for property {@link #getSingleSelection singleSelection}.
*
* If set, only a single month or interval, if intervalSelection is enabled, can be selected
*
* Note: Selection of multiple intervals is not supported in the current version.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bSingleSelection - New value for property singleSelection
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public setSingleSelection(bSingleSelection: boolean): sap.ui.unified.calendar.TimesRow;
/**
* Sets a new value for property {@link #getStartDate startDate}.
*
* Start date, as JavaScript Date object, of the row.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oStartDate - New value for property startDate
* @returns {sap.ui.unified.calendar.TimesRow} Reference to this
in order to allow method chaining
*/
public setStartDate(oStartDate: any): sap.ui.unified.calendar.TimesRow;
}
/**
* renders a YearPicker with ItemNavigation
* This is used inside the calendar. Not for stand alone usage
*/
export class YearPicker extends sap.ui.core.Control {
/**
* Constructor for a new YearPicker.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:pageChange pageChange} event of this sap.ui.unified.calendar.YearPicker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.YearPicker
itself.
*
* The pageChange
event is fired if the displayed years are changed by user navigation.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.YearPicker
itself
* @returns {sap.ui.unified.calendar.YearPicker} Reference to this
in order to allow method chaining
*/
public attachPageChange(fnFunction: Function, oListener?: any): sap.ui.unified.calendar.YearPicker;
/**
* Attaches event handler fnFunction
to the {@link #event:pageChange pageChange} event of this sap.ui.unified.calendar.YearPicker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.YearPicker
itself.
*
* The pageChange
event is fired if the displayed years are changed by user navigation.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.YearPicker
itself
* @returns {sap.ui.unified.calendar.YearPicker} Reference to this
in order to allow method chaining
*/
public attachPageChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.calendar.YearPicker;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.calendar.YearPicker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.YearPicker
itself.
*
* Month selection changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.YearPicker
itself
* @returns {sap.ui.unified.calendar.YearPicker} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.unified.calendar.YearPicker;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.calendar.YearPicker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.calendar.YearPicker
itself.
*
* Month selection changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.YearPicker
itself
* @returns {sap.ui.unified.calendar.YearPicker} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.calendar.YearPicker;
/**
* Detaches event handler fnFunction
from the {@link #event:pageChange pageChange} event of this sap.ui.unified.calendar.YearPicker
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.calendar.YearPicker} Reference to this
in order to allow method chaining
*/
public detachPageChange(fnFunction: Function, oListener: any): sap.ui.unified.calendar.YearPicker;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.unified.calendar.YearPicker
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.calendar.YearPicker} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.unified.calendar.YearPicker;
/**
* Creates a new subclass of class sap.ui.unified.calendar.YearPicker with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:pageChange pageChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.calendar.YearPicker} Reference to this
in order to allow method chaining
*/
protected firePageChange(mParameters?: any): sap.ui.unified.calendar.YearPicker;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.calendar.YearPicker} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.unified.calendar.YearPicker;
/**
* Gets current value of property {@link #getColumns columns}.
*
* number of years in each row
* 0 means just to have all years in one row, independent of the number
*
* Default value is 4
.
* @returns {number} Value of property columns
*/
public getColumns(): number;
/**
* Gets current value of property {@link #getDate date}.
*
* Date as JavaScript Date object. For this date a YearPicker
is rendered. If a Year is selected the
* date is updated with the start date of the selected year (depending on the calendar type).
* @returns {any} Value of property date
*/
public getDate(): any;
/**
* return the first date of the first rendered year
* Note: If the YearPicker is not rendered no date is returned
* @returns {any} JavaScript Date Object
*/
public getFirstRenderedDate(): any;
/**
* Returns a metadata object for class sap.ui.unified.calendar.YearPicker.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPrimaryCalendarType primaryCalendarType}.
*
* If set, the calendar type is used for display.
* If not set, the calendar type of the global configuration is used.
* @returns {sap.ui.core.CalendarType} Value of property primaryCalendarType
*/
public getPrimaryCalendarType(): sap.ui.core.CalendarType;
/**
* Gets current value of property {@link #getYear year}.
*
* The year is initial focused and selected
* The value must be between 0 and 9999
*
* Default value is 2000
.
* @returns {number} Value of property year
*/
public getYear(): number;
/**
* Gets current value of property {@link #getYears years}.
*
* number of displayed years
*
* Default value is 20
.
* @returns {number} Value of property years
*/
public getYears(): number;
/**
* displays the next page
* @returns {sap.ui.unified.calendar.YearPicker} this
to allow method chaining
*/
public nextPage(): sap.ui.unified.calendar.YearPicker;
/**
* displays the previous page
* @returns {sap.ui.unified.calendar.YearPicker} this
to allow method chaining
*/
public previousPage(): sap.ui.unified.calendar.YearPicker;
/**
* Sets a new value for property {@link #getColumns columns}.
*
* number of years in each row
* 0 means just to have all years in one row, independent of the number
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 4
.
* @param {number} iColumns - New value for property columns
* @returns {sap.ui.unified.calendar.YearPicker} Reference to this
in order to allow method chaining
*/
public setColumns(iColumns: number): sap.ui.unified.calendar.YearPicker;
/**
* Sets a new value for property {@link #getDate date}.
*
* Date as JavaScript Date object. For this date a YearPicker
is rendered. If a Year is selected the
* date is updated with the start date of the selected year (depending on the calendar type).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oDate - New value for property date
* @returns {sap.ui.unified.calendar.YearPicker} Reference to this
in order to allow method chaining
*/
public setDate(oDate: any): sap.ui.unified.calendar.YearPicker;
/**
* Sets a new value for property {@link #getPrimaryCalendarType primaryCalendarType}.
*
* If set, the calendar type is used for display.
* If not set, the calendar type of the global configuration is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CalendarType} sPrimaryCalendarType - New value for property primaryCalendarType
* @returns {sap.ui.unified.calendar.YearPicker} Reference to this
in order to allow method chaining
*/
public setPrimaryCalendarType(sPrimaryCalendarType: sap.ui.core.CalendarType): sap.ui.unified.calendar.YearPicker;
/**
* Sets a new value for property {@link #getYear year}.
*
* The year is initial focused and selected
* The value must be between 0 and 9999
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 2000
.
* @param {number} iYear - New value for property year
* @returns {sap.ui.unified.calendar.YearPicker} Reference to this
in order to allow method chaining
*/
public setYear(iYear: number): sap.ui.unified.calendar.YearPicker;
/**
* Sets a new value for property {@link #getYears years}.
*
* number of displayed years
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 20
.
* @param {number} iYears - New value for property years
* @returns {sap.ui.unified.calendar.YearPicker} Reference to this
in order to allow method chaining
*/
public setYears(iYears: number): sap.ui.unified.calendar.YearPicker;
}
}
/**
* Basic Calendar.
* This calendar is used for DatePickers
*/
export class Calendar extends sap.ui.core.Control {
/**
* Constructor for a new Calendar.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {Object} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: Object);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.unified.Calendar;
/**
* Adds some disabledDate to the aggregation {@link #getDisabledDates disabledDates}.
* @param {sap.ui.unified.DateRange} oDisabledDate - the disabledDate to add; if empty, nothing is inserted
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public addDisabledDate(oDisabledDate: sap.ui.unified.DateRange): sap.ui.unified.Calendar;
/**
* Adds some selectedDate to the aggregation {@link #getSelectedDates selectedDates}.
* @param {sap.ui.unified.DateRange} oSelectedDate - the selectedDate to add; if empty, nothing is inserted
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public addSelectedDate(oSelectedDate: sap.ui.unified.DateRange): sap.ui.unified.Calendar;
/**
* Adds some specialDate to the aggregation {@link #getSpecialDates specialDates}.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to add; if empty, nothing is inserted
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public addSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): sap.ui.unified.Calendar;
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.ui.unified.Calendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.Calendar
itself.
*
* Date selection was cancelled
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.Calendar
itself
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public attachCancel(fnFunction: Function, oListener?: any): sap.ui.unified.Calendar;
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.ui.unified.Calendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.Calendar
itself.
*
* Date selection was cancelled
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.Calendar
itself
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public attachCancel(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.Calendar;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.Calendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.Calendar
itself.
*
* Date selection changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.Calendar
itself
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.unified.Calendar;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.Calendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.Calendar
itself.
*
* Date selection changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.Calendar
itself
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.Calendar;
/**
* Attaches event handler fnFunction
to the {@link #event:startDateChange startDateChange} event of this sap.ui.unified.Calendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.Calendar
itself.
*
* startDate
was changed while navigation in Calendar
*
* Use getStartDate
function to determine the current start date
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.Calendar
itself
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public attachStartDateChange(fnFunction: Function, oListener?: any): sap.ui.unified.Calendar;
/**
* Attaches event handler fnFunction
to the {@link #event:startDateChange startDateChange} event of this sap.ui.unified.Calendar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.Calendar
itself.
*
* startDate
was changed while navigation in Calendar
*
* Use getStartDate
function to determine the current start date
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.Calendar
itself
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public attachStartDateChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.Calendar;
/**
* Destroys all the disabledDates in the aggregation {@link #getDisabledDates disabledDates}.
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public destroyDisabledDates(): sap.ui.unified.Calendar;
/**
* Destroys all the selectedDates in the aggregation {@link #getSelectedDates selectedDates}.
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public destroySelectedDates(): sap.ui.unified.Calendar;
/**
* Destroys all the specialDates in the aggregation {@link #getSpecialDates specialDates}.
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public destroySpecialDates(): sap.ui.unified.Calendar;
/**
* Detaches event handler fnFunction
from the {@link #event:cancel cancel} event of this sap.ui.unified.Calendar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public detachCancel(fnFunction: Function, oListener: any): sap.ui.unified.Calendar;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.unified.Calendar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.unified.Calendar;
/**
* Detaches event handler fnFunction
from the {@link #event:startDateChange startDateChange} event of this sap.ui.unified.Calendar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public detachStartDateChange(fnFunction: Function, oListener: any): sap.ui.unified.Calendar;
/**
* Displays a date in the calendar but don't set the focus.
* @param {Object} oDate - JavaScript date object for focused date.
* @returns {sap.ui.unified.Calendar} this
to allow method chaining
*/
public displayDate(oDate: Object): sap.ui.unified.Calendar;
/**
* Creates a new subclass of class sap.ui.unified.Calendar with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:cancel cancel} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
protected fireCancel(mParameters?: any): sap.ui.unified.Calendar;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.unified.Calendar;
/**
* Fires event {@link #event:startDateChange startDateChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
protected fireStartDateChange(mParameters?: any): sap.ui.unified.Calendar;
/**
* Sets the focused date of the calendar.
* @param {Object} oDate - JavaScript date object for focused date.
* @returns {sap.ui.unified.Calendar} this
to allow method chaining
*/
public focusDate(oDate: Object): sap.ui.unified.Calendar;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets content of aggregation {@link #getDisabledDates disabledDates}.
*
* Dates or date ranges for disabled dates.
*
* To set a single date (instead of a range), set only the startDate
property
* of the {@link sap.ui.unified.DateRange} class.
* @returns {sap.ui.unified.DateRange[]}
*/
public getDisabledDates(): sap.ui.unified.DateRange[];
/**
* Gets current value of property {@link #getFirstDayOfWeek firstDayOfWeek}.
*
* If set, the first day of the displayed week is this day. Valid values are 0 to 6.
* If not a valid value is set, the default of the used locale is used.
*
* Default value is -1
.
* @returns {number} Value of property firstDayOfWeek
*/
public getFirstDayOfWeek(): number;
/**
* Gets current value of property {@link #getIntervalSelection intervalSelection}.
*
* If set, interval selection is allowed
*
* Default value is false
.
* @returns {boolean} Value of property intervalSelection
*/
public getIntervalSelection(): boolean;
/**
* ID of the element which is the current target of the association {@link #getLegend legend}, or null
.
* @returns {sap.ui.core.ID}
*/
public getLegend(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getMaxDate maxDate}.
*
* Maximum date that can be shown and selected in the Calendar. This must be a JavaScript date object.
*
* Note: if the date is inside of a month the complete month is displayed,
* but dates outside the valid range can not be selected.
*
* Note: If the maxDate
is set to be before the minDate
,
* the minDate
is set to the begin of the month of the maxDate
.
* @returns {any} Value of property maxDate
*/
public getMaxDate(): any;
/**
* Returns a metadata object for class sap.ui.unified.Calendar.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinDate minDate}.
*
* Minimum date that can be shown and selected in the Calendar. This must be a JavaScript date object.
*
* Note: if the date is inside of a month the complete month is displayed,
* but dates outside the valid range can not be selected.
*
* Note: If the minDate
is set to be after the maxDate
,
* the maxDate
is set to the end of the month of the minDate
.
* @returns {any} Value of property minDate
*/
public getMinDate(): any;
/**
* Gets current value of property {@link #getMonths months}.
*
* number of months displayed
* on phones always only one month is displayed
*
* Default value is 1
.
* @returns {number} Value of property months
*/
public getMonths(): number;
/**
* Gets current value of property {@link #getNonWorkingDays nonWorkingDays}.
*
* If set, the provided weekdays are displayed as non-working days.
* Valid values inside the array are 0 to 6.
* If not set, the weekend defined in the locale settings is displayed as non-working days.
*
* Note: Keep in mind that this property sets only weekly-recurring days
* as non-working. If you need specific dates or dates ranges, such as national
* holidays, use the specialDates
aggregation to set them.
* Both the non-working days (from property) and dates (from aggregation) are
* visualized the same.
* @returns {number[]} Value of property nonWorkingDays
*/
public getNonWorkingDays(): number[];
/**
* Gets current value of property {@link #getPrimaryCalendarType primaryCalendarType}.
*
* If set, the calendar type is used for display.
* If not set, the calendar type of the global configuration is used.
* @returns {sap.ui.core.CalendarType} Value of property primaryCalendarType
*/
public getPrimaryCalendarType(): sap.ui.core.CalendarType;
/**
* Gets current value of property {@link #getSecondaryCalendarType secondaryCalendarType}.
*
* If set, the days are also displayed in this calendar type
* If not set, the dates are only displayed in the primary calendar type
* @returns {sap.ui.core.CalendarType} Value of property secondaryCalendarType
*/
public getSecondaryCalendarType(): sap.ui.core.CalendarType;
/**
* Gets content of aggregation {@link #getSelectedDates selectedDates}.
*
* Dates or date ranges for selected dates.
*
* To set a single date (instead of a range), set only the startDate
property
* of the {@link sap.ui.unified.DateRange} class.
* @returns {sap.ui.unified.DateRange[]}
*/
public getSelectedDates(): sap.ui.unified.DateRange[];
/**
* Gets current value of property {@link #getShowWeekNumbers showWeekNumbers}.
*
* Determines whether the week numbers in the months are displayed.
*
* Note: For Islamic calendars, the week numbers are not displayed
* regardless of what is set to this property.
*
* Default value is true
.
* @returns {boolean} Value of property showWeekNumbers
*/
public getShowWeekNumbers(): boolean;
/**
* Gets current value of property {@link #getSingleSelection singleSelection}.
*
* If set, only a single date or interval, if intervalSelection is enabled, can be selected
*
* Default value is true
.
* @returns {boolean} Value of property singleSelection
*/
public getSingleSelection(): boolean;
/**
* Gets content of aggregation {@link #getSpecialDates specialDates}.
*
* Dates or date ranges with type, to visualize special days in the Calendar
.
* If one day is assigned to more than one Type, only the first one will be used.
*
* To set a single date (instead of a range), set only the startDate
property
* of the {@link sap.ui.unified.DateRange} class.
*
* Note: Keep in mind that the NonWorking
type is for marking specific
* dates or date ranges as non-working, where if you need a weekly-reccuring non-working days
* (weekend), you should use the nonWorkingDays
property. Both the non-working
* days (from property) and dates (from aggregation) are visualized the same.
* @returns {sap.ui.unified.DateTypeRange[]}
*/
public getSpecialDates(): sap.ui.unified.DateTypeRange[];
/**
* Returns the first day of the displayed month.
*
* There might be some days of the previous month shown, but they can not be focused.
* @returns {Object} JavaScript date object for start date.
*/
public getStartDate(): Object;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of Calendar
*
* Note: There is a theme depending minimum width, so the calendar can not be set smaller.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.unified.DateRange
in the aggregation {@link #getDisabledDates disabledDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.DateRange} oDisabledDate - The disabledDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfDisabledDate(oDisabledDate: sap.ui.unified.DateRange): number;
/**
* Checks for the provided sap.ui.unified.DateRange
in the aggregation {@link #getSelectedDates selectedDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.DateRange} oSelectedDate - The selectedDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSelectedDate(oSelectedDate: sap.ui.unified.DateRange): number;
/**
* Checks for the provided sap.ui.unified.DateTypeRange
in the aggregation {@link #getSpecialDates specialDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - The specialDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): number;
/**
* Inserts a disabledDate into the aggregation {@link #getDisabledDates disabledDates}.
* @param {sap.ui.unified.DateRange} oDisabledDate - the disabledDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the disabledDate should be inserted at; for a negative value of iIndex
, the disabledDate is inserted at position 0; for a value greater than the current size of the aggregation, the disabledDate is inserted at the last position
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public insertDisabledDate(oDisabledDate: sap.ui.unified.DateRange, iIndex: number): sap.ui.unified.Calendar;
/**
* Inserts a selectedDate into the aggregation {@link #getSelectedDates selectedDates}.
* @param {sap.ui.unified.DateRange} oSelectedDate - the selectedDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the selectedDate should be inserted at; for a negative value of iIndex
, the selectedDate is inserted at position 0; for a value greater than the current size of the aggregation, the selectedDate is inserted at the last position
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public insertSelectedDate(oSelectedDate: sap.ui.unified.DateRange, iIndex: number): sap.ui.unified.Calendar;
/**
* Inserts a specialDate into the aggregation {@link #getSpecialDates specialDates}.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the specialDate should be inserted at; for a negative value of iIndex
, the specialDate is inserted at position 0; for a value greater than the current size of the aggregation, the specialDate is inserted at the last position
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public insertSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange, iIndex: number): sap.ui.unified.Calendar;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getDisabledDates disabledDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.DateRange[]} An array of the removed elements (might be empty)
*/
public removeAllDisabledDates(): sap.ui.unified.DateRange[];
/**
* Removes all the controls from the aggregation {@link #getSelectedDates selectedDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.DateRange[]} An array of the removed elements (might be empty)
*/
public removeAllSelectedDates(): sap.ui.unified.DateRange[];
/**
* Removes all the controls from the aggregation {@link #getSpecialDates specialDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.DateTypeRange[]} An array of the removed elements (might be empty)
*/
public removeAllSpecialDates(): sap.ui.unified.DateTypeRange[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a disabledDate from the aggregation {@link #getDisabledDates disabledDates}.
* @param {number|string|sap.ui.unified.DateRange} vDisabledDate - The disabledDate to remove or its index or id
* @returns {sap.ui.unified.DateRange} The removed disabledDate or null
*/
public removeDisabledDate(vDisabledDate: number|string|sap.ui.unified.DateRange): sap.ui.unified.DateRange;
/**
* Removes a selectedDate from the aggregation {@link #getSelectedDates selectedDates}.
* @param {number|string|sap.ui.unified.DateRange} vSelectedDate - The selectedDate to remove or its index or id
* @returns {sap.ui.unified.DateRange} The removed selectedDate or null
*/
public removeSelectedDate(vSelectedDate: number|string|sap.ui.unified.DateRange): sap.ui.unified.DateRange;
/**
* Removes a specialDate from the aggregation {@link #getSpecialDates specialDates}.
* @param {number|string|sap.ui.unified.DateTypeRange} vSpecialDate - The specialDate to remove or its index or id
* @returns {sap.ui.unified.DateTypeRange} The removed specialDate or null
*/
public removeSpecialDate(vSpecialDate: number|string|sap.ui.unified.DateTypeRange): sap.ui.unified.DateTypeRange;
/**
* Sets a new value for property {@link #getFirstDayOfWeek firstDayOfWeek}.
*
* If set, the first day of the displayed week is this day. Valid values are 0 to 6.
* If not a valid value is set, the default of the used locale is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is -1
.
* @param {number} iFirstDayOfWeek - New value for property firstDayOfWeek
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public setFirstDayOfWeek(iFirstDayOfWeek: number): sap.ui.unified.Calendar;
/**
* Sets a new value for property {@link #getIntervalSelection intervalSelection}.
*
* If set, interval selection is allowed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bIntervalSelection - New value for property intervalSelection
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public setIntervalSelection(bIntervalSelection: boolean): sap.ui.unified.Calendar;
/**
* Sets the associated {@link #getLegend legend}.
* @param {sap.ui.core.ID|sap.ui.unified.CalendarLegend} oLegend - ID of an element which becomes the new target of this legend association; alternatively, an element instance may be given
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public setLegend(oLegend: sap.ui.core.ID|sap.ui.unified.CalendarLegend): sap.ui.unified.Calendar;
/**
* Sets a new value for property {@link #getMonths months}.
*
* number of months displayed
* on phones always only one month is displayed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} iMonths - New value for property months
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public setMonths(iMonths: number): sap.ui.unified.Calendar;
/**
* Sets a new value for property {@link #getNonWorkingDays nonWorkingDays}.
*
* If set, the provided weekdays are displayed as non-working days.
* Valid values inside the array are 0 to 6.
* If not set, the weekend defined in the locale settings is displayed as non-working days.
*
* Note: Keep in mind that this property sets only weekly-recurring days
* as non-working. If you need specific dates or dates ranges, such as national
* holidays, use the specialDates
aggregation to set them.
* Both the non-working days (from property) and dates (from aggregation) are
* visualized the same.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number[]} sNonWorkingDays - New value for property nonWorkingDays
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public setNonWorkingDays(sNonWorkingDays: number[]): sap.ui.unified.Calendar;
/**
* Sets a new value for property {@link #getPrimaryCalendarType primaryCalendarType}.
*
* If set, the calendar type is used for display.
* If not set, the calendar type of the global configuration is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CalendarType} sPrimaryCalendarType - New value for property primaryCalendarType
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public setPrimaryCalendarType(sPrimaryCalendarType: sap.ui.core.CalendarType): sap.ui.unified.Calendar;
/**
* Sets a new value for property {@link #getSecondaryCalendarType secondaryCalendarType}.
*
* If set, the days are also displayed in this calendar type
* If not set, the dates are only displayed in the primary calendar type
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CalendarType} sSecondaryCalendarType - New value for property secondaryCalendarType
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public setSecondaryCalendarType(sSecondaryCalendarType: sap.ui.core.CalendarType): sap.ui.unified.Calendar;
/**
* Sets a new value for property {@link #getShowWeekNumbers showWeekNumbers}.
*
* Determines whether the week numbers in the months are displayed.
*
* Note: For Islamic calendars, the week numbers are not displayed
* regardless of what is set to this property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowWeekNumbers - New value for property showWeekNumbers
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public setShowWeekNumbers(bShowWeekNumbers: boolean): sap.ui.unified.Calendar;
/**
* Sets a new value for property {@link #getSingleSelection singleSelection}.
*
* If set, only a single date or interval, if intervalSelection is enabled, can be selected
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bSingleSelection - New value for property singleSelection
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public setSingleSelection(bSingleSelection: boolean): sap.ui.unified.Calendar;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of Calendar
*
* Note: There is a theme depending minimum width, so the calendar can not be set smaller.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.unified.Calendar} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.unified.Calendar;
}
/**
* An appointment for use in a PlanningCalendar
or similar. The rendering must be done in the Row collecting the appointments.
* (Because there are different visualizations possible.)
*
* Applications could inherit from this element to add own fields.
*/
export class CalendarAppointment extends sap.ui.unified.DateTypeRange {
/**
* Constructor for a new CalendarAppointment
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.unified.CalendarAppointment with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.unified.DateTypeRange.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getColor color}.
*
* Overrides the color derived from the type
property.
* This property will work only with full hex color with pound symbol, e.g.: #FF0000.
* @returns {sap.ui.core.CSSColor} Value of property color
*/
public getColor(): sap.ui.core.CSSColor;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Icon of the Appointment. (e.g. picture of the person)
*
* URI of an image or an icon registered in sap.ui.core.IconPool.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getKey key}.
*
* Can be used as identifier of the appointment
* @returns {string} Value of property key
*/
public getKey(): string;
/**
* Returns a metadata object for class sap.ui.unified.CalendarAppointment.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSelected selected}.
*
* Indicates if the icon is selected.
*
* Default value is false
.
* @returns {boolean} Value of property selected
*/
public getSelected(): boolean;
/**
* Gets current value of property {@link #getTentative tentative}.
*
* Indicates if the icon is tentative.
*
* Default value is false
.
* @returns {boolean} Value of property tentative
*/
public getTentative(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* Text of the appointment.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getTitle title}.
*
* Title of the appointment.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Sets a new value for property {@link #getColor color}.
*
* Overrides the color derived from the type
property.
* This property will work only with full hex color with pound symbol, e.g.: #FF0000.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSColor} sColor - New value for property color
* @returns {sap.ui.unified.CalendarAppointment} Reference to this
in order to allow method chaining
*/
public setColor(sColor: sap.ui.core.CSSColor): sap.ui.unified.CalendarAppointment;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Icon of the Appointment. (e.g. picture of the person)
*
* URI of an image or an icon registered in sap.ui.core.IconPool.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.unified.CalendarAppointment} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.unified.CalendarAppointment;
/**
* Sets a new value for property {@link #getKey key}.
*
* Can be used as identifier of the appointment
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sKey - New value for property key
* @returns {sap.ui.unified.CalendarAppointment} Reference to this
in order to allow method chaining
*/
public setKey(sKey: string): sap.ui.unified.CalendarAppointment;
/**
* Sets a new value for property {@link #getSelected selected}.
*
* Indicates if the icon is selected.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSelected - New value for property selected
* @returns {sap.ui.unified.CalendarAppointment} Reference to this
in order to allow method chaining
*/
public setSelected(bSelected: boolean): sap.ui.unified.CalendarAppointment;
/**
* Sets a new value for property {@link #getTentative tentative}.
*
* Indicates if the icon is tentative.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bTentative - New value for property tentative
* @returns {sap.ui.unified.CalendarAppointment} Reference to this
in order to allow method chaining
*/
public setTentative(bTentative: boolean): sap.ui.unified.CalendarAppointment;
/**
* Sets a new value for property {@link #getText text}.
*
* Text of the appointment.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.unified.CalendarAppointment} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.unified.CalendarAppointment;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Title of the appointment.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.unified.CalendarAppointment} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.unified.CalendarAppointment;
}
/**
* Visualization types for {@link sap.ui.unified.CalendarAppointment}.
*/
export enum CalendarAppointmentVisualization {
/**
* Visualization with fill color depending on the used theme.
*/
Filled = "Filled",
/**
* Standard visualization with no fill color.
*/
Standard = "Standard",
}
/**
* Calendar with dates displayed in one line.
*/
export class CalendarDateInterval extends sap.ui.unified.Calendar {
/**
* Constructor for a new CalendarDateInterval
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* If more than this number of days are displayed, start and end month are displayed on the button
* @returns {number}
*/
protected _getDaysLarge(): number;
/**
* Creates a new subclass of class sap.ui.unified.CalendarDateInterval with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.unified.Calendar.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getDays days}.
*
* number of days displayed
* on phones the maximum rendered number of days is 8.
*
* Default value is 7
.
* @returns {number} Value of property days
*/
public getDays(): number;
/**
* Returns a metadata object for class sap.ui.unified.CalendarDateInterval.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPickerPopup pickerPopup}.
*
* If set, the month- and yearPicker opens on a popup
*
* Default value is false
.
* @returns {boolean} Value of property pickerPopup
*/
public getPickerPopup(): boolean;
/**
* Gets current value of property {@link #getShowDayNamesLine showDayNamesLine}.
*
* If set the day names are shown in a separate line.
* If not set the day names are shown inside the single days.
*
* Default value is true
.
* @returns {boolean} Value of property showDayNamesLine
*/
public getShowDayNamesLine(): boolean;
/**
* Gets current value of property {@link #getStartDate startDate}.
*
* Start date of the Interval
* @returns {Object} Value of property startDate
*/
public getStartDate(): Object;
/**
* Sets a new value for property {@link #getDays days}.
*
* number of days displayed
* on phones the maximum rendered number of days is 8.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 7
.
* @param {number} iDays - New value for property days
* @returns {sap.ui.unified.CalendarDateInterval} Reference to this
in order to allow method chaining
*/
public setDays(iDays: number): sap.ui.unified.CalendarDateInterval;
/**
* Setter for property firstDayOfWeek
.
*
* Property firstDayOfWeek
is not supported in sap.ui.unified.CalendarDateInterval
control.
* @param {number} iFirstDayOfWeek - first day of the week
* @returns {sap.ui.unified.CalendarDateInterval}
*/
public setFirstDayOfWeek(iFirstDayOfWeek?: number): sap.ui.unified.CalendarDateInterval;
/**
* Setter for property months
.
*
* Property months
is not supported in sap.ui.unified.CalendarDateInterval
control.
* @param {number} iMonths - months
* @returns {sap.ui.unified.CalendarDateInterval}
*/
public setMonths(iMonths?: number): sap.ui.unified.CalendarDateInterval;
/**
* Sets a new value for property {@link #getPickerPopup pickerPopup}.
*
* If set, the month- and yearPicker opens on a popup
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bPickerPopup - New value for property pickerPopup
* @returns {sap.ui.unified.CalendarDateInterval} Reference to this
in order to allow method chaining
*/
public setPickerPopup(bPickerPopup: boolean): sap.ui.unified.CalendarDateInterval;
/**
* Sets a new value for property {@link #getShowDayNamesLine showDayNamesLine}.
*
* If set the day names are shown in a separate line.
* If not set the day names are shown inside the single days.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowDayNamesLine - New value for property showDayNamesLine
* @returns {sap.ui.unified.CalendarDateInterval} Reference to this
in order to allow method chaining
*/
public setShowDayNamesLine(bShowDayNamesLine: boolean): sap.ui.unified.CalendarDateInterval;
/**
* Sets a new value for property {@link #getStartDate startDate}.
*
* Start date of the Interval
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oStartDate - New value for property startDate
* @returns {sap.ui.unified.CalendarDateInterval} Reference to this
in order to allow method chaining
*/
public setStartDate(oStartDate: any): sap.ui.unified.CalendarDateInterval;
}
/**
* Types of a calendar day used for visualization.
*/
export enum CalendarDayType {
/**
* No special type is used.
*/
None = "None",
/**
* Non-working dates.
*/
NonWorking = "NonWorking",
/**
* The semantic meaning must be defined by the app. It can be displayed in a legend.
*/
Type01 = "Type01",
/**
* The semantic meaning must be defined by the app. It can be displayed in a legend.
*/
Type02 = "Type02",
/**
* The semantic meaning must be defined by the app. It can be displayed in a legend.
*/
Type03 = "Type03",
/**
* The semantic meaning must be defined by the app. It can be displayed in a legend.
*/
Type04 = "Type04",
/**
* The semantic meaning must be defined by the app. It can be displayed in a legend.
*/
Type05 = "Type05",
/**
* The semantic meaning must be defined by the app. It can be displayed in a legend.
*/
Type06 = "Type06",
/**
* The semantic meaning must be defined by the app. It can be displayed in a legend.
*/
Type07 = "Type07",
/**
* The semantic meaning must be defined by the app. It can be displayed in a legend.
*/
Type08 = "Type08",
/**
* The semantic meaning must be defined by the app. It can be displayed in a legend.
*/
Type09 = "Type09",
/**
* The semantic meaning must be defined by the app. It can be displayed in a legend.
*/
Type10 = "Type10",
}
/**
* Interval types in a CalendarRow
.
*/
export enum CalendarIntervalType {
/**
* Intervals have the size of one day.
*/
Day = "Day",
/**
* Intervals have the size of one hour.
*/
Hour = "Hour",
/**
* Intervals have the size of one month.
*/
Month = "Month",
}
/**
* A legend for the Calendar Control. Displays special dates colors with their corresponding description. The aggregation specialDates can be set herefor.
*/
export class CalendarLegend extends sap.ui.core.Control {
/**
* Constructor for a new CalendarLegend.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.ui.unified.CalendarLegendItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.ui.unified.CalendarLegend} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.ui.unified.CalendarLegendItem): sap.ui.unified.CalendarLegend;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.ui.unified.CalendarLegend} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.ui.unified.CalendarLegend;
/**
* Creates a new subclass of class sap.ui.unified.CalendarLegend with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getColumnWidth columnWidth}.
*
* Width of the columns created in which the items are arranged.
*
* Default value is 120px
.
* @returns {sap.ui.core.CSSSize} Value of property columnWidth
*/
public getColumnWidth(): sap.ui.core.CSSSize;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Items to be displayed.
* @returns {sap.ui.unified.CalendarLegendItem[]}
*/
public getItems(): sap.ui.unified.CalendarLegendItem[];
/**
* Returns a metadata object for class sap.ui.unified.CalendarLegend.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.unified.CalendarLegendItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.CalendarLegendItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.unified.CalendarLegendItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.ui.unified.CalendarLegendItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.ui.unified.CalendarLegend} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.ui.unified.CalendarLegendItem, iIndex: number): sap.ui.unified.CalendarLegend;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.CalendarLegendItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.ui.unified.CalendarLegendItem[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.ui.unified.CalendarLegendItem} vItem - The item to remove or its index or id
* @returns {sap.ui.unified.CalendarLegendItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.ui.unified.CalendarLegendItem): sap.ui.unified.CalendarLegendItem;
/**
* Sets a new value for property {@link #getColumnWidth columnWidth}.
*
* Width of the columns created in which the items are arranged.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 120px
.
* @param {sap.ui.core.CSSSize} sColumnWidth - New value for property columnWidth
* @returns {sap.ui.unified.CalendarLegend} Reference to this
in order to allow method chaining
*/
public setColumnWidth(sColumnWidth: sap.ui.core.CSSSize): sap.ui.unified.CalendarLegend;
}
/**
* Item to be displayed in a CalendarLegend.
*/
export class CalendarLegendItem extends sap.ui.core.Element {
/**
* Constructor for a new CalendarLegendItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.unified.CalendarLegendItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getColor color}.
*
* Overrides the color derived from the type
property.
* @returns {sap.ui.core.CSSColor} Value of property color
*/
public getColor(): sap.ui.core.CSSColor;
/**
* Returns a metadata object for class sap.ui.unified.CalendarLegendItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* Text to be displayed for the item.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getType type}.
*
* Type of the item.
* If not set the type is automatically determined from the order of the items in the CalendarLegend.
*
* Default value is None
.
* @returns {sap.ui.unified.CalendarDayType} Value of property type
*/
public getType(): sap.ui.unified.CalendarDayType;
/**
* Sets a new value for property {@link #getColor color}.
*
* Overrides the color derived from the type
property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSColor} sColor - New value for property color
* @returns {sap.ui.unified.CalendarLegendItem} Reference to this
in order to allow method chaining
*/
public setColor(sColor: sap.ui.core.CSSColor): sap.ui.unified.CalendarLegendItem;
/**
* Sets a new value for property {@link #getText text}.
*
* Text to be displayed for the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.unified.CalendarLegendItem} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.unified.CalendarLegendItem;
/**
* Sets a new value for property {@link #getType type}.
*
* Type of the item.
* If not set the type is automatically determined from the order of the items in the CalendarLegend.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.unified.CalendarDayType} sType - New value for property type
* @returns {sap.ui.unified.CalendarLegendItem} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.ui.unified.CalendarDayType): sap.ui.unified.CalendarLegendItem;
}
/**
* Calendar with granularity of months displayed in one line.
*
* Note: JavaScript Date objects are used to set and return the months, mark them as selected or as a special type.
* But the date part of the Date object is not used. If a Date object is returned the date will be set to the 1st of the corresponding month.
*/
export class CalendarMonthInterval extends sap.ui.core.Control {
/**
* Constructor for a new CalendarMonthInterval
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {Object} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: Object);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.unified.CalendarMonthInterval;
/**
* Adds some selectedDate to the aggregation {@link #getSelectedDates selectedDates}.
* @param {sap.ui.unified.DateRange} oSelectedDate - the selectedDate to add; if empty, nothing is inserted
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public addSelectedDate(oSelectedDate: sap.ui.unified.DateRange): sap.ui.unified.CalendarMonthInterval;
/**
* Adds some specialDate to the aggregation {@link #getSpecialDates specialDates}.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to add; if empty, nothing is inserted
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public addSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): sap.ui.unified.CalendarMonthInterval;
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.ui.unified.CalendarMonthInterval
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarMonthInterval
itself.
*
* Month selection was cancelled
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarMonthInterval
itself
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public attachCancel(fnFunction: Function, oListener?: any): sap.ui.unified.CalendarMonthInterval;
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.ui.unified.CalendarMonthInterval
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarMonthInterval
itself.
*
* Month selection was cancelled
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarMonthInterval
itself
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public attachCancel(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.CalendarMonthInterval;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.CalendarMonthInterval
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarMonthInterval
itself.
*
* Month selection changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarMonthInterval
itself
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.unified.CalendarMonthInterval;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.CalendarMonthInterval
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarMonthInterval
itself.
*
* Month selection changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarMonthInterval
itself
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.CalendarMonthInterval;
/**
* Attaches event handler fnFunction
to the {@link #event:startDateChange startDateChange} event of this sap.ui.unified.CalendarMonthInterval
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarMonthInterval
itself.
*
* startDate
was changed while navigation in CalendarMonthInterval
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarMonthInterval
itself
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public attachStartDateChange(fnFunction: Function, oListener?: any): sap.ui.unified.CalendarMonthInterval;
/**
* Attaches event handler fnFunction
to the {@link #event:startDateChange startDateChange} event of this sap.ui.unified.CalendarMonthInterval
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarMonthInterval
itself.
*
* startDate
was changed while navigation in CalendarMonthInterval
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarMonthInterval
itself
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public attachStartDateChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.CalendarMonthInterval;
/**
* Destroys all the selectedDates in the aggregation {@link #getSelectedDates selectedDates}.
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public destroySelectedDates(): sap.ui.unified.CalendarMonthInterval;
/**
* Destroys all the specialDates in the aggregation {@link #getSpecialDates specialDates}.
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public destroySpecialDates(): sap.ui.unified.CalendarMonthInterval;
/**
* Detaches event handler fnFunction
from the {@link #event:cancel cancel} event of this sap.ui.unified.CalendarMonthInterval
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public detachCancel(fnFunction: Function, oListener: any): sap.ui.unified.CalendarMonthInterval;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.unified.CalendarMonthInterval
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.unified.CalendarMonthInterval;
/**
* Detaches event handler fnFunction
from the {@link #event:startDateChange startDateChange} event of this sap.ui.unified.CalendarMonthInterval
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public detachStartDateChange(fnFunction: Function, oListener: any): sap.ui.unified.CalendarMonthInterval;
/**
* Displays a month in the CalendarMonthInterval
but doesn't set the focus.
* @param {Object} oDatetime - JavaScript date object for displayed date. (The month of this date will be displayed.)
* @returns {sap.ui.unified.CalendarMonthInterval} this
to allow method chaining
*/
public displayDate(oDatetime: Object): sap.ui.unified.CalendarMonthInterval;
/**
* Creates a new subclass of class sap.ui.unified.CalendarMonthInterval with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:cancel cancel} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
protected fireCancel(mParameters?: any): sap.ui.unified.CalendarMonthInterval;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.unified.CalendarMonthInterval;
/**
* Fires event {@link #event:startDateChange startDateChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
protected fireStartDateChange(mParameters?: any): sap.ui.unified.CalendarMonthInterval;
/**
* Sets the focused month of the CalendarMonthInterval
.
* @param {Object} oDatetime - JavaScript date object for focused date. (The month of this date will be focused.)
* @returns {sap.ui.unified.Calendar} this
to allow method chaining
*/
public focusDate(oDatetime: Object): sap.ui.unified.Calendar;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getIntervalSelection intervalSelection}.
*
* If set, interval selection is allowed
*
* Default value is false
.
* @returns {boolean} Value of property intervalSelection
*/
public getIntervalSelection(): boolean;
/**
* ID of the element which is the current target of the association {@link #getLegend legend}, or null
.
* @returns {sap.ui.core.ID}
*/
public getLegend(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getMaxDate maxDate}.
*
* Maximum date that can be shown and selected in the Calendar. This must be a JavaScript date object.
*
* Note: If the maxDate
is set to be before the minDate
,
* the minDate
is set to the begin of the month of the maxDate
.
* @returns {any} Value of property maxDate
*/
public getMaxDate(): any;
/**
* Returns a metadata object for class sap.ui.unified.CalendarMonthInterval.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinDate minDate}.
*
* Minimum date that can be shown and selected in the Calendar. This must be a JavaScript date object.
*
* Note: If the minDate
is set to be after the maxDate
,
* the maxDate
is set to the end of the month of the minDate
.
* @returns {any} Value of property minDate
*/
public getMinDate(): any;
/**
* Gets current value of property {@link #getMonths months}.
*
* Number of months displayed
*
* Note: On phones, the maximum number of months displayed in the row is always 6.
*
* Default value is 12
.
* @returns {number} Value of property months
*/
public getMonths(): number;
/**
* Gets current value of property {@link #getPickerPopup pickerPopup}.
*
* If set, the yearPicker opens on a popup
*
* Default value is false
.
* @returns {boolean} Value of property pickerPopup
*/
public getPickerPopup(): boolean;
/**
* Gets content of aggregation {@link #getSelectedDates selectedDates}.
*
* Date ranges for selected dates of the CalendarMonthInterval
.
*
* If singleSelection
is set, only the first entry is used.
*
* Note: Even if only one day is selected, the whole corresponding month is selected.
* @returns {sap.ui.unified.DateRange[]}
*/
public getSelectedDates(): sap.ui.unified.DateRange[];
/**
* Gets current value of property {@link #getSingleSelection singleSelection}.
*
* If set, only a single date or interval, if intervalSelection
is enabled, can be selected
*
* Note: Selection of multiple intervals is not supported in the current version.
*
* Default value is true
.
* @returns {boolean} Value of property singleSelection
*/
public getSingleSelection(): boolean;
/**
* Gets content of aggregation {@link #getSpecialDates specialDates}.
*
* Date ranges with type to visualize special months in the CalendarMonthInterval
.
* If one day is assigned to more than one type, only the first one will be used.
*
* Note: Even if only one day is set as a special day, the whole corresponding month is displayed in this way.
* @returns {sap.ui.unified.DateTypeRange[]}
*/
public getSpecialDates(): sap.ui.unified.DateTypeRange[];
/**
* Gets current value of property {@link #getStartDate startDate}.
*
* Start date of the Interval as JavaScript Date object.
* The month of this Date will be the first month in the displayed row.
* @returns {any} Value of property startDate
*/
public getStartDate(): any;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the CalendarMonthInterval
. The width of the single months depends on this width.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.unified.DateRange
in the aggregation {@link #getSelectedDates selectedDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.DateRange} oSelectedDate - The selectedDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSelectedDate(oSelectedDate: sap.ui.unified.DateRange): number;
/**
* Checks for the provided sap.ui.unified.DateTypeRange
in the aggregation {@link #getSpecialDates specialDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - The specialDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): number;
/**
* Inserts a selectedDate into the aggregation {@link #getSelectedDates selectedDates}.
* @param {sap.ui.unified.DateRange} oSelectedDate - the selectedDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the selectedDate should be inserted at; for a negative value of iIndex
, the selectedDate is inserted at position 0; for a value greater than the current size of the aggregation, the selectedDate is inserted at the last position
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public insertSelectedDate(oSelectedDate: sap.ui.unified.DateRange, iIndex: number): sap.ui.unified.CalendarMonthInterval;
/**
* Inserts a specialDate into the aggregation {@link #getSpecialDates specialDates}.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the specialDate should be inserted at; for a negative value of iIndex
, the specialDate is inserted at position 0; for a value greater than the current size of the aggregation, the specialDate is inserted at the last position
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public insertSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange, iIndex: number): sap.ui.unified.CalendarMonthInterval;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getSelectedDates selectedDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.DateRange[]} An array of the removed elements (might be empty)
*/
public removeAllSelectedDates(): sap.ui.unified.DateRange[];
/**
* Removes all the controls from the aggregation {@link #getSpecialDates specialDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.DateTypeRange[]} An array of the removed elements (might be empty)
*/
public removeAllSpecialDates(): sap.ui.unified.DateTypeRange[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a selectedDate from the aggregation {@link #getSelectedDates selectedDates}.
* @param {number|string|sap.ui.unified.DateRange} vSelectedDate - The selectedDate to remove or its index or id
* @returns {sap.ui.unified.DateRange} The removed selectedDate or null
*/
public removeSelectedDate(vSelectedDate: number|string|sap.ui.unified.DateRange): sap.ui.unified.DateRange;
/**
* Removes a specialDate from the aggregation {@link #getSpecialDates specialDates}.
* @param {number|string|sap.ui.unified.DateTypeRange} vSpecialDate - The specialDate to remove or its index or id
* @returns {sap.ui.unified.DateTypeRange} The removed specialDate or null
*/
public removeSpecialDate(vSpecialDate: number|string|sap.ui.unified.DateTypeRange): sap.ui.unified.DateTypeRange;
/**
* Sets a new value for property {@link #getIntervalSelection intervalSelection}.
*
* If set, interval selection is allowed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bIntervalSelection - New value for property intervalSelection
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public setIntervalSelection(bIntervalSelection: boolean): sap.ui.unified.CalendarMonthInterval;
/**
* Sets the associated {@link #getLegend legend}.
* @param {sap.ui.core.ID|sap.ui.unified.CalendarLegend} oLegend - ID of an element which becomes the new target of this legend association; alternatively, an element instance may be given
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public setLegend(oLegend: sap.ui.core.ID|sap.ui.unified.CalendarLegend): sap.ui.unified.CalendarMonthInterval;
/**
* Sets a new value for property {@link #getMaxDate maxDate}.
*
* Maximum date that can be shown and selected in the Calendar. This must be a JavaScript date object.
*
* Note: If the maxDate
is set to be before the minDate
,
* the minDate
is set to the begin of the month of the maxDate
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oMaxDate - New value for property maxDate
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public setMaxDate(oMaxDate: any): sap.ui.unified.CalendarMonthInterval;
/**
* Sets a new value for property {@link #getMinDate minDate}.
*
* Minimum date that can be shown and selected in the Calendar. This must be a JavaScript date object.
*
* Note: If the minDate
is set to be after the maxDate
,
* the maxDate
is set to the end of the month of the minDate
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oMinDate - New value for property minDate
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public setMinDate(oMinDate: any): sap.ui.unified.CalendarMonthInterval;
/**
* Sets a new value for property {@link #getMonths months}.
*
* Number of months displayed
*
* Note: On phones, the maximum number of months displayed in the row is always 6.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 12
.
* @param {number} iMonths - New value for property months
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public setMonths(iMonths: number): sap.ui.unified.CalendarMonthInterval;
/**
* Sets a new value for property {@link #getPickerPopup pickerPopup}.
*
* If set, the yearPicker opens on a popup
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bPickerPopup - New value for property pickerPopup
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public setPickerPopup(bPickerPopup: boolean): sap.ui.unified.CalendarMonthInterval;
/**
* Sets a new value for property {@link #getSingleSelection singleSelection}.
*
* If set, only a single date or interval, if intervalSelection
is enabled, can be selected
*
* Note: Selection of multiple intervals is not supported in the current version.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bSingleSelection - New value for property singleSelection
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public setSingleSelection(bSingleSelection: boolean): sap.ui.unified.CalendarMonthInterval;
/**
* Sets a new value for property {@link #getStartDate startDate}.
*
* Start date of the Interval as JavaScript Date object.
* The month of this Date will be the first month in the displayed row.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oStartDate - New value for property startDate
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public setStartDate(oStartDate: any): sap.ui.unified.CalendarMonthInterval;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of the CalendarMonthInterval
. The width of the single months depends on this width.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.unified.CalendarMonthInterval} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.unified.CalendarMonthInterval;
}
/**
* A calendar row with a header and appointments. The Appointments will be placed in the defined interval.
*/
export class CalendarRow extends sap.ui.core.Control {
/**
* Constructor for a new CalendarRow
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some appointment to the aggregation {@link #getAppointments appointments}.
* @param {sap.ui.unified.CalendarAppointment} oAppointment - the appointment to add; if empty, nothing is inserted
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public addAppointment(oAppointment: sap.ui.unified.CalendarAppointment): sap.ui.unified.CalendarRow;
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.unified.CalendarRow;
/**
* Adds some intervalHeader to the aggregation {@link #getIntervalHeaders intervalHeaders}.
* @param {sap.ui.unified.CalendarAppointment} oIntervalHeader - the intervalHeader to add; if empty, nothing is inserted
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public addIntervalHeader(oIntervalHeader: sap.ui.unified.CalendarAppointment): sap.ui.unified.CalendarRow;
/**
* Attaches event handler fnFunction
to the {@link #event:intervalSelect intervalSelect} event of this sap.ui.unified.CalendarRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarRow
itself.
*
* Fired if an interval was selected
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarRow
itself
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public attachIntervalSelect(fnFunction: Function, oListener?: any): sap.ui.unified.CalendarRow;
/**
* Attaches event handler fnFunction
to the {@link #event:intervalSelect intervalSelect} event of this sap.ui.unified.CalendarRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarRow
itself.
*
* Fired if an interval was selected
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarRow
itself
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public attachIntervalSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.CalendarRow;
/**
* Attaches event handler fnFunction
to the {@link #event:leaveRow leaveRow} event of this sap.ui.unified.CalendarRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarRow
itself.
*
* The CalendarRow
should be left while navigating. (Arrow up or arrow down.)
* The caller should determine the next control to be focused
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarRow
itself
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public attachLeaveRow(fnFunction: Function, oListener?: any): sap.ui.unified.CalendarRow;
/**
* Attaches event handler fnFunction
to the {@link #event:leaveRow leaveRow} event of this sap.ui.unified.CalendarRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarRow
itself.
*
* The CalendarRow
should be left while navigating. (Arrow up or arrow down.)
* The caller should determine the next control to be focused
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarRow
itself
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public attachLeaveRow(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.CalendarRow;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.CalendarRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarRow
itself.
*
* Fired if an appointment was selected
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarRow
itself
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.unified.CalendarRow;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.CalendarRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarRow
itself.
*
* Fired if an appointment was selected
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarRow
itself
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.CalendarRow;
/**
* Attaches event handler fnFunction
to the {@link #event:startDateChange startDateChange} event of this sap.ui.unified.CalendarRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarRow
itself.
*
* startDate
was changed while navigating in CalendarRow
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarRow
itself
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public attachStartDateChange(fnFunction: Function, oListener?: any): sap.ui.unified.CalendarRow;
/**
* Attaches event handler fnFunction
to the {@link #event:startDateChange startDateChange} event of this sap.ui.unified.CalendarRow
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarRow
itself.
*
* startDate
was changed while navigating in CalendarRow
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarRow
itself
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public attachStartDateChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.CalendarRow;
/**
* Destroys all the appointments in the aggregation {@link #getAppointments appointments}.
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public destroyAppointments(): sap.ui.unified.CalendarRow;
/**
* Destroys all the intervalHeaders in the aggregation {@link #getIntervalHeaders intervalHeaders}.
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public destroyIntervalHeaders(): sap.ui.unified.CalendarRow;
/**
* Detaches event handler fnFunction
from the {@link #event:intervalSelect intervalSelect} event of this sap.ui.unified.CalendarRow
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public detachIntervalSelect(fnFunction: Function, oListener: any): sap.ui.unified.CalendarRow;
/**
* Detaches event handler fnFunction
from the {@link #event:leaveRow leaveRow} event of this sap.ui.unified.CalendarRow
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public detachLeaveRow(fnFunction: Function, oListener: any): sap.ui.unified.CalendarRow;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.unified.CalendarRow
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.unified.CalendarRow;
/**
* Detaches event handler fnFunction
from the {@link #event:startDateChange startDateChange} event of this sap.ui.unified.CalendarRow
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public detachStartDateChange(fnFunction: Function, oListener: any): sap.ui.unified.CalendarRow;
/**
* Creates a new subclass of class sap.ui.unified.CalendarRow with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:intervalSelect intervalSelect} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
protected fireIntervalSelect(mParameters?: any): sap.ui.unified.CalendarRow;
/**
* Fires event {@link #event:leaveRow leaveRow} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
protected fireLeaveRow(mParameters?: any): sap.ui.unified.CalendarRow;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.unified.CalendarRow;
/**
* Fires event {@link #event:startDateChange startDateChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
protected fireStartDateChange(mParameters?: any): sap.ui.unified.CalendarRow;
/**
* Focus the given CalendarAppointment
in the CalendarRow
.
* @param {sap.ui.unified.CalendarAppointment} oAppointment - Appointment to be focused.
* @returns {sap.ui.unified.CalendarRow} this
to allow method chaining
*/
public focusAppointment(oAppointment: sap.ui.unified.CalendarAppointment): sap.ui.unified.CalendarRow;
/**
* Focus the CalendarAppointment
in the CalendarRow
that is nearest to
* the given date.
* @param {any} oDate - Javascript Date object.
* @returns {sap.ui.unified.CalendarRow} this
to allow method chaining
*/
public focusNearestAppointment(oDate: any): sap.ui.unified.CalendarRow;
/**
* Gets content of aggregation {@link #getAppointments appointments}.
*
* Appointments to be displayed in the row. Appointments outside the visible time frame are not rendered.
*
* Note: For performance reasons, only appointments in the visible time range or nearby should be assigned.
* @returns {sap.ui.unified.CalendarAppointment[]}
*/
public getAppointments(): sap.ui.unified.CalendarAppointment[];
/**
* Gets current value of property {@link #getAppointmentsReducedHeight appointmentsReducedHeight}.
*
* If set the appointments without text (only title) are rendered with a smaller height.
*
* Note: On phone devices this property is ignored, appointments are always rendered in full height
* to allow touching.
*
* Default value is false
.
* @returns {boolean} Value of property appointmentsReducedHeight
*/
public getAppointmentsReducedHeight(): boolean;
/**
* Gets current value of property {@link #getAppointmentsVisualization appointmentsVisualization}.
*
* Defines the visualization of the CalendarAppoinment
*
* Note: The real visualization depends on the used theme.
*
* Default value is Standard
.
* @returns {sap.ui.unified.CalendarAppointmentVisualization} Value of property appointmentsVisualization
*/
public getAppointmentsVisualization(): sap.ui.unified.CalendarAppointmentVisualization;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getCheckResize checkResize}.
*
* If set, the CalendarRow
checks for resize by itself.
*
* If a lot of CalendarRow
controls are used in one container control (like PlanningCalendar
).
* the resize checks should be done only by this container control. Then the container control should
* call handleResize
of the CalendarRow
if a resize happens.
*
* Default value is true
.
* @returns {boolean} Value of property checkResize
*/
public getCheckResize(): boolean;
/**
* Returns the focused CalendarAppointment
of the CalendarRow
.
*
* The focus must not really be on the CalendarAppointment
, it have just to
* be the one that has the focus when the CalendarRow
was focused last time.
* @returns {sap.ui.unified.CalendarAppointment} Focused Appointment
*/
public getFocusedAppointment(): sap.ui.unified.CalendarAppointment;
/**
* Gets current value of property {@link #getGroupAppointmentsMode groupAppointmentsMode}.
*
* Defines the mode in which the overlapping appointments are displayed.
*
* Note: This property takes effect, only if the intervalType
of the current calendar view
* is set to sap.ui.unified.CalendarIntervalType.Month
. On phone devices this property is ignored,
* and the default value is applied.
*
* Default value is Collapsed
.
* @returns {sap.ui.unified.GroupAppointmentsMode} Value of property groupAppointmentsMode
*/
public getGroupAppointmentsMode(): sap.ui.unified.GroupAppointmentsMode;
/**
* Gets current value of property {@link #getHeight height}.
*
* Height of the row
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets content of aggregation {@link #getIntervalHeaders intervalHeaders}.
*
* Appointments to be displayed in the top of the intervals. The intervalHeaders
are used to visualize
* public holidays and similar things.
*
* Appointments outside the visible time frame are not rendered.
*
* The intervalHeaders
always fill whole intervals. If they are shorter than one interval, they are not displayed.
*
* Note: For performance reasons, only appointments in the visible time range or nearby should be assigned.
* @returns {sap.ui.unified.CalendarAppointment[]}
*/
public getIntervalHeaders(): sap.ui.unified.CalendarAppointment[];
/**
* Gets current value of property {@link #getIntervals intervals}.
*
* Number of displayed intervals. The size of the intervals is defined with intervalType
*
* Default value is 12
.
* @returns {number} Value of property intervals
*/
public getIntervals(): number;
/**
* Gets current value of property {@link #getIntervalType intervalType}.
*
* Type of the intervals of the row. The default is one hour.
*
* Default value is Hour
.
* @returns {sap.ui.unified.CalendarIntervalType} Value of property intervalType
*/
public getIntervalType(): sap.ui.unified.CalendarIntervalType;
/**
* ID of the element which is the current target of the association {@link #getLegend legend}, or null
.
* @returns {sap.ui.core.ID}
*/
public getLegend(): sap.ui.core.ID;
/**
* Returns a metadata object for class sap.ui.unified.CalendarRow.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getNonWorkingDays nonWorkingDays}.
*
* If set, the provided weekdays are displayed as non-working days.
* Valid values inside the array are 0 to 6. (Other values will just be ignored.)
*
* If not set, the weekend defined in the locale settings is displayed as non-working days.
*
* Note: The non working days are only visualized if intervalType
is set to day.
* @returns {number[]} Value of property nonWorkingDays
*/
public getNonWorkingDays(): number[];
/**
* Gets current value of property {@link #getNonWorkingHours nonWorkingHours}.
*
* If set, the provided hours are displayed as non-working hours.
* Valid values inside the array are 0 to 23. (Other values will just be ignored.)
*
* Note: The non working hours are only visualized if intervalType
is set to hour.
* @returns {number[]} Value of property nonWorkingHours
*/
public getNonWorkingHours(): number[];
/**
* Gets current value of property {@link #getShowEmptyIntervalHeaders showEmptyIntervalHeaders}.
*
* If set, interval headers are shown even if no intervalHeaders
are assigned to the visible time frame.
*
* If not set, no interval headers are shown if no intervalHeaders
are assigned.
*
* Note: This property is only used if showIntervalHeaders
is set to true.
*
* Default value is true
.
* @returns {boolean} Value of property showEmptyIntervalHeaders
*/
public getShowEmptyIntervalHeaders(): boolean;
/**
* Gets current value of property {@link #getShowIntervalHeaders showIntervalHeaders}.
*
* If set, interval headers are shown like specified in showEmptyIntervalHeaders
.
*
* If not set, no interval headers are shown even if intervalHeaders
are assigned.
*
* Default value is true
.
* @returns {boolean} Value of property showIntervalHeaders
*/
public getShowIntervalHeaders(): boolean;
/**
* Gets current value of property {@link #getShowSubIntervals showSubIntervals}.
*
* If set, subintervals are shown.
*
* If the interval type is Hour
, quarter hours are shown.
*
* If the interval type is Day
, hours are shown.
*
* If the interval type is Month
, days are shown.
*
* Default value is false
.
* @returns {boolean} Value of property showSubIntervals
*/
public getShowSubIntervals(): boolean;
/**
* Gets current value of property {@link #getStartDate startDate}.
*
* Start date, as JavaScript Date object, of the row. As default, the current date is used.
* @returns {any} Value of property startDate
*/
public getStartDate(): any;
/**
* Gets current value of property {@link #getUpdateCurrentTime updateCurrentTime}.
*
* If set the CalendarRow
triggers a periodic update to visualize the current time.
*
* If a lot of CalendarRow
controls are used in one container control (like PlanningCalendar
)
* the periodic update should be triggered only by this container control. Then the container control should
* call updateCurrentTimeVisualization
of the CalendarRow
to update the visualization.
*
* Default value is true
.
* @returns {boolean} Value of property updateCurrentTime
*/
public getUpdateCurrentTime(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the row
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* After a resize of the CalendarRow
, some calculations for appointment
* sizes are needed.
*
* For this, each CalendarRow
can trigger the resize check for it's own DOM.
* But if multiple CalendarRow
s are used in one container (e.g. PlanningCalendar
),
* it is better if the container triggers the resize check once and then calls this function
* of each CalendarRow
.
* @param {JQueryEventObject} oEvent - The event object of the resize handler.
* @returns {sap.ui.unified.CalendarRow} this
to allow method chaining
*/
public handleResize(oEvent: JQueryEventObject): sap.ui.unified.CalendarRow;
/**
* Checks for the provided sap.ui.unified.CalendarAppointment
in the aggregation {@link #getAppointments appointments}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.CalendarAppointment} oAppointment - The appointment whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAppointment(oAppointment: sap.ui.unified.CalendarAppointment): number;
/**
* Checks for the provided sap.ui.unified.CalendarAppointment
in the aggregation {@link #getIntervalHeaders intervalHeaders}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.CalendarAppointment} oIntervalHeader - The intervalHeader whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfIntervalHeader(oIntervalHeader: sap.ui.unified.CalendarAppointment): number;
/**
* Inserts a appointment into the aggregation {@link #getAppointments appointments}.
* @param {sap.ui.unified.CalendarAppointment} oAppointment - the appointment to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the appointment should be inserted at; for a negative value of iIndex
, the appointment is inserted at position 0; for a value greater than the current size of the aggregation, the appointment is inserted at the last position
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public insertAppointment(oAppointment: sap.ui.unified.CalendarAppointment, iIndex: number): sap.ui.unified.CalendarRow;
/**
* Inserts a intervalHeader into the aggregation {@link #getIntervalHeaders intervalHeaders}.
* @param {sap.ui.unified.CalendarAppointment} oIntervalHeader - the intervalHeader to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the intervalHeader should be inserted at; for a negative value of iIndex
, the intervalHeader is inserted at position 0; for a value greater than the current size of the aggregation, the intervalHeader is inserted at the last position
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public insertIntervalHeader(oIntervalHeader: sap.ui.unified.CalendarAppointment, iIndex: number): sap.ui.unified.CalendarRow;
/**
* Removes all the controls from the aggregation {@link #getAppointments appointments}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.CalendarAppointment[]} An array of the removed elements (might be empty)
*/
public removeAllAppointments(): sap.ui.unified.CalendarAppointment[];
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getIntervalHeaders intervalHeaders}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.CalendarAppointment[]} An array of the removed elements (might be empty)
*/
public removeAllIntervalHeaders(): sap.ui.unified.CalendarAppointment[];
/**
* Removes a appointment from the aggregation {@link #getAppointments appointments}.
* @param {number|string|sap.ui.unified.CalendarAppointment} vAppointment - The appointment to remove or its index or id
* @returns {sap.ui.unified.CalendarAppointment} The removed appointment or null
*/
public removeAppointment(vAppointment: number|string|sap.ui.unified.CalendarAppointment): sap.ui.unified.CalendarAppointment;
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a intervalHeader from the aggregation {@link #getIntervalHeaders intervalHeaders}.
* @param {number|string|sap.ui.unified.CalendarAppointment} vIntervalHeader - The intervalHeader to remove or its index or id
* @returns {sap.ui.unified.CalendarAppointment} The removed intervalHeader or null
*/
public removeIntervalHeader(vIntervalHeader: number|string|sap.ui.unified.CalendarAppointment): sap.ui.unified.CalendarAppointment;
/**
* Sets a new value for property {@link #getAppointmentsReducedHeight appointmentsReducedHeight}.
*
* If set the appointments without text (only title) are rendered with a smaller height.
*
* Note: On phone devices this property is ignored, appointments are always rendered in full height
* to allow touching.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bAppointmentsReducedHeight - New value for property appointmentsReducedHeight
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setAppointmentsReducedHeight(bAppointmentsReducedHeight: boolean): sap.ui.unified.CalendarRow;
/**
* Sets a new value for property {@link #getAppointmentsVisualization appointmentsVisualization}.
*
* Defines the visualization of the CalendarAppoinment
*
* Note: The real visualization depends on the used theme.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.ui.unified.CalendarAppointmentVisualization} sAppointmentsVisualization - New value for property appointmentsVisualization
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setAppointmentsVisualization(sAppointmentsVisualization: sap.ui.unified.CalendarAppointmentVisualization): sap.ui.unified.CalendarRow;
/**
* Sets a new value for property {@link #getCheckResize checkResize}.
*
* If set, the CalendarRow
checks for resize by itself.
*
* If a lot of CalendarRow
controls are used in one container control (like PlanningCalendar
).
* the resize checks should be done only by this container control. Then the container control should
* call handleResize
of the CalendarRow
if a resize happens.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bCheckResize - New value for property checkResize
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setCheckResize(bCheckResize: boolean): sap.ui.unified.CalendarRow;
/**
* Sets a new value for property {@link #getGroupAppointmentsMode groupAppointmentsMode}.
*
* Defines the mode in which the overlapping appointments are displayed.
*
* Note: This property takes effect, only if the intervalType
of the current calendar view
* is set to sap.ui.unified.CalendarIntervalType.Month
. On phone devices this property is ignored,
* and the default value is applied.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Collapsed
.
* @param {sap.ui.unified.GroupAppointmentsMode} sGroupAppointmentsMode - New value for property groupAppointmentsMode
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setGroupAppointmentsMode(sGroupAppointmentsMode: sap.ui.unified.GroupAppointmentsMode): sap.ui.unified.CalendarRow;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Height of the row
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.unified.CalendarRow;
/**
* Sets a new value for property {@link #getIntervals intervals}.
*
* Number of displayed intervals. The size of the intervals is defined with intervalType
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 12
.
* @param {number} iIntervals - New value for property intervals
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setIntervals(iIntervals: number): sap.ui.unified.CalendarRow;
/**
* Sets a new value for property {@link #getIntervalType intervalType}.
*
* Type of the intervals of the row. The default is one hour.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Hour
.
* @param {sap.ui.unified.CalendarIntervalType} sIntervalType - New value for property intervalType
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setIntervalType(sIntervalType: sap.ui.unified.CalendarIntervalType): sap.ui.unified.CalendarRow;
/**
* Sets the associated {@link #getLegend legend}.
* @param {sap.ui.core.ID|sap.ui.unified.CalendarLegend} oLegend - ID of an element which becomes the new target of this legend association; alternatively, an element instance may be given
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setLegend(oLegend: sap.ui.core.ID|sap.ui.unified.CalendarLegend): sap.ui.unified.CalendarRow;
/**
* Sets a new value for property {@link #getNonWorkingDays nonWorkingDays}.
*
* If set, the provided weekdays are displayed as non-working days.
* Valid values inside the array are 0 to 6. (Other values will just be ignored.)
*
* If not set, the weekend defined in the locale settings is displayed as non-working days.
*
* Note: The non working days are only visualized if intervalType
is set to day.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number[]} sNonWorkingDays - New value for property nonWorkingDays
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setNonWorkingDays(sNonWorkingDays: number[]): sap.ui.unified.CalendarRow;
/**
* Sets a new value for property {@link #getNonWorkingHours nonWorkingHours}.
*
* If set, the provided hours are displayed as non-working hours.
* Valid values inside the array are 0 to 23. (Other values will just be ignored.)
*
* Note: The non working hours are only visualized if intervalType
is set to hour.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number[]} sNonWorkingHours - New value for property nonWorkingHours
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setNonWorkingHours(sNonWorkingHours: number[]): sap.ui.unified.CalendarRow;
/**
* Sets a new value for property {@link #getShowEmptyIntervalHeaders showEmptyIntervalHeaders}.
*
* If set, interval headers are shown even if no intervalHeaders
are assigned to the visible time frame.
*
* If not set, no interval headers are shown if no intervalHeaders
are assigned.
*
* Note: This property is only used if showIntervalHeaders
is set to true.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowEmptyIntervalHeaders - New value for property showEmptyIntervalHeaders
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setShowEmptyIntervalHeaders(bShowEmptyIntervalHeaders: boolean): sap.ui.unified.CalendarRow;
/**
* Sets a new value for property {@link #getShowIntervalHeaders showIntervalHeaders}.
*
* If set, interval headers are shown like specified in showEmptyIntervalHeaders
.
*
* If not set, no interval headers are shown even if intervalHeaders
are assigned.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowIntervalHeaders - New value for property showIntervalHeaders
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setShowIntervalHeaders(bShowIntervalHeaders: boolean): sap.ui.unified.CalendarRow;
/**
* Sets a new value for property {@link #getShowSubIntervals showSubIntervals}.
*
* If set, subintervals are shown.
*
* If the interval type is Hour
, quarter hours are shown.
*
* If the interval type is Day
, hours are shown.
*
* If the interval type is Month
, days are shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowSubIntervals - New value for property showSubIntervals
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setShowSubIntervals(bShowSubIntervals: boolean): sap.ui.unified.CalendarRow;
/**
* Sets a new value for property {@link #getStartDate startDate}.
*
* Start date, as JavaScript Date object, of the row. As default, the current date is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oStartDate - New value for property startDate
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setStartDate(oStartDate: any): sap.ui.unified.CalendarRow;
/**
* Sets a new value for property {@link #getUpdateCurrentTime updateCurrentTime}.
*
* If set the CalendarRow
triggers a periodic update to visualize the current time.
*
* If a lot of CalendarRow
controls are used in one container control (like PlanningCalendar
)
* the periodic update should be triggered only by this container control. Then the container control should
* call updateCurrentTimeVisualization
of the CalendarRow
to update the visualization.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bUpdateCurrentTime - New value for property updateCurrentTime
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setUpdateCurrentTime(bUpdateCurrentTime: boolean): sap.ui.unified.CalendarRow;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of the row
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.unified.CalendarRow} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.unified.CalendarRow;
/**
* If the current time is in the visible output of the CalendarRow
,
* the indicator for the current time must be positioned.
*
* For this, each CalendarRow
can trigger a timer.
* But if multiple CalendarRow
s are used in one container (e.G. PlanningCalendar
),
* it is better if the container triggers the interval once and then calls this function
* of each CalendarRow
.
* @returns {sap.ui.unified.CalendarRow} this
to allow method chaining
*/
public updateCurrentTimeVisualization(): sap.ui.unified.CalendarRow;
}
/**
* Calendar with granularity of time items displayed in one line.
*/
export class CalendarTimeInterval extends sap.ui.core.Control {
/**
* Constructor for a new CalendarTimeInterval
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.unified.CalendarTimeInterval;
/**
* Adds some selectedDate to the aggregation {@link #getSelectedDates selectedDates}.
* @param {sap.ui.unified.DateRange} oSelectedDate - the selectedDate to add; if empty, nothing is inserted
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public addSelectedDate(oSelectedDate: sap.ui.unified.DateRange): sap.ui.unified.CalendarTimeInterval;
/**
* Adds some specialDate to the aggregation {@link #getSpecialDates specialDates}.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to add; if empty, nothing is inserted
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public addSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): sap.ui.unified.CalendarTimeInterval;
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.ui.unified.CalendarTimeInterval
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarTimeInterval
itself.
*
* Time selection was cancelled
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarTimeInterval
itself
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public attachCancel(fnFunction: Function, oListener?: any): sap.ui.unified.CalendarTimeInterval;
/**
* Attaches event handler fnFunction
to the {@link #event:cancel cancel} event of this sap.ui.unified.CalendarTimeInterval
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarTimeInterval
itself.
*
* Time selection was cancelled
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarTimeInterval
itself
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public attachCancel(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.CalendarTimeInterval;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.CalendarTimeInterval
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarTimeInterval
itself.
*
* Time selection changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarTimeInterval
itself
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.unified.CalendarTimeInterval;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.CalendarTimeInterval
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarTimeInterval
itself.
*
* Time selection changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarTimeInterval
itself
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.CalendarTimeInterval;
/**
* Attaches event handler fnFunction
to the {@link #event:startDateChange startDateChange} event of this sap.ui.unified.CalendarTimeInterval
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarTimeInterval
itself.
*
* startDate
was changed while navigation in CalendarTimeInterval
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarTimeInterval
itself
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public attachStartDateChange(fnFunction: Function, oListener?: any): sap.ui.unified.CalendarTimeInterval;
/**
* Attaches event handler fnFunction
to the {@link #event:startDateChange startDateChange} event of this sap.ui.unified.CalendarTimeInterval
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.CalendarTimeInterval
itself.
*
* startDate
was changed while navigation in CalendarTimeInterval
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarTimeInterval
itself
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public attachStartDateChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.CalendarTimeInterval;
/**
* Destroys all the selectedDates in the aggregation {@link #getSelectedDates selectedDates}.
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public destroySelectedDates(): sap.ui.unified.CalendarTimeInterval;
/**
* Destroys all the specialDates in the aggregation {@link #getSpecialDates specialDates}.
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public destroySpecialDates(): sap.ui.unified.CalendarTimeInterval;
/**
* Detaches event handler fnFunction
from the {@link #event:cancel cancel} event of this sap.ui.unified.CalendarTimeInterval
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public detachCancel(fnFunction: Function, oListener: any): sap.ui.unified.CalendarTimeInterval;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.unified.CalendarTimeInterval
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.unified.CalendarTimeInterval;
/**
* Detaches event handler fnFunction
from the {@link #event:startDateChange startDateChange} event of this sap.ui.unified.CalendarTimeInterval
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public detachStartDateChange(fnFunction: Function, oListener: any): sap.ui.unified.CalendarTimeInterval;
/**
* Displays an item in the CalendarTimeInterval
but doesn't set the focus.
* @param {any} oDate - JavaScript date object for displayed item.
* @returns {sap.ui.unified.Calendar} this
to allow method chaining
*/
public displayDate(oDate: any): sap.ui.unified.Calendar;
/**
* Creates a new subclass of class sap.ui.unified.CalendarTimeInterval with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:cancel cancel} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
protected fireCancel(mParameters?: any): sap.ui.unified.CalendarTimeInterval;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.unified.CalendarTimeInterval;
/**
* Fires event {@link #event:startDateChange startDateChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
protected fireStartDateChange(mParameters?: any): sap.ui.unified.CalendarTimeInterval;
/**
* Sets the focused item of the CalendarTimeInterval
.
* @param {any} oDate - JavaScript date object for focused item.
* @returns {sap.ui.unified.Calendar} this
to allow method chaining
*/
public focusDate(oDate: any): sap.ui.unified.Calendar;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getIntervalMinutes intervalMinutes}.
*
* Size of on time interval in minutes, default is 60 minutes.
*
* Note: the start of the interval calculation is always on the corresponding date at 00:00.
*
* An interval longer then 720 minutes is not allowed. Please use the CalendarDateInterval
instead.
*
* A day must be divisible by this interval size. One interval must not include more than one day.
*
* Default value is 60
.
* @returns {number} Value of property intervalMinutes
*/
public getIntervalMinutes(): number;
/**
* Gets current value of property {@link #getIntervalSelection intervalSelection}.
*
* If set, interval selection is allowed
*
* Default value is false
.
* @returns {boolean} Value of property intervalSelection
*/
public getIntervalSelection(): boolean;
/**
* Gets current value of property {@link #getItems items}.
*
* Number of time items displayed. Default is 12.
*
* Note: On phones, the maximum number of items displayed in the row is always 6.
*
* Default value is 12
.
* @returns {number} Value of property items
*/
public getItems(): number;
/**
* ID of the element which is the current target of the association {@link #getLegend legend}, or null
.
* @returns {sap.ui.core.ID}
*/
public getLegend(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getMaxDate maxDate}.
*
* Maximum date that can be shown and selected in the Calendar. This must be a JavaScript date object.
*
* Note: If the maxDate
is set to be before the minDate
,
* the minDate
is set to the begin of the month of the maxDate
.
* @returns {any} Value of property maxDate
*/
public getMaxDate(): any;
/**
* Returns a metadata object for class sap.ui.unified.CalendarTimeInterval.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMinDate minDate}.
*
* Minimum date that can be shown and selected in the Calendar. This must be a JavaScript date object.
*
* Note: If the minDate
is set to be after the maxDate
,
* the maxDate
is set to the end of the month of the minDate
.
* @returns {any} Value of property minDate
*/
public getMinDate(): any;
/**
* Gets current value of property {@link #getPickerPopup pickerPopup}.
*
* If set, the day-, month- and yearPicker opens on a popup
*
* Default value is false
.
* @returns {boolean} Value of property pickerPopup
*/
public getPickerPopup(): boolean;
/**
* Gets content of aggregation {@link #getSelectedDates selectedDates}.
*
* Date ranges for selected items of the CalendarTimeInterval
.
*
* If singleSelection
is set, only the first entry is used.
* @returns {sap.ui.unified.DateRange[]}
*/
public getSelectedDates(): sap.ui.unified.DateRange[];
/**
* Gets current value of property {@link #getSingleSelection singleSelection}.
*
* If set, only a single date or interval, if intervalSelection
is enabled, can be selected
*
* Note: Selection of multiple intervals is not supported in the current version.
*
* Default value is true
.
* @returns {boolean} Value of property singleSelection
*/
public getSingleSelection(): boolean;
/**
* Gets content of aggregation {@link #getSpecialDates specialDates}.
*
* Date ranges with type to visualize special items in the CalendarTimeInterval
.
* If one interval is assigned to more than one type, only the first one will be used.
* @returns {sap.ui.unified.DateTypeRange[]}
*/
public getSpecialDates(): sap.ui.unified.DateTypeRange[];
/**
* Gets current value of property {@link #getStartDate startDate}.
*
* Start date of the Interval as JavaScript Date object.
* The time interval corresponding to this Date and items
and intervalMinutes
* will be the first time in the displayed row.
* @returns {any} Value of property startDate
*/
public getStartDate(): any;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the CalendarTimeInterval
. The width of the single months depends on this width.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.unified.DateRange
in the aggregation {@link #getSelectedDates selectedDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.DateRange} oSelectedDate - The selectedDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSelectedDate(oSelectedDate: sap.ui.unified.DateRange): number;
/**
* Checks for the provided sap.ui.unified.DateTypeRange
in the aggregation {@link #getSpecialDates specialDates}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - The specialDate whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange): number;
/**
* Inserts a selectedDate into the aggregation {@link #getSelectedDates selectedDates}.
* @param {sap.ui.unified.DateRange} oSelectedDate - the selectedDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the selectedDate should be inserted at; for a negative value of iIndex
, the selectedDate is inserted at position 0; for a value greater than the current size of the aggregation, the selectedDate is inserted at the last position
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public insertSelectedDate(oSelectedDate: sap.ui.unified.DateRange, iIndex: number): sap.ui.unified.CalendarTimeInterval;
/**
* Inserts a specialDate into the aggregation {@link #getSpecialDates specialDates}.
* @param {sap.ui.unified.DateTypeRange} oSpecialDate - the specialDate to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the specialDate should be inserted at; for a negative value of iIndex
, the specialDate is inserted at position 0; for a value greater than the current size of the aggregation, the specialDate is inserted at the last position
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public insertSpecialDate(oSpecialDate: sap.ui.unified.DateTypeRange, iIndex: number): sap.ui.unified.CalendarTimeInterval;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getSelectedDates selectedDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.DateRange[]} An array of the removed elements (might be empty)
*/
public removeAllSelectedDates(): sap.ui.unified.DateRange[];
/**
* Removes all the controls from the aggregation {@link #getSpecialDates specialDates}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.DateTypeRange[]} An array of the removed elements (might be empty)
*/
public removeAllSpecialDates(): sap.ui.unified.DateTypeRange[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a selectedDate from the aggregation {@link #getSelectedDates selectedDates}.
* @param {number|string|sap.ui.unified.DateRange} vSelectedDate - The selectedDate to remove or its index or id
* @returns {sap.ui.unified.DateRange} The removed selectedDate or null
*/
public removeSelectedDate(vSelectedDate: number|string|sap.ui.unified.DateRange): sap.ui.unified.DateRange;
/**
* Removes a specialDate from the aggregation {@link #getSpecialDates specialDates}.
* @param {number|string|sap.ui.unified.DateTypeRange} vSpecialDate - The specialDate to remove or its index or id
* @returns {sap.ui.unified.DateTypeRange} The removed specialDate or null
*/
public removeSpecialDate(vSpecialDate: number|string|sap.ui.unified.DateTypeRange): sap.ui.unified.DateTypeRange;
/**
* Sets a new value for property {@link #getIntervalMinutes intervalMinutes}.
*
* Size of on time interval in minutes, default is 60 minutes.
*
* Note: the start of the interval calculation is always on the corresponding date at 00:00.
*
* An interval longer then 720 minutes is not allowed. Please use the CalendarDateInterval
instead.
*
* A day must be divisible by this interval size. One interval must not include more than one day.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 60
.
* @param {number} iIntervalMinutes - New value for property intervalMinutes
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public setIntervalMinutes(iIntervalMinutes: number): sap.ui.unified.CalendarTimeInterval;
/**
* Sets a new value for property {@link #getIntervalSelection intervalSelection}.
*
* If set, interval selection is allowed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bIntervalSelection - New value for property intervalSelection
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public setIntervalSelection(bIntervalSelection: boolean): sap.ui.unified.CalendarTimeInterval;
/**
* Sets a new value for property {@link #getItems items}.
*
* Number of time items displayed. Default is 12.
*
* Note: On phones, the maximum number of items displayed in the row is always 6.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 12
.
* @param {number} iItems - New value for property items
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public setItems(iItems: number): sap.ui.unified.CalendarTimeInterval;
/**
* Sets the associated {@link #getLegend legend}.
* @param {sap.ui.core.ID|sap.ui.unified.CalendarLegend} oLegend - ID of an element which becomes the new target of this legend association; alternatively, an element instance may be given
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public setLegend(oLegend: sap.ui.core.ID|sap.ui.unified.CalendarLegend): sap.ui.unified.CalendarTimeInterval;
/**
* Sets a new value for property {@link #getMaxDate maxDate}.
*
* Maximum date that can be shown and selected in the Calendar. This must be a JavaScript date object.
*
* Note: If the maxDate
is set to be before the minDate
,
* the minDate
is set to the begin of the month of the maxDate
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oMaxDate - New value for property maxDate
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public setMaxDate(oMaxDate: any): sap.ui.unified.CalendarTimeInterval;
/**
* Sets a new value for property {@link #getMinDate minDate}.
*
* Minimum date that can be shown and selected in the Calendar. This must be a JavaScript date object.
*
* Note: If the minDate
is set to be after the maxDate
,
* the maxDate
is set to the end of the month of the minDate
.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oMinDate - New value for property minDate
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public setMinDate(oMinDate: any): sap.ui.unified.CalendarTimeInterval;
/**
* Sets a new value for property {@link #getPickerPopup pickerPopup}.
*
* If set, the day-, month- and yearPicker opens on a popup
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bPickerPopup - New value for property pickerPopup
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public setPickerPopup(bPickerPopup: boolean): sap.ui.unified.CalendarTimeInterval;
/**
* Sets a new value for property {@link #getSingleSelection singleSelection}.
*
* If set, only a single date or interval, if intervalSelection
is enabled, can be selected
*
* Note: Selection of multiple intervals is not supported in the current version.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bSingleSelection - New value for property singleSelection
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public setSingleSelection(bSingleSelection: boolean): sap.ui.unified.CalendarTimeInterval;
/**
* Sets a new value for property {@link #getStartDate startDate}.
*
* Start date of the Interval as JavaScript Date object.
* The time interval corresponding to this Date and items
and intervalMinutes
* will be the first time in the displayed row.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oStartDate - New value for property startDate
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public setStartDate(oStartDate: any): sap.ui.unified.CalendarTimeInterval;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of the CalendarTimeInterval
. The width of the single months depends on this width.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.unified.CalendarTimeInterval} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.unified.CalendarTimeInterval;
}
/**
* Enables the user to select a color.
* The color can be defined using HEX, RGB, or HSV values or a CSS color name.
*
* Note: Keep in mind that this control needs either sap.m
* or sap.ui.commons
library to be loaded in order to work as
* it depends on controls available in one or the other library.
*/
export class ColorPicker extends sap.ui.core.Control {
/**
* Constructor for a new ColorPicker
.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.unified.ColorPicker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.ColorPicker
itself.
*
* Fired when the value is changed by user action.
*
* Note: When the user action is mouse dragging, the
* change
event fires on the mouseup event.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.ColorPicker
itself
* @returns {sap.ui.unified.ColorPicker} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.ui.unified.ColorPicker;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.unified.ColorPicker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.ColorPicker
itself.
*
* Fired when the value is changed by user action.
*
* Note: When the user action is mouse dragging, the
* change
event fires on the mouseup event.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.ColorPicker
itself
* @returns {sap.ui.unified.ColorPicker} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.ColorPicker;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.ui.unified.ColorPicker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.ColorPicker
itself.
*
* Fired when the value is changed during the mouse move.
*
* Note: When the user action is mouse move, the liveChange
* event is fired during the mousedown event.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.ColorPicker
itself
* @returns {sap.ui.unified.ColorPicker} Reference to this
in order to allow method chaining
*/
public attachLiveChange(fnFunction: Function, oListener?: any): sap.ui.unified.ColorPicker;
/**
* Attaches event handler fnFunction
to the {@link #event:liveChange liveChange} event of this sap.ui.unified.ColorPicker
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.ColorPicker
itself.
*
* Fired when the value is changed during the mouse move.
*
* Note: When the user action is mouse move, the liveChange
* event is fired during the mousedown event.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.ColorPicker
itself
* @returns {sap.ui.unified.ColorPicker} Reference to this
in order to allow method chaining
*/
public attachLiveChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.ColorPicker;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.ui.unified.ColorPicker
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.ColorPicker} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.ui.unified.ColorPicker;
/**
* Detaches event handler fnFunction
from the {@link #event:liveChange liveChange} event of this sap.ui.unified.ColorPicker
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.ColorPicker} Reference to this
in order to allow method chaining
*/
public detachLiveChange(fnFunction: Function, oListener: any): sap.ui.unified.ColorPicker;
/**
* Creates a new subclass of class sap.ui.unified.ColorPicker with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.ColorPicker} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.ui.unified.ColorPicker;
/**
* Fires event {@link #event:liveChange liveChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.ColorPicker} Reference to this
in order to allow method chaining
*/
protected fireLiveChange(mParameters?: any): sap.ui.unified.ColorPicker;
/**
* Gets current value of property {@link #getColorString colorString}.
*
* Determines the input parameter that can be a string of type HEX, RGB, HSV, or a CSS color name:
*
* - HEX - #FFFFFF
* - RGB - rgb(255,255,255)
* - HSV - hsv(360,100,100)
* - CSS - red
*
* Note: The output parameter is an RGB string of the current color.
* @returns {string} Value of property colorString
*/
public getColorString(): string;
/**
* Returns a metadata object for class sap.ui.unified.ColorPicker.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMode mode}.
*
* Determines the color mode of the ColorPicker
.
*
* Default value is HSV
.
* @returns {sap.ui.unified.ColorPickerMode} Value of property mode
*/
public getMode(): sap.ui.unified.ColorPickerMode;
/**
* Gets current RGB values.
* @returns {any} Containing current RGB values
*/
public getRGB(): any;
/**
* Checks the validity of the CSS color string.
* @param {string} sColorString - CSS color string to be validated
* @returns {boolean} If the passed string is a valid CSS color string
*/
public isColor(sColorString: string): boolean;
/**
* Sets a new value for property {@link #getColorString colorString}.
*
* Determines the input parameter that can be a string of type HEX, RGB, HSV, or a CSS color name:
*
* - HEX - #FFFFFF
* - RGB - rgb(255,255,255)
* - HSV - hsv(360,100,100)
* - CSS - red
*
* Note: The output parameter is an RGB string of the current color.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sColorString - New value for property colorString
* @returns {sap.ui.unified.ColorPicker} Reference to this
in order to allow method chaining
*/
public setColorString(sColorString: string): sap.ui.unified.ColorPicker;
/**
* Setter for mode
property.
* @param {sap.ui.unified.ColorPickerMode} sMode - control mode enum
* @param {boolean} bSuppressInvalidate - should control invalidation be suppressed
*/
public setMode(sMode: sap.ui.unified.ColorPickerMode, bSuppressInvalidate: boolean): void;
}
/**
* different styles for a ColorPicker.
*/
export enum ColorPickerMode {
/**
* Color picker works with HSL values.
*/
HSL = "HSL",
/**
* Color picker works with HSV values.
*/
HSV = "HSV",
}
/**
* Switches between two control areas and animates it via CSS transitions
*/
export class ContentSwitcher extends sap.ui.core.Control {
/**
* Constructor for a new ContentSwitcher.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content1 to the aggregation {@link #getContent1 content1}.
* @param {sap.ui.core.Control} oContent1 - the content1 to add; if empty, nothing is inserted
* @returns {sap.ui.unified.ContentSwitcher} Reference to this
in order to allow method chaining
*/
public addContent1(oContent1: sap.ui.core.Control): sap.ui.unified.ContentSwitcher;
/**
* Adds some content2 to the aggregation {@link #getContent2 content2}.
* @param {sap.ui.core.Control} oContent2 - the content2 to add; if empty, nothing is inserted
* @returns {sap.ui.unified.ContentSwitcher} Reference to this
in order to allow method chaining
*/
public addContent2(oContent2: sap.ui.core.Control): sap.ui.unified.ContentSwitcher;
/**
* Destroys all the content1 in the aggregation {@link #getContent1 content1}.
* @returns {sap.ui.unified.ContentSwitcher} Reference to this
in order to allow method chaining
*/
public destroyContent1(): sap.ui.unified.ContentSwitcher;
/**
* Destroys all the content2 in the aggregation {@link #getContent2 content2}.
* @returns {sap.ui.unified.ContentSwitcher} Reference to this
in order to allow method chaining
*/
public destroyContent2(): sap.ui.unified.ContentSwitcher;
/**
* Creates a new subclass of class sap.ui.unified.ContentSwitcher with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getActiveContent activeContent}.
*
* The number of the currently active content (1 or 2).
*
* Default value is 1
.
* @returns {number} Value of property activeContent
*/
public getActiveContent(): number;
/**
* Gets current value of property {@link #getAnimation animation}.
*
* Set the used animation when changing content. This just sets a CSS-class named "sapUiUnifiedACSwitcherAnimation" + this value on the root element of the control. The animation has to be implemented in CSS. This also enables applications to implement their own animations via CSS by reacting to the parent class.
* See the types sap.ui.unified.ContentSwitcherAnimation for default implementations.
*
* Default value is None
.
* @returns {string} Value of property animation
*/
public getAnimation(): string;
/**
* Gets content of aggregation {@link #getContent1 content1}.
*
* The controls that should be shown in the first content
* @returns {sap.ui.core.Control[]}
*/
public getContent1(): sap.ui.core.Control[];
/**
* Gets content of aggregation {@link #getContent2 content2}.
*
* The controls that should be shown in the second content
* @returns {sap.ui.core.Control[]}
*/
public getContent2(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.ui.unified.ContentSwitcher.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent1 content1}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent1 - The content1 whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent1(oContent1: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent2 content2}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent2 - The content2 whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent2(oContent2: sap.ui.core.Control): number;
/**
* Inserts a content1 into the aggregation {@link #getContent1 content1}.
* @param {sap.ui.core.Control} oContent1 - the content1 to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content1 should be inserted at; for a negative value of iIndex
, the content1 is inserted at position 0; for a value greater than the current size of the aggregation, the content1 is inserted at the last position
* @returns {sap.ui.unified.ContentSwitcher} Reference to this
in order to allow method chaining
*/
public insertContent1(oContent1: sap.ui.core.Control, iIndex: number): sap.ui.unified.ContentSwitcher;
/**
* Inserts a content2 into the aggregation {@link #getContent2 content2}.
* @param {sap.ui.core.Control} oContent2 - the content2 to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content2 should be inserted at; for a negative value of iIndex
, the content2 is inserted at position 0; for a value greater than the current size of the aggregation, the content2 is inserted at the last position
* @returns {sap.ui.unified.ContentSwitcher} Reference to this
in order to allow method chaining
*/
public insertContent2(oContent2: sap.ui.core.Control, iIndex: number): sap.ui.unified.ContentSwitcher;
/**
* Removes all the controls from the aggregation {@link #getContent1 content1}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent1(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getContent2 content2}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent2(): sap.ui.core.Control[];
/**
* Removes a content1 from the aggregation {@link #getContent1 content1}.
* @param {number|string|sap.ui.core.Control} vContent1 - The content1 to remove or its index or id
* @returns {sap.ui.core.Control} The removed content1 or null
*/
public removeContent1(vContent1: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a content2 from the aggregation {@link #getContent2 content2}.
* @param {number|string|sap.ui.core.Control} vContent2 - The content2 to remove or its index or id
* @returns {sap.ui.core.Control} The removed content2 or null
*/
public removeContent2(vContent2: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getActiveContent activeContent}.
*
* The number of the currently active content (1 or 2).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 1
.
* @param {number} iActiveContent - New value for property activeContent
* @returns {sap.ui.unified.ContentSwitcher} Reference to this
in order to allow method chaining
*/
public setActiveContent(iActiveContent: number): sap.ui.unified.ContentSwitcher;
/**
* Sets a new value for property {@link #getAnimation animation}.
*
* Set the used animation when changing content. This just sets a CSS-class named "sapUiUnifiedACSwitcherAnimation" + this value on the root element of the control. The animation has to be implemented in CSS. This also enables applications to implement their own animations via CSS by reacting to the parent class.
* See the types sap.ui.unified.ContentSwitcherAnimation for default implementations.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {string} sAnimation - New value for property animation
* @returns {sap.ui.unified.ContentSwitcher} Reference to this
in order to allow method chaining
*/
public setAnimation(sAnimation: string): sap.ui.unified.ContentSwitcher;
/**
* Changes the currently active content to the other one. If content 1 is active, content 2 will
* be activated and the other way around.
*/
public switchContent(): void;
}
/**
* Predefined animations for the ContentSwitcher
*/
export enum ContentSwitcherAnimation {
/**
* Content is faded (opacity change).
*/
Fade = "Fade",
/**
* No animation. Content is switched instantly.
*/
None = "None",
/**
* The new content rotates in. (Just like one of those old newspaper-animations.)
*/
Rotate = "Rotate",
/**
* The new content slides in from the left while the old content slides out to the left at the same time.
*/
SlideOver = "SlideOver",
/**
* The new slides in from the left (to the right).
*/
SlideRight = "SlideRight",
/**
* The new content is "zoomed in" from the center and grows to fill the full content area.
*/
ZoomIn = "ZoomIn",
/**
* The old content is "zoomed out", i.e. shrinks to a point at the center of the content area.
*/
ZoomOut = "ZoomOut",
}
/**
* A text view which displays currency values and aligns them at the separator
*/
export class Currency extends sap.ui.core.Control {
/**
* Constructor for a new Currency.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.unified.Currency with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* @returns {Object} Current accessibility state of the control.
*/
protected getAccessibilityInfo(): Object;
/**
* Gets current value of property {@link #getCurrency currency}.
*
* Determines the displayed currency code (ISO 4217).
* Note: If a * character is set instead of currency code,
* only the character itself will be rendered, ignoring the value
property.
* @returns {string} Value of property currency
*/
public getCurrency(): string;
/**
* Get symbol of the currency, if available.
* @returns {string}
*/
public getCurrencySymbol(): string;
/**
* The formatted value.
* @returns {string} The formatted value
*/
public getFormattedValue(): string;
/**
* Gets current value of property {@link #getMaxPrecision maxPrecision}.
*
* Defines the space that is available for the precision of the various currencies.
*
* Default value is 3
.
* @returns {number} Value of property maxPrecision
*/
public getMaxPrecision(): number;
/**
* Returns a metadata object for class sap.ui.unified.Currency.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getUseSymbol useSymbol}.
*
* Show the currency symbol instead of the ISO currency code
*
* Default value is true
.
* @returns {boolean} Value of property useSymbol
*/
public getUseSymbol(): boolean;
/**
* Gets current value of property {@link #getValue value}.
*
* The currency value
*
* Default value is 0
.
* @returns {number} Value of property value
*/
public getValue(): number;
/**
* Initializes the control.
*/
public init(): void;
/**
* Sets a new value for property {@link #getCurrency currency}.
*
* Determines the displayed currency code (ISO 4217).
* Note: If a * character is set instead of currency code,
* only the character itself will be rendered, ignoring the value
property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sCurrency - New value for property currency
* @returns {sap.ui.unified.Currency} Reference to this
in order to allow method chaining
*/
public setCurrency(sCurrency: string): sap.ui.unified.Currency;
/**
* Sets a new value for property {@link #getMaxPrecision maxPrecision}.
*
* Defines the space that is available for the precision of the various currencies.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 3
.
* @param {number} iMaxPrecision - New value for property maxPrecision
* @returns {sap.ui.unified.Currency} Reference to this
in order to allow method chaining
*/
public setMaxPrecision(iMaxPrecision: number): sap.ui.unified.Currency;
/**
* Sets a new value for property {@link #getUseSymbol useSymbol}.
*
* Show the currency symbol instead of the ISO currency code
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bUseSymbol - New value for property useSymbol
* @returns {sap.ui.unified.Currency} Reference to this
in order to allow method chaining
*/
public setUseSymbol(bUseSymbol: boolean): sap.ui.unified.Currency;
/**
* Sets a new value for property {@link #getValue value}.
*
* The currency value
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} fValue - New value for property value
* @returns {sap.ui.unified.Currency} Reference to this
in order to allow method chaining
*/
public setValue(fValue: number): sap.ui.unified.Currency;
}
/**
* Date range for use in DatePicker
*/
export class DateRange extends sap.ui.core.Element {
/**
* Constructor for a new DateRange.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.unified.DateRange with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getEndDate endDate}.
*
* End date for a date range. If empty only a single date is presented by this DateRange element. This must be a JavaScript date object.
* @returns {any} Value of property endDate
*/
public getEndDate(): any;
/**
* Returns a metadata object for class sap.ui.unified.DateRange.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getStartDate startDate}.
*
* Start date for a date range. This must be a JavaScript date object.
* @returns {any} Value of property startDate
*/
public getStartDate(): any;
/**
* Sets a new value for property {@link #getEndDate endDate}.
*
* End date for a date range. If empty only a single date is presented by this DateRange element. This must be a JavaScript date object.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oEndDate - New value for property endDate
* @returns {sap.ui.unified.DateRange} Reference to this
in order to allow method chaining
*/
public setEndDate(oEndDate: any): sap.ui.unified.DateRange;
/**
* Sets a new value for property {@link #getStartDate startDate}.
*
* Start date for a date range. This must be a JavaScript date object.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oStartDate - New value for property startDate
* @returns {sap.ui.unified.DateRange} Reference to this
in order to allow method chaining
*/
public setStartDate(oStartDate: any): sap.ui.unified.DateRange;
}
/**
* Date range with calendar day type information. Used to visualize special days in the Calendar.
*/
export class DateTypeRange extends sap.ui.unified.DateRange {
/**
* Constructor for a new DateTypeRange.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.unified.DateTypeRange with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.unified.DateRange.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.unified.DateTypeRange.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getType type}.
*
* Type of the date range.
*
* Default value is Type01
.
* @returns {sap.ui.unified.CalendarDayType} Value of property type
*/
public getType(): sap.ui.unified.CalendarDayType;
/**
* Sets a new value for property {@link #getType type}.
*
* Type of the date range.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Type01
.
* @param {sap.ui.unified.CalendarDayType} sType - New value for property type
* @returns {sap.ui.unified.DateTypeRange} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.ui.unified.CalendarDayType): sap.ui.unified.DateTypeRange;
}
/**
* The framework generates an input field and a button with text "Browse ...". The API supports features such as on change uploads (the upload starts immediately after a file has been selected), file uploads with explicit calls, adjustable control sizes, text display after uploads, or tooltips containing complete file paths.
*/
export class FileUploader extends sap.ui.core.Control {
/**
* Constructor for a new FileUploader.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Aborts the currently running upload.
*/
public abort(): void;
/**
* Adds some headerParameter to the aggregation {@link #getHeaderParameters headerParameters}.
* @param {sap.ui.unified.FileUploaderParameter} oHeaderParameter - the headerParameter to add; if empty, nothing is inserted
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public addHeaderParameter(oHeaderParameter: sap.ui.unified.FileUploaderParameter): sap.ui.unified.FileUploader;
/**
* Adds some parameter to the aggregation {@link #getParameters parameters}.
* @param {sap.ui.unified.FileUploaderParameter} oParameter - the parameter to add; if empty, nothing is inserted
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public addParameter(oParameter: sap.ui.unified.FileUploaderParameter): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired when the value of the file path has been changed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachChange(fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:change change} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired when the value of the file path has been changed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:fileAllowed fileAllowed} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired when the file is allowed for upload on client side.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachFileAllowed(fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:fileAllowed fileAllowed} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired when the file is allowed for upload on client side.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachFileAllowed(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:filenameLengthExceed filenameLengthExceed} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired, if the filename of a chosen file is longer than the value specified with the maximumFilenameLength property.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachFilenameLengthExceed(fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:filenameLengthExceed filenameLengthExceed} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired, if the filename of a chosen file is longer than the value specified with the maximumFilenameLength property.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachFilenameLengthExceed(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:fileSizeExceed fileSizeExceed} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired when the size of a file is above the maximumFileSize property.
* This event is not supported by Internet Explorer 9 (same restriction as for the property maximumFileSize).
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachFileSizeExceed(fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:fileSizeExceed fileSizeExceed} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired when the size of a file is above the maximumFileSize property.
* This event is not supported by Internet Explorer 9 (same restriction as for the property maximumFileSize).
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachFileSizeExceed(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:typeMissmatch typeMissmatch} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired when the type of a file does not match the mimeType or fileType property.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachTypeMissmatch(fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:typeMissmatch typeMissmatch} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired when the type of a file does not match the mimeType or fileType property.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachTypeMissmatch(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:uploadAborted uploadAborted} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired after the current upload has been aborted.
* This is event is only supported with property sendXHR set to true, i.e. the event is not supported in Internet Explorer 9.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachUploadAborted(fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:uploadAborted uploadAborted} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired after the current upload has been aborted.
* This is event is only supported with property sendXHR set to true, i.e. the event is not supported in Internet Explorer 9.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachUploadAborted(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:uploadComplete uploadComplete} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired as soon as the upload request is completed (either successful or unsuccessful). To see if the upload request was successful, check the 'state' parameter for a value 2xx.
* The uploads actual progress can be retrieved via the 'uploadProgress' Event.
* However this covers only the client side of the Upload process and does not give any success status from the server.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachUploadComplete(fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:uploadComplete uploadComplete} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired as soon as the upload request is completed (either successful or unsuccessful). To see if the upload request was successful, check the 'state' parameter for a value 2xx.
* The uploads actual progress can be retrieved via the 'uploadProgress' Event.
* However this covers only the client side of the Upload process and does not give any success status from the server.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachUploadComplete(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:uploadProgress uploadProgress} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired after the upload has started and before the upload is completed and contains progress information related to the running upload.
* Depending on file size, band width and used browser the event is fired once or multiple times.
* This is event is only supported with property sendXHR set to true, i.e. the event is not supported in Internet Explorer 9.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachUploadProgress(fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:uploadProgress uploadProgress} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired after the upload has started and before the upload is completed and contains progress information related to the running upload.
* Depending on file size, band width and used browser the event is fired once or multiple times.
* This is event is only supported with property sendXHR set to true, i.e. the event is not supported in Internet Explorer 9.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachUploadProgress(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:uploadStart uploadStart} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired before an upload is started.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachUploadStart(fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Attaches event handler fnFunction
to the {@link #event:uploadStart uploadStart} event of this sap.ui.unified.FileUploader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.FileUploader
itself.
*
* Event is fired before an upload is started.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.FileUploader
itself
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public attachUploadStart(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.FileUploader;
/**
* Clears the content of the FileUploader. The attached additional data however is retained.
*/
public clear(): void;
/**
* Destroys all the headerParameters in the aggregation {@link #getHeaderParameters headerParameters}.
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public destroyHeaderParameters(): sap.ui.unified.FileUploader;
/**
* Destroys all the parameters in the aggregation {@link #getParameters parameters}.
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public destroyParameters(): sap.ui.unified.FileUploader;
/**
* Detaches event handler fnFunction
from the {@link #event:change change} event of this sap.ui.unified.FileUploader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public detachChange(fnFunction: Function, oListener: any): sap.ui.unified.FileUploader;
/**
* Detaches event handler fnFunction
from the {@link #event:fileAllowed fileAllowed} event of this sap.ui.unified.FileUploader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public detachFileAllowed(fnFunction: Function, oListener: any): sap.ui.unified.FileUploader;
/**
* Detaches event handler fnFunction
from the {@link #event:filenameLengthExceed filenameLengthExceed} event of this sap.ui.unified.FileUploader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public detachFilenameLengthExceed(fnFunction: Function, oListener: any): sap.ui.unified.FileUploader;
/**
* Detaches event handler fnFunction
from the {@link #event:fileSizeExceed fileSizeExceed} event of this sap.ui.unified.FileUploader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public detachFileSizeExceed(fnFunction: Function, oListener: any): sap.ui.unified.FileUploader;
/**
* Detaches event handler fnFunction
from the {@link #event:typeMissmatch typeMissmatch} event of this sap.ui.unified.FileUploader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public detachTypeMissmatch(fnFunction: Function, oListener: any): sap.ui.unified.FileUploader;
/**
* Detaches event handler fnFunction
from the {@link #event:uploadAborted uploadAborted} event of this sap.ui.unified.FileUploader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public detachUploadAborted(fnFunction: Function, oListener: any): sap.ui.unified.FileUploader;
/**
* Detaches event handler fnFunction
from the {@link #event:uploadComplete uploadComplete} event of this sap.ui.unified.FileUploader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public detachUploadComplete(fnFunction: Function, oListener: any): sap.ui.unified.FileUploader;
/**
* Detaches event handler fnFunction
from the {@link #event:uploadProgress uploadProgress} event of this sap.ui.unified.FileUploader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public detachUploadProgress(fnFunction: Function, oListener: any): sap.ui.unified.FileUploader;
/**
* Detaches event handler fnFunction
from the {@link #event:uploadStart uploadStart} event of this sap.ui.unified.FileUploader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public detachUploadStart(fnFunction: Function, oListener: any): sap.ui.unified.FileUploader;
/**
* Creates a new subclass of class sap.ui.unified.FileUploader with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:change change} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
protected fireChange(mParameters?: any): sap.ui.unified.FileUploader;
/**
* Fires event {@link #event:fileAllowed fileAllowed} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
protected fireFileAllowed(mParameters?: any): sap.ui.unified.FileUploader;
/**
* Fires event {@link #event:filenameLengthExceed filenameLengthExceed} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
protected fireFilenameLengthExceed(mParameters?: any): sap.ui.unified.FileUploader;
/**
* Fires event {@link #event:fileSizeExceed fileSizeExceed} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
protected fireFileSizeExceed(mParameters?: any): sap.ui.unified.FileUploader;
/**
* Fires event {@link #event:typeMissmatch typeMissmatch} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
protected fireTypeMissmatch(mParameters?: any): sap.ui.unified.FileUploader;
/**
* Fires event {@link #event:uploadAborted uploadAborted} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
protected fireUploadAborted(mParameters?: any): sap.ui.unified.FileUploader;
/**
* Fires event {@link #event:uploadComplete uploadComplete} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
protected fireUploadComplete(mParameters?: any): sap.ui.unified.FileUploader;
/**
* Fires event {@link #event:uploadProgress uploadProgress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
protected fireUploadProgress(mParameters?: any): sap.ui.unified.FileUploader;
/**
* Fires event {@link #event:uploadStart uploadStart} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
protected fireUploadStart(mParameters?: any): sap.ui.unified.FileUploader;
/**
* Gets current value of property {@link #getAdditionalData additionalData}.
*
* Additional data that is sent to the back end service. Data will be transmitted as value of a hidden input where the name is derived from the name property with suffix -data.
* @returns {string} Value of property additionalData
*/
public getAdditionalData(): string;
/**
* Gets current value of property {@link #getButtonOnly buttonOnly}.
*
* If set to "true", the FileUploader will be rendered as Button only, without showing the InputField.
*
* Default value is false
.
* @returns {boolean} Value of property buttonOnly
*/
public getButtonOnly(): boolean;
/**
* Gets current value of property {@link #getButtonText buttonText}.
*
* The Button text can be overwritten using this property.
* @returns {string} Value of property buttonText
*/
public getButtonText(): string;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* Disabled controls have different colors, depending on customer settings.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getFileType fileType}.
*
* The chosen files will be checked against an array of file types. If at least one file does not fit the file type restriction the upload is prevented.
* Example: ["jpg", "png", "bmp"].
* @returns {string[]} Value of property fileType
*/
public getFileType(): string[];
/**
* Gets content of aggregation {@link #getHeaderParameters headerParameters}.
*
* The header parameters for the FileUploader which are only submitted with XHR requests. Header parameters are not supported by Internet Explorer 9.
* @returns {sap.ui.unified.FileUploaderParameter[]}
*/
public getHeaderParameters(): sap.ui.unified.FileUploaderParameter[];
/**
* Gets current value of property {@link #getIcon icon}.
*
* Icon to be displayed as graphical element within the button.
* This can be a URI to an image or an icon font URI.
*
* Default value is
.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconFirst iconFirst}.
*
* If set to true (default), the display sequence is 1. icon 2. control text.
*
* Default value is true
.
* @returns {boolean} Value of property iconFirst
*/
public getIconFirst(): boolean;
/**
* Gets current value of property {@link #getIconHovered iconHovered}.
*
* Icon to be displayed as graphical element within the button when it is hovered (only if also a base icon was specified). If not specified the base icon is used.
* If an icon font icon is used, this property is ignored.
*
* Default value is
.
* @returns {sap.ui.core.URI} Value of property iconHovered
*/
public getIconHovered(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconOnly iconOnly}.
*
* If set to true, the button is displayed without any text.
*
* Default value is false
.
* @returns {boolean} Value of property iconOnly
*/
public getIconOnly(): boolean;
/**
* Gets current value of property {@link #getIconSelected iconSelected}.
*
* Icon to be displayed as graphical element within the button when it is selected (only if also a base icon was specified). If not specified the base or hovered icon is used.
* If an icon font icon is used, this property is ignored.
*
* Default value is
.
* @returns {sap.ui.core.URI} Value of property iconSelected
*/
public getIconSelected(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getMaximumFilenameLength maximumFilenameLength}.
*
* The maximum length of a filename which the FileUploader will accept. If the maximum filename length is exceeded, the corresponding Event 'filenameLengthExceed' is fired.
* @returns {number} Value of property maximumFilenameLength
*/
public getMaximumFilenameLength(): number;
/**
* Gets current value of property {@link #getMaximumFileSize maximumFileSize}.
*
* A file size limit in megabytes which prevents the upload if at least one file exceeds it. This property is not supported by Internet Explorer 9.
* @returns {number} Value of property maximumFileSize
*/
public getMaximumFileSize(): number;
/**
* Returns a metadata object for class sap.ui.unified.FileUploader.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMimeType mimeType}.
*
* The chosen files will be checked against an array of mime types. If at least one file does not fit the mime type restriction the upload is prevented. This property is not supported by Internet Explorer 9.
* Example: mimeType ["image/png", "image/jpeg"].
* @returns {string[]} Value of property mimeType
*/
public getMimeType(): string[];
/**
* Gets current value of property {@link #getMultiple multiple}.
*
* Allows multiple files to be chosen and uploaded from the same folder. This property is not supported by Internet Explorer 9.
*
* Default value is false
.
* @returns {boolean} Value of property multiple
*/
public getMultiple(): boolean;
/**
* Gets current value of property {@link #getName name}.
*
* Unique control name for identification on the server side after sending data to the server.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets content of aggregation {@link #getParameters parameters}.
*
* The parameters for the FileUploader which are rendered as a hidden inputfield.
* @returns {sap.ui.unified.FileUploaderParameter[]}
*/
public getParameters(): sap.ui.unified.FileUploaderParameter[];
/**
* Gets current value of property {@link #getPlaceholder placeholder}.
*
* Placeholder for the text field.
* @returns {string} Value of property placeholder
*/
public getPlaceholder(): string;
/**
* Gets current value of property {@link #getSameFilenameAllowed sameFilenameAllowed}.
*
* If the FileUploader is configured to upload the file directly after the file is selected it is not allowed to upload a file with the same name again. If a user should be allowed to upload a file with the same name again this parameter has to be "true". A typical use case would be if the files have different paths.
*
* Default value is false
.
* @returns {boolean} Value of property sameFilenameAllowed
*/
public getSameFilenameAllowed(): boolean;
/**
* Gets current value of property {@link #getSendXHR sendXHR}.
*
* If set to "true", the request will be sent as XHR request instead of a form submit. This property is not supported by Internet Explorer 9.
*
* Default value is false
.
* @returns {boolean} Value of property sendXHR
*/
public getSendXHR(): boolean;
/**
* Gets current value of property {@link #getStyle style}.
*
* Style of the button. "Transparent, "Accept", "Reject", or "Emphasized" is allowed.
* @returns {string} Value of property style
*/
public getStyle(): string;
/**
* Gets current value of property {@link #getUploadOnChange uploadOnChange}.
*
* If set to "true", the upload immediately starts after file selection. With the default setting, the upload needs to be explicitly triggered.
*
* Default value is false
.
* @returns {boolean} Value of property uploadOnChange
*/
public getUploadOnChange(): boolean;
/**
* Gets current value of property {@link #getUploadUrl uploadUrl}.
*
* Used when URL address is on a remote server.
*
* Default value is
.
* @returns {sap.ui.core.URI} Value of property uploadUrl
*/
public getUploadUrl(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getUseMultipart useMultipart}.
*
* If set to "false", the request will be sent as file only request instead of a multipart/form-data request. Only one file could be uploaded using this type of request. Required for sending such a request is to set the property "sendXHR" to "true". This property is not supported by Internet Explorer 9.
*
* Default value is true
.
* @returns {boolean} Value of property useMultipart
*/
public getUseMultipart(): boolean;
/**
* Gets current value of property {@link #getValue value}.
*
* Value of the path for file upload.
*
* Default value is
.
* @returns {string} Value of property value
*/
public getValue(): string;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Visualizes warnings or errors related to the text field. Possible values: Warning, Error, Success, None.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Gets current value of property {@link #getWidth width}.
*
* Specifies the displayed control width.
*
* Default value is
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.unified.FileUploaderParameter
in the aggregation {@link #getHeaderParameters headerParameters}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.FileUploaderParameter} oHeaderParameter - The headerParameter whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfHeaderParameter(oHeaderParameter: sap.ui.unified.FileUploaderParameter): number;
/**
* Checks for the provided sap.ui.unified.FileUploaderParameter
in the aggregation {@link #getParameters parameters}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.FileUploaderParameter} oParameter - The parameter whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfParameter(oParameter: sap.ui.unified.FileUploaderParameter): number;
/**
* Inserts a headerParameter into the aggregation {@link #getHeaderParameters headerParameters}.
* @param {sap.ui.unified.FileUploaderParameter} oHeaderParameter - the headerParameter to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the headerParameter should be inserted at; for a negative value of iIndex
, the headerParameter is inserted at position 0; for a value greater than the current size of the aggregation, the headerParameter is inserted at the last position
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public insertHeaderParameter(oHeaderParameter: sap.ui.unified.FileUploaderParameter, iIndex: number): sap.ui.unified.FileUploader;
/**
* Inserts a parameter into the aggregation {@link #getParameters parameters}.
* @param {sap.ui.unified.FileUploaderParameter} oParameter - the parameter to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the parameter should be inserted at; for a negative value of iIndex
, the parameter is inserted at position 0; for a value greater than the current size of the aggregation, the parameter is inserted at the last position
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public insertParameter(oParameter: sap.ui.unified.FileUploaderParameter, iIndex: number): sap.ui.unified.FileUploader;
/**
* Removes all the controls from the aggregation {@link #getHeaderParameters headerParameters}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.FileUploaderParameter[]} An array of the removed elements (might be empty)
*/
public removeAllHeaderParameters(): sap.ui.unified.FileUploaderParameter[];
/**
* Removes all the controls from the aggregation {@link #getParameters parameters}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.FileUploaderParameter[]} An array of the removed elements (might be empty)
*/
public removeAllParameters(): sap.ui.unified.FileUploaderParameter[];
/**
* Removes a headerParameter from the aggregation {@link #getHeaderParameters headerParameters}.
* @param {number|string|sap.ui.unified.FileUploaderParameter} vHeaderParameter - The headerParameter to remove or its index or id
* @returns {sap.ui.unified.FileUploaderParameter} The removed headerParameter or null
*/
public removeHeaderParameter(vHeaderParameter: number|string|sap.ui.unified.FileUploaderParameter): sap.ui.unified.FileUploaderParameter;
/**
* Removes a parameter from the aggregation {@link #getParameters parameters}.
* @param {number|string|sap.ui.unified.FileUploaderParameter} vParameter - The parameter to remove or its index or id
* @returns {sap.ui.unified.FileUploaderParameter} The removed parameter or null
*/
public removeParameter(vParameter: number|string|sap.ui.unified.FileUploaderParameter): sap.ui.unified.FileUploaderParameter;
/**
* Sets a new value for property {@link #getAdditionalData additionalData}.
*
* Additional data that is sent to the back end service. Data will be transmitted as value of a hidden input where the name is derived from the name property with suffix -data.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAdditionalData - New value for property additionalData
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setAdditionalData(sAdditionalData: string): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getButtonOnly buttonOnly}.
*
* If set to "true", the FileUploader will be rendered as Button only, without showing the InputField.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bButtonOnly - New value for property buttonOnly
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setButtonOnly(bButtonOnly: boolean): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getButtonText buttonText}.
*
* The Button text can be overwritten using this property.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sButtonText - New value for property buttonText
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setButtonText(sButtonText: string): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* Disabled controls have different colors, depending on customer settings.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getFileType fileType}.
*
* The chosen files will be checked against an array of file types. If at least one file does not fit the file type restriction the upload is prevented.
* Example: ["jpg", "png", "bmp"].
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string[]} sFileType - New value for property fileType
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setFileType(sFileType: string[]): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Icon to be displayed as graphical element within the button.
* This can be a URI to an image or an icon font URI.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getIconFirst iconFirst}.
*
* If set to true (default), the display sequence is 1. icon 2. control text.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIconFirst - New value for property iconFirst
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setIconFirst(bIconFirst: boolean): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getIconHovered iconHovered}.
*
* Icon to be displayed as graphical element within the button when it is hovered (only if also a base icon was specified). If not specified the base icon is used.
* If an icon font icon is used, this property is ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.URI} sIconHovered - New value for property iconHovered
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setIconHovered(sIconHovered: sap.ui.core.URI): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getIconOnly iconOnly}.
*
* If set to true, the button is displayed without any text.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bIconOnly - New value for property iconOnly
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setIconOnly(bIconOnly: boolean): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getIconSelected iconSelected}.
*
* Icon to be displayed as graphical element within the button when it is selected (only if also a base icon was specified). If not specified the base or hovered icon is used.
* If an icon font icon is used, this property is ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.URI} sIconSelected - New value for property iconSelected
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setIconSelected(sIconSelected: sap.ui.core.URI): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getMaximumFilenameLength maximumFilenameLength}.
*
* The maximum length of a filename which the FileUploader will accept. If the maximum filename length is exceeded, the corresponding Event 'filenameLengthExceed' is fired.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} iMaximumFilenameLength - New value for property maximumFilenameLength
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setMaximumFilenameLength(iMaximumFilenameLength: number): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getMaximumFileSize maximumFileSize}.
*
* A file size limit in megabytes which prevents the upload if at least one file exceeds it. This property is not supported by Internet Explorer 9.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {number} fMaximumFileSize - New value for property maximumFileSize
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setMaximumFileSize(fMaximumFileSize: number): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getMimeType mimeType}.
*
* The chosen files will be checked against an array of mime types. If at least one file does not fit the mime type restriction the upload is prevented. This property is not supported by Internet Explorer 9.
* Example: mimeType ["image/png", "image/jpeg"].
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string[]} sMimeType - New value for property mimeType
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setMimeType(sMimeType: string[]): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getMultiple multiple}.
*
* Allows multiple files to be chosen and uploaded from the same folder. This property is not supported by Internet Explorer 9.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bMultiple - New value for property multiple
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setMultiple(bMultiple: boolean): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getName name}.
*
* Unique control name for identification on the server side after sending data to the server.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getPlaceholder placeholder}.
*
* Placeholder for the text field.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sPlaceholder - New value for property placeholder
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setPlaceholder(sPlaceholder: string): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getSameFilenameAllowed sameFilenameAllowed}.
*
* If the FileUploader is configured to upload the file directly after the file is selected it is not allowed to upload a file with the same name again. If a user should be allowed to upload a file with the same name again this parameter has to be "true". A typical use case would be if the files have different paths.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSameFilenameAllowed - New value for property sameFilenameAllowed
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setSameFilenameAllowed(bSameFilenameAllowed: boolean): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getSendXHR sendXHR}.
*
* If set to "true", the request will be sent as XHR request instead of a form submit. This property is not supported by Internet Explorer 9.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSendXHR - New value for property sendXHR
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setSendXHR(bSendXHR: boolean): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getStyle style}.
*
* Style of the button. "Transparent, "Accept", "Reject", or "Emphasized" is allowed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sStyle - New value for property style
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setStyle(sStyle: string): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getUploadOnChange uploadOnChange}.
*
* If set to "true", the upload immediately starts after file selection. With the default setting, the upload needs to be explicitly triggered.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bUploadOnChange - New value for property uploadOnChange
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setUploadOnChange(bUploadOnChange: boolean): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getUploadUrl uploadUrl}.
*
* Used when URL address is on a remote server.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.URI} sUploadUrl - New value for property uploadUrl
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setUploadUrl(sUploadUrl: sap.ui.core.URI): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getUseMultipart useMultipart}.
*
* If set to "false", the request will be sent as file only request instead of a multipart/form-data request. Only one file could be uploaded using this type of request. Required for sending such a request is to set the property "sendXHR" to "true". This property is not supported by Internet Explorer 9.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bUseMultipart - New value for property useMultipart
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setUseMultipart(bUseMultipart: boolean): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getValue value}.
*
* Value of the path for file upload.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sValue - New value for property value
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setValue(sValue: string): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getValueState valueState}.
*
* Visualizes warnings or errors related to the text field. Possible values: Warning, Error, Success, None.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sValueState - New value for property valueState
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setValueState(sValueState: sap.ui.core.ValueState): sap.ui.unified.FileUploader;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Specifies the displayed control width.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.unified.FileUploader} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.unified.FileUploader;
/**
* Starts the upload (as defined by uploadUrl)
*/
public upload(): void;
}
/**
* Represents a parameter for the FileUploader which is rendered as a hidden inputfield.
*/
export class FileUploaderParameter extends sap.ui.core.Element {
/**
* Constructor for a new FileUploaderParameter.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.unified.FileUploaderParameter with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.ui.unified.FileUploaderParameter.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* The name of the hidden inputfield.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets current value of property {@link #getValue value}.
*
* The value of the hidden inputfield.
* @returns {string} Value of property value
*/
public getValue(): string;
/**
* Sets a new value for property {@link #getName name}.
*
* The name of the hidden inputfield.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sName - New value for property name
* @returns {sap.ui.unified.FileUploaderParameter} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.ui.unified.FileUploaderParameter;
/**
* Sets a new value for property {@link #getValue value}.
*
* The value of the hidden inputfield.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sValue - New value for property value
* @returns {sap.ui.unified.FileUploaderParameter} Reference to this
in order to allow method chaining
*/
public setValue(sValue: string): sap.ui.unified.FileUploaderParameter;
}
/**
* Types of display mode for overlapping appointments.
*/
export enum GroupAppointmentsMode {
/**
* Overlapping appointments are displayed as a collapsed group appointment.
*/
Collapsed = "Collapsed",
/**
* Overlapping appointments are displayed individually (expanded from a group).
*/
Expanded = "Expanded",
}
/**
* A menu is an interactive element which provides a choice of different actions to the user. These actions (items) can also be organized in submenus.
* Like other dialog-like controls, the menu is not rendered within the control hierarchy. Instead it can be opened at a specified position via a function call.
*/
export class Menu extends sap.ui.core.Control {
/**
* Constructor for a new Menu control.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.unified.Menu} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.unified.Menu;
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.ui.unified.MenuItemBase} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.ui.unified.Menu} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.ui.unified.MenuItemBase): sap.ui.unified.Menu;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelect itemSelect} event of this sap.ui.unified.Menu
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.Menu
itself.
*
* Fired on the root menu of a menu hierarchy whenever a user selects an item within the menu or within one of its direct or indirect submenus.
* Note: There is also a select event available for each single menu item. This event and the event of the menu items are redundant.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.Menu
itself
* @returns {sap.ui.unified.Menu} Reference to this
in order to allow method chaining
*/
public attachItemSelect(fnFunction: Function, oListener?: any): sap.ui.unified.Menu;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelect itemSelect} event of this sap.ui.unified.Menu
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.Menu
itself.
*
* Fired on the root menu of a menu hierarchy whenever a user selects an item within the menu or within one of its direct or indirect submenus.
* Note: There is also a select event available for each single menu item. This event and the event of the menu items are redundant.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.Menu
itself
* @returns {sap.ui.unified.Menu} Reference to this
in order to allow method chaining
*/
public attachItemSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.Menu;
/**
* Closes the menu.
*/
public close(): void;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.ui.unified.Menu} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.ui.unified.Menu;
/**
* Detaches event handler fnFunction
from the {@link #event:itemSelect itemSelect} event of this sap.ui.unified.Menu
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.Menu} Reference to this
in order to allow method chaining
*/
public detachItemSelect(fnFunction: Function, oListener: any): sap.ui.unified.Menu;
/**
* Creates a new subclass of class sap.ui.unified.Menu with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:itemSelect itemSelect} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.Menu} Reference to this
in order to allow method chaining
*/
protected fireItemSelect(mParameters?: any): sap.ui.unified.Menu;
/**
* Gets current value of property {@link #getAriaDescription ariaDescription}.
*
* Accessible label / description of the menu for assistive technologies like screenreaders.
* @returns {string} Value of property ariaDescription
*/
public getAriaDescription(): string;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* When a menu is disabled none of its items can be selected by the user.
* The enabled property of an item (@link sap.ui.unified.MenuItemBase#getEnabled) has no effect when the menu of the item is disabled.
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Gets content of aggregation {@link #getItems items}.
*
* The available actions to be displayed as items of the menu.
* @returns {sap.ui.unified.MenuItemBase[]}
*/
public getItems(): sap.ui.unified.MenuItemBase[];
/**
* Gets current value of property {@link #getMaxVisibleItems maxVisibleItems}.
*
* The maximum number of items which are displayed before an overflow mechanism takes effect.
* A value smaller than 1 means an infinite number of visible items.
* The overall height of the menu is limited by the height of the screen. If the maximum possible height is reached, an
* overflow takes effect, even if the maximum number of visible items is not yet reached.
*
* Default value is 0
.
* @returns {number} Value of property maxVisibleItems
*/
public getMaxVisibleItems(): number;
/**
* Returns a metadata object for class sap.ui.unified.Menu.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPageSize pageSize}.
*
* The keyboard can be used to navigate through the items of a menu. Beside the arrow keys for single steps and the Home / End keys for jumping
* to the first / last item, the Page Up / Page Down keys can be used to jump an arbitrary number of items up or down. This number can be defined via the pageSize
property.
* For values smaller than 1, paging behaves in a similar way to when using the Home / End keys. If the value equals 1, the paging behavior is similar to that of the arrow keys.
*
* Default value is 5
.
* @returns {number} Value of property pageSize
*/
public getPageSize(): number;
/**
* Checks for the provided sap.ui.unified.MenuItemBase
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.MenuItemBase} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.unified.MenuItemBase): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.ui.unified.MenuItemBase} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.ui.unified.Menu} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.ui.unified.MenuItemBase, iIndex: number): sap.ui.unified.Menu;
/**
* Opens the menu at the specified position.
*
* The position of the menu is defined relative to an element in the visible DOM by specifying
* the docking location of the menu and of the related element.
*
* See {@link sap.ui.core.Popup#open Popup#open} for further details about popup positioning.
* @param {boolean} bWithKeyboard - Indicates whether or not the first item shall be highlighted when the menu is opened (keyboard case)
* @param {sap.ui.core.Element|HTMLElement} oOpenerRef - The element which will get the focus back again after the menu was closed
* @param {sap.ui.core.Dock} sMy - The reference docking location of the menu for positioning the menu on the screen
* @param {sap.ui.core.Dock} sAt - The 'of' element's reference docking location for positioning the menu on the screen
* @param {sap.ui.core.Element|HTMLElement} oOf - The menu is positioned relatively to this element based on the given dock locations
* @param {string} sOffset - The offset relative to the docking point, specified as a string with space-separated pixel values (e.g. "0 10" to move the popup 10 pixels to the right)
* @param {sap.ui.core.Collision} sCollision - The collision defines how the position of the menu should be adjusted in case it overflows the window in some direction
*/
public open(bWithKeyboard: boolean, oOpenerRef: sap.ui.core.Element|HTMLElement, sMy: sap.ui.core.Dock, sAt: sap.ui.core.Dock, oOf: sap.ui.core.Element|HTMLElement, sOffset?: string, sCollision?: sap.ui.core.Collision): void;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.MenuItemBase[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.ui.unified.MenuItemBase[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.ui.unified.MenuItemBase} vItem - The item to remove or its index or id
* @returns {sap.ui.unified.MenuItemBase} The removed item or null
*/
public removeItem(vItem: number|string|sap.ui.unified.MenuItemBase): sap.ui.unified.MenuItemBase;
/**
* Sets a new value for property {@link #getAriaDescription ariaDescription}.
*
* Accessible label / description of the menu for assistive technologies like screenreaders.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAriaDescription - New value for property ariaDescription
* @returns {sap.ui.unified.Menu} Reference to this
in order to allow method chaining
*/
public setAriaDescription(sAriaDescription: string): sap.ui.unified.Menu;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* When a menu is disabled none of its items can be selected by the user.
* The enabled property of an item (@link sap.ui.unified.MenuItemBase#getEnabled) has no effect when the menu of the item is disabled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.unified.Menu} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.unified.Menu;
/**
* Sets a new value for property {@link #getMaxVisibleItems maxVisibleItems}.
*
* The maximum number of items which are displayed before an overflow mechanism takes effect.
* A value smaller than 1 means an infinite number of visible items.
* The overall height of the menu is limited by the height of the screen. If the maximum possible height is reached, an
* overflow takes effect, even if the maximum number of visible items is not yet reached.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iMaxVisibleItems - New value for property maxVisibleItems
* @returns {sap.ui.unified.Menu} Reference to this
in order to allow method chaining
*/
public setMaxVisibleItems(iMaxVisibleItems: number): sap.ui.unified.Menu;
/**
* Sets a new value for property {@link #getPageSize pageSize}.
*
* The keyboard can be used to navigate through the items of a menu. Beside the arrow keys for single steps and the Home / End keys for jumping
* to the first / last item, the Page Up / Page Down keys can be used to jump an arbitrary number of items up or down. This number can be defined via the pageSize
property.
* For values smaller than 1, paging behaves in a similar way to when using the Home / End keys. If the value equals 1, the paging behavior is similar to that of the arrow keys.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 5
.
* @param {number} iPageSize - New value for property pageSize
* @returns {sap.ui.unified.Menu} Reference to this
in order to allow method chaining
*/
public setPageSize(iPageSize: number): sap.ui.unified.Menu;
}
/**
* Standard item to be used inside a menu. A menu item represents an action which can be selected by the user in the menu or
* it can provide a submenu to organize the actions hierarchically.
*/
export class MenuItem extends sap.ui.unified.MenuItemBase {
/**
* Constructor for a new MenuItem element.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.ui.unified.MenuItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.unified.MenuItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Defines the icon of the {@link sap.ui.core.IconPool sap.ui.core.IconPool} or an image which should be displayed on the item.
*
* Default value is
.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.ui.unified.MenuItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* Defines the text which should be displayed on the item.
*
* Default value is
.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Defines the icon of the {@link sap.ui.core.IconPool sap.ui.core.IconPool} or an image which should be displayed on the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.unified.MenuItem} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.unified.MenuItem;
/**
* Sets a new value for property {@link #getText text}.
*
* Defines the text which should be displayed on the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sText - New value for property text
* @returns {sap.ui.unified.MenuItem} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.unified.MenuItem;
}
/**
* Abstract base class for menu item which provides common properties and events for all concrete item implementations.
*/
export class MenuItemBase extends sap.ui.core.Element {
/**
* Abstract base class MenuItemBase
for menu item elements. Please use concrete subclasses.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.MenuItemBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.MenuItemBase
itself.
*
* Fired when the item is selected by the user.
* Note: The event is also available for items which have a submenu.
* In general, applications must not handle event in this case because the user selection opens the sub menu.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.MenuItemBase
itself
* @returns {sap.ui.unified.MenuItemBase} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.unified.MenuItemBase;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.unified.MenuItemBase
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.MenuItemBase
itself.
*
* Fired when the item is selected by the user.
* Note: The event is also available for items which have a submenu.
* In general, applications must not handle event in this case because the user selection opens the sub menu.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.MenuItemBase
itself
* @returns {sap.ui.unified.MenuItemBase} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.MenuItemBase;
/**
* Destroys the submenu in the aggregation {@link #getSubmenu submenu}.
* @returns {sap.ui.unified.MenuItemBase} Reference to this
in order to allow method chaining
*/
public destroySubmenu(): sap.ui.unified.MenuItemBase;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.unified.MenuItemBase
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.MenuItemBase} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.unified.MenuItemBase;
/**
* Creates a new subclass of class sap.ui.unified.MenuItemBase with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.MenuItemBase} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.unified.MenuItemBase;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* When an item is disabled the item can not be selected by the user.
* The enabled property of the item has no effect when the menu of the item is disabled ({@link sap.ui.unified.Menu#getEnabled Menu#getEnabled}).
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Returns a metadata object for class sap.ui.unified.MenuItemBase.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getStartsSection startsSection}.
*
* Defines whether a visual separator should be rendered before the item.
* Note: If an item is invisible also the separator of this item is not shown.
*
* Default value is false
.
* @returns {boolean} Value of property startsSection
*/
public getStartsSection(): boolean;
/**
* Gets content of aggregation {@link #getSubmenu submenu}.
*
* An optional submenu of the item which is opened when the item is selected by the user.
* @returns {sap.ui.unified.Menu}
*/
public getSubmenu(): sap.ui.unified.Menu;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Invisible items do not appear in the menu.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Changes the visual hover state of the menu item.
*
* Subclasses may override this function.
* @param {boolean} bHovered - Specifies whether the item is currently hovered or not.
* @param {sap.ui.unified.Menu} oMenu - The menu to which this item belongs
*/
protected hover(bHovered: boolean, oMenu: sap.ui.unified.Menu): void;
/**
* Informs the item that the item HTML is now applied to the DOM.
*
* Subclasses may override this function.
*/
protected onAfterRendering(): void;
/**
* Event handler which is called whenever the submenu of the item is opened or closed.
*
* Subclasses may override this function.
* @param {boolean} bOpened - Specifies whether the submenu of the item is opened or closed
*/
protected onSubmenuToggle(bOpened: boolean): void;
/**
* Produces the HTML of an item and writes it to render-output-buffer during the rendering of the corresponding menu.
*
* Subclasses may override this function.
* @param {sap.ui.core.RenderManager} oRenderManager - The RenderManager
that can be used for writing to the render-output-buffer
* @param {sap.ui.unified.MenuItemBase} oItem - The item which should be rendered
* @param {sap.ui.unified.Menu} oMenu - The menu to which this item belongs
*/
protected render(oRenderManager: sap.ui.core.RenderManager, oItem: sap.ui.unified.MenuItemBase, oMenu: sap.ui.unified.Menu): void;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* When an item is disabled the item can not be selected by the user.
* The enabled property of the item has no effect when the menu of the item is disabled ({@link sap.ui.unified.Menu#getEnabled Menu#getEnabled}).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.unified.MenuItemBase} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.unified.MenuItemBase;
/**
* Sets a new value for property {@link #getStartsSection startsSection}.
*
* Defines whether a visual separator should be rendered before the item.
* Note: If an item is invisible also the separator of this item is not shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bStartsSection - New value for property startsSection
* @returns {sap.ui.unified.MenuItemBase} Reference to this
in order to allow method chaining
*/
public setStartsSection(bStartsSection: boolean): sap.ui.unified.MenuItemBase;
/**
* Sets the aggregated {@link #getSubmenu submenu}.
* @param {sap.ui.unified.Menu} oSubmenu - The submenu to set
* @returns {sap.ui.unified.MenuItemBase} Reference to this
in order to allow method chaining
*/
public setSubmenu(oSubmenu: sap.ui.unified.Menu): sap.ui.unified.MenuItemBase;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Invisible items do not appear in the menu.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.ui.unified.MenuItemBase} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.unified.MenuItemBase;
}
/**
* Special menu item which contains a label and a text field. This menu item is e.g. helpful for filter implementations.
* The aggregation submenu
(inherited from parent class) is not supported for this type of menu item.
*/
export class MenuTextFieldItem extends sap.ui.unified.MenuItemBase {
/**
* Constructor for a new MenuTextFieldItem element.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - Id for the new control, generated automatically if no id is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* The aggregation submenu
(inherited from parent class) is not supported for this type of menu item.
* @returns {sap.ui.unified.MenuTextFieldItem} this
to allow method chaining
*/
public destroySubmenu(): sap.ui.unified.MenuTextFieldItem;
/**
* Creates a new subclass of class sap.ui.unified.MenuTextFieldItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.unified.MenuItemBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Defines the icon of the {@link sap.ui.core.IconPool sap.ui.core.IconPool} or an image which should be displayed on the item.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getLabel label}.
*
* Defines the label of the text field of the item.
* @returns {string} Value of property label
*/
public getLabel(): string;
/**
* Returns a metadata object for class sap.ui.unified.MenuTextFieldItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* The aggregation submenu
(inherited from parent class) is not supported for this type of menu item.
* @returns {sap.ui.unified.Menu}
*/
public getSubmenu(): sap.ui.unified.Menu;
/**
* Gets current value of property {@link #getValue value}.
*
* Defines the value of the text field of the item.
* @returns {string} Value of property value
*/
public getValue(): string;
/**
* Gets current value of property {@link #getValueState valueState}.
*
* Defines the value state of the text field of the item. This allows you to visualize e.g. warnings or errors.
*
* Default value is None
.
* @returns {sap.ui.core.ValueState} Value of property valueState
*/
public getValueState(): sap.ui.core.ValueState;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Defines the icon of the {@link sap.ui.core.IconPool sap.ui.core.IconPool} or an image which should be displayed on the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.unified.MenuTextFieldItem} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.unified.MenuTextFieldItem;
/**
* Sets a new value for property {@link #getLabel label}.
*
* Defines the label of the text field of the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sLabel - New value for property label
* @returns {sap.ui.unified.MenuTextFieldItem} Reference to this
in order to allow method chaining
*/
public setLabel(sLabel: string): sap.ui.unified.MenuTextFieldItem;
/**
* The aggregation submenu
(inherited from parent class) is not supported for this type of menu item.
* @param {sap.ui.unified.Menu} oSubmenu
* @returns {sap.ui.unified.MenuTextFieldItem} this
to allow method chaining
*/
public setSubmenu(oSubmenu: sap.ui.unified.Menu): sap.ui.unified.MenuTextFieldItem;
/**
* Sets a new value for property {@link #getValue value}.
*
* Defines the value of the text field of the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sValue - New value for property value
* @returns {sap.ui.unified.MenuTextFieldItem} Reference to this
in order to allow method chaining
*/
public setValue(sValue: string): sap.ui.unified.MenuTextFieldItem;
/**
* Sets a new value for property {@link #getValueState valueState}.
*
* Defines the value state of the text field of the item. This allows you to visualize e.g. warnings or errors.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is None
.
* @param {sap.ui.core.ValueState} sValueState - New value for property valueState
* @returns {sap.ui.unified.MenuTextFieldItem} Reference to this
in order to allow method chaining
*/
public setValueState(sValueState: sap.ui.core.ValueState): sap.ui.unified.MenuTextFieldItem;
}
/**
* The shell control is meant as root control (full-screen) of an application.
* It was build as root control of the Fiori Launchpad application and provides the basic capabilities
* for this purpose. Do not use this control within applications which run inside the Fiori Lauchpad and
* do not use it for other scenarios than the root control usecase.
*/
export class Shell extends sap.ui.unified.ShellLayout {
/**
* Constructor for a new Shell.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some curtainContent to the aggregation {@link #getCurtainContent curtainContent}.
* @param {sap.ui.core.Control} oCurtainContent - the curtainContent to add; if empty, nothing is inserted
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public addCurtainContent(oCurtainContent: sap.ui.core.Control): sap.ui.unified.Shell;
/**
* Adds some curtainPaneContent to the aggregation {@link #getCurtainPaneContent curtainPaneContent}.
* @param {sap.ui.core.Control} oCurtainPaneContent - the curtainPaneContent to add; if empty, nothing is inserted
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public addCurtainPaneContent(oCurtainPaneContent: sap.ui.core.Control): sap.ui.unified.Shell;
/**
* Adds some headEndItem to the aggregation {@link #getHeadEndItems headEndItems}.
* @param {sap.ui.unified.ShellHeadItem} oHeadEndItem - the headEndItem to add; if empty, nothing is inserted
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public addHeadEndItem(oHeadEndItem: sap.ui.unified.ShellHeadItem): sap.ui.unified.Shell;
/**
* Adds some headItem to the aggregation {@link #getHeadItems headItems}.
* @param {sap.ui.unified.ShellHeadItem} oHeadItem - the headItem to add; if empty, nothing is inserted
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public addHeadItem(oHeadItem: sap.ui.unified.ShellHeadItem): sap.ui.unified.Shell;
/**
* Destroys all the curtainContent in the aggregation {@link #getCurtainContent curtainContent}.
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public destroyCurtainContent(): sap.ui.unified.Shell;
/**
* Destroys all the curtainPaneContent in the aggregation {@link #getCurtainPaneContent curtainPaneContent}.
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public destroyCurtainPaneContent(): sap.ui.unified.Shell;
/**
* Destroys all the headEndItems in the aggregation {@link #getHeadEndItems headEndItems}.
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public destroyHeadEndItems(): sap.ui.unified.Shell;
/**
* Destroys the header in the aggregation named header
, but only if a custom header is set.
* The default header can not be destroyed.
* @returns {sap.ui.unified.Shell} this
to allow method chaining
*/
public destroyHeader(): sap.ui.unified.Shell;
/**
* Destroys all the headItems in the aggregation {@link #getHeadItems headItems}.
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public destroyHeadItems(): sap.ui.unified.Shell;
/**
* Destroys the search in the aggregation {@link #getSearch search}.
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public destroySearch(): sap.ui.unified.Shell;
/**
* Destroys the user in the aggregation {@link #getUser user}.
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public destroyUser(): sap.ui.unified.Shell;
/**
* Creates a new subclass of class sap.ui.unified.Shell with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.unified.ShellLayout.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getCurtainContent curtainContent}.
*
* The content to appear in the curtain area.
* @returns {sap.ui.core.Control[]}
*/
public getCurtainContent(): sap.ui.core.Control[];
/**
* Gets content of aggregation {@link #getCurtainPaneContent curtainPaneContent}.
*
* The content to appear in the pane area of the curtain.
* @returns {sap.ui.core.Control[]}
*/
public getCurtainPaneContent(): sap.ui.core.Control[];
/**
* Gets content of aggregation {@link #getHeadEndItems headEndItems}.
*
* The buttons shown in the end (right in left-to-right case) of the Shell header. Currently max. 3 visible buttons are supported (when user is set only 1). If a custom header is set this aggregation has no effect.
* @returns {sap.ui.unified.ShellHeadItem[]}
*/
public getHeadEndItems(): sap.ui.unified.ShellHeadItem[];
/**
* Gets content of aggregation {@link #getHeadItems headItems}.
*
* The buttons shown in the begin (left in left-to-right case) of the Shell header. Currently max. 3 visible buttons are supported. If a custom header is set this aggregation has no effect.
* @returns {sap.ui.unified.ShellHeadItem[]}
*/
public getHeadItems(): sap.ui.unified.ShellHeadItem[];
/**
* Gets current value of property {@link #getIcon icon}.
*
* The application icon. If a custom header is set this property has no effect.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.ui.unified.Shell.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getSearch search}.
*
* Experimental (This aggregation might change in future!): The search control which should be displayed in the shell header. If a custom header is set this aggregation has no effect.
* @returns {sap.ui.core.Control}
*/
public getSearch(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getSearchVisible searchVisible}.
*
* If set to false, the search area (aggregation 'search') is hidden. If a custom header is set this property has no effect.
*
* Default value is true
.
* @returns {boolean} Value of property searchVisible
*/
public getSearchVisible(): boolean;
/**
* Gets current value of property {@link #getShowCurtain showCurtain}.
*
* Shows / Hides the curtain.
* @returns {boolean} Value of property showCurtain
*/
public getShowCurtain(): boolean;
/**
* Gets current value of property {@link #getShowCurtainPane showCurtainPane}.
*
* Shows / Hides the side pane on the curtain.
* @returns {boolean} Value of property showCurtainPane
*/
public getShowCurtainPane(): boolean;
/**
* Gets content of aggregation {@link #getUser user}.
*
* The user item which is rendered in the shell header beside the items. If a custom header is set this aggregation has no effect.
* @returns {sap.ui.unified.ShellHeadUserItem}
*/
public getUser(): sap.ui.unified.ShellHeadUserItem;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getCurtainContent curtainContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oCurtainContent - The curtainContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfCurtainContent(oCurtainContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getCurtainPaneContent curtainPaneContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oCurtainPaneContent - The curtainPaneContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfCurtainPaneContent(oCurtainPaneContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.unified.ShellHeadItem
in the aggregation {@link #getHeadEndItems headEndItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.ShellHeadItem} oHeadEndItem - The headEndItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfHeadEndItem(oHeadEndItem: sap.ui.unified.ShellHeadItem): number;
/**
* Checks for the provided sap.ui.unified.ShellHeadItem
in the aggregation {@link #getHeadItems headItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.unified.ShellHeadItem} oHeadItem - The headItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfHeadItem(oHeadItem: sap.ui.unified.ShellHeadItem): number;
/**
* Inserts a curtainContent into the aggregation {@link #getCurtainContent curtainContent}.
* @param {sap.ui.core.Control} oCurtainContent - the curtainContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the curtainContent should be inserted at; for a negative value of iIndex
, the curtainContent is inserted at position 0; for a value greater than the current size of the aggregation, the curtainContent is inserted at the last position
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public insertCurtainContent(oCurtainContent: sap.ui.core.Control, iIndex: number): sap.ui.unified.Shell;
/**
* Inserts a curtainPaneContent into the aggregation {@link #getCurtainPaneContent curtainPaneContent}.
* @param {sap.ui.core.Control} oCurtainPaneContent - the curtainPaneContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the curtainPaneContent should be inserted at; for a negative value of iIndex
, the curtainPaneContent is inserted at position 0; for a value greater than the current size of the aggregation, the curtainPaneContent is inserted at the last position
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public insertCurtainPaneContent(oCurtainPaneContent: sap.ui.core.Control, iIndex: number): sap.ui.unified.Shell;
/**
* Inserts a headEndItem into the aggregation {@link #getHeadEndItems headEndItems}.
* @param {sap.ui.unified.ShellHeadItem} oHeadEndItem - the headEndItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the headEndItem should be inserted at; for a negative value of iIndex
, the headEndItem is inserted at position 0; for a value greater than the current size of the aggregation, the headEndItem is inserted at the last position
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public insertHeadEndItem(oHeadEndItem: sap.ui.unified.ShellHeadItem, iIndex: number): sap.ui.unified.Shell;
/**
* Inserts a headItem into the aggregation {@link #getHeadItems headItems}.
* @param {sap.ui.unified.ShellHeadItem} oHeadItem - the headItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the headItem should be inserted at; for a negative value of iIndex
, the headItem is inserted at position 0; for a value greater than the current size of the aggregation, the headItem is inserted at the last position
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public insertHeadItem(oHeadItem: sap.ui.unified.ShellHeadItem, iIndex: number): sap.ui.unified.Shell;
/**
* Removes all the controls from the aggregation {@link #getCurtainContent curtainContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllCurtainContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getCurtainPaneContent curtainPaneContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllCurtainPaneContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getHeadEndItems headEndItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.ShellHeadItem[]} An array of the removed elements (might be empty)
*/
public removeAllHeadEndItems(): sap.ui.unified.ShellHeadItem[];
/**
* Removes all the controls from the aggregation {@link #getHeadItems headItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.unified.ShellHeadItem[]} An array of the removed elements (might be empty)
*/
public removeAllHeadItems(): sap.ui.unified.ShellHeadItem[];
/**
* Removes a curtainContent from the aggregation {@link #getCurtainContent curtainContent}.
* @param {number|string|sap.ui.core.Control} vCurtainContent - The curtainContent to remove or its index or id
* @returns {sap.ui.core.Control} The removed curtainContent or null
*/
public removeCurtainContent(vCurtainContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a curtainPaneContent from the aggregation {@link #getCurtainPaneContent curtainPaneContent}.
* @param {number|string|sap.ui.core.Control} vCurtainPaneContent - The curtainPaneContent to remove or its index or id
* @returns {sap.ui.core.Control} The removed curtainPaneContent or null
*/
public removeCurtainPaneContent(vCurtainPaneContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a headEndItem from the aggregation {@link #getHeadEndItems headEndItems}.
* @param {number|string|sap.ui.unified.ShellHeadItem} vHeadEndItem - The headEndItem to remove or its index or id
* @returns {sap.ui.unified.ShellHeadItem} The removed headEndItem or null
*/
public removeHeadEndItem(vHeadEndItem: number|string|sap.ui.unified.ShellHeadItem): sap.ui.unified.ShellHeadItem;
/**
* Removes a headItem from the aggregation {@link #getHeadItems headItems}.
* @param {number|string|sap.ui.unified.ShellHeadItem} vHeadItem - The headItem to remove or its index or id
* @returns {sap.ui.unified.ShellHeadItem} The removed headItem or null
*/
public removeHeadItem(vHeadItem: number|string|sap.ui.unified.ShellHeadItem): sap.ui.unified.ShellHeadItem;
/**
* Setter for the aggregated header
.
* @param {sap.ui.core.Control} oHeader - The Control which should be rendered within the Shell header or null
to render the default Shell header.
* @returns {sap.ui.unified.Shell} this
to allow method chaining
*/
public setHeader(oHeader: sap.ui.core.Control): sap.ui.unified.Shell;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* The application icon. If a custom header is set this property has no effect.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.unified.Shell;
/**
* Sets the aggregated {@link #getSearch search}.
* @param {sap.ui.core.Control} oSearch - The search to set
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public setSearch(oSearch: sap.ui.core.Control): sap.ui.unified.Shell;
/**
* Sets a new value for property {@link #getSearchVisible searchVisible}.
*
* If set to false, the search area (aggregation 'search') is hidden. If a custom header is set this property has no effect.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bSearchVisible - New value for property searchVisible
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public setSearchVisible(bSearchVisible: boolean): sap.ui.unified.Shell;
/**
* Sets a new value for property {@link #getShowCurtain showCurtain}.
*
* Shows / Hides the curtain.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bShowCurtain - New value for property showCurtain
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public setShowCurtain(bShowCurtain: boolean): sap.ui.unified.Shell;
/**
* Sets a new value for property {@link #getShowCurtainPane showCurtainPane}.
*
* Shows / Hides the side pane on the curtain.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bShowCurtainPane - New value for property showCurtainPane
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public setShowCurtainPane(bShowCurtainPane: boolean): sap.ui.unified.Shell;
/**
* Sets the aggregated {@link #getUser user}.
* @param {sap.ui.unified.ShellHeadUserItem} oUser - The user to set
* @returns {sap.ui.unified.Shell} Reference to this
in order to allow method chaining
*/
public setUser(oUser: sap.ui.unified.ShellHeadUserItem): sap.ui.unified.Shell;
}
/**
* Header Action item of the Shell.
*/
export class ShellHeadItem extends sap.ui.core.Element {
/**
* Constructor for a new ShellHeadItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.unified.ShellHeadItem} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.unified.ShellHeadItem;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.unified.ShellHeadItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.ShellHeadItem
itself.
*
* Event is fired when the user presses the item.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.ShellHeadItem
itself
* @returns {sap.ui.unified.ShellHeadItem} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.ui.unified.ShellHeadItem;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.unified.ShellHeadItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.ShellHeadItem
itself.
*
* Event is fired when the user presses the item.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.ShellHeadItem
itself
* @returns {sap.ui.unified.ShellHeadItem} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.ShellHeadItem;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.ui.unified.ShellHeadItem
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.ShellHeadItem} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.ui.unified.ShellHeadItem;
/**
* Creates a new subclass of class sap.ui.unified.ShellHeadItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.ShellHeadItem} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.ui.unified.ShellHeadItem;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getIcon icon}.
*
* The icon of the item, either defined in the sap.ui.core.IconPool or a URI to a custom image. An icon must be set.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.ui.unified.ShellHeadItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSelected selected}.
*
* Defines the toggle state in case the item represents a toggle button (see also property toggleEnabled
).
*
* Default value is false
.
* @returns {boolean} Value of property selected
*/
public getSelected(): boolean;
/**
* Gets current value of property {@link #getShowMarker showMarker}.
*
* If set to true, a theme dependent marker is shown on the item.
*
* Default value is false
.
* @returns {boolean} Value of property showMarker
*/
public getShowMarker(): boolean;
/**
* Gets current value of property {@link #getShowSeparator showSeparator}.
*
* If set to true, a separator is displayed after the item.
*
* Default value is true
.
* @returns {boolean} Value of property showSeparator
*/
public getShowSeparator(): boolean;
/**
* Gets current value of property {@link #getStartsSection startsSection}.
*
* If set to true, a divider is displayed before the item.
*
* Default value is false
.
* @returns {boolean} Value of property startsSection
*/
public getStartsSection(): boolean;
/**
* Gets current value of property {@link #getToggleEnabled toggleEnabled}.
*
* If set to true, the item represents a toggle button. The selected
property can the be used to
* define the toggle state. Otherwise the item is displayed as action button. In this case the selected
property
* is ignored.
*
* Default value is true
.
* @returns {boolean} Value of property toggleEnabled
*/
public getToggleEnabled(): boolean;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Invisible items are not shown on the UI.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* The icon of the item, either defined in the sap.ui.core.IconPool or a URI to a custom image. An icon must be set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.unified.ShellHeadItem} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.unified.ShellHeadItem;
/**
* Sets a new value for property {@link #getSelected selected}.
*
* Defines the toggle state in case the item represents a toggle button (see also property toggleEnabled
).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bSelected - New value for property selected
* @returns {sap.ui.unified.ShellHeadItem} Reference to this
in order to allow method chaining
*/
public setSelected(bSelected: boolean): sap.ui.unified.ShellHeadItem;
/**
* Sets a new value for property {@link #getShowMarker showMarker}.
*
* If set to true, a theme dependent marker is shown on the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowMarker - New value for property showMarker
* @returns {sap.ui.unified.ShellHeadItem} Reference to this
in order to allow method chaining
*/
public setShowMarker(bShowMarker: boolean): sap.ui.unified.ShellHeadItem;
/**
* Sets a new value for property {@link #getShowSeparator showSeparator}.
*
* If set to true, a separator is displayed after the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowSeparator - New value for property showSeparator
* @returns {sap.ui.unified.ShellHeadItem} Reference to this
in order to allow method chaining
*/
public setShowSeparator(bShowSeparator: boolean): sap.ui.unified.ShellHeadItem;
/**
* Sets a new value for property {@link #getStartsSection startsSection}.
*
* If set to true, a divider is displayed before the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bStartsSection - New value for property startsSection
* @returns {sap.ui.unified.ShellHeadItem} Reference to this
in order to allow method chaining
*/
public setStartsSection(bStartsSection: boolean): sap.ui.unified.ShellHeadItem;
/**
* Sets a new value for property {@link #getToggleEnabled toggleEnabled}.
*
* If set to true, the item represents a toggle button. The selected
property can the be used to
* define the toggle state. Otherwise the item is displayed as action button. In this case the selected
property
* is ignored.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bToggleEnabled - New value for property toggleEnabled
* @returns {sap.ui.unified.ShellHeadItem} Reference to this
in order to allow method chaining
*/
public setToggleEnabled(bToggleEnabled: boolean): sap.ui.unified.ShellHeadItem;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Invisible items are not shown on the UI.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.ui.unified.ShellHeadItem} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.unified.ShellHeadItem;
}
/**
* User Header Action Item of the Shell.
*/
export class ShellHeadUserItem extends sap.ui.core.Element {
/**
* Constructor for a new ShellHeadUserItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.unified.ShellHeadUserItem} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.unified.ShellHeadUserItem;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.unified.ShellHeadUserItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.ShellHeadUserItem
itself.
*
* Event is fired when the user presses the button.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.ShellHeadUserItem
itself
* @returns {sap.ui.unified.ShellHeadUserItem} Reference to this
in order to allow method chaining
*/
public attachPress(fnFunction: Function, oListener?: any): sap.ui.unified.ShellHeadUserItem;
/**
* Attaches event handler fnFunction
to the {@link #event:press press} event of this sap.ui.unified.ShellHeadUserItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.ShellHeadUserItem
itself.
*
* Event is fired when the user presses the button.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.ShellHeadUserItem
itself
* @returns {sap.ui.unified.ShellHeadUserItem} Reference to this
in order to allow method chaining
*/
public attachPress(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.ShellHeadUserItem;
/**
* Detaches event handler fnFunction
from the {@link #event:press press} event of this sap.ui.unified.ShellHeadUserItem
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.ShellHeadUserItem} Reference to this
in order to allow method chaining
*/
public detachPress(fnFunction: Function, oListener: any): sap.ui.unified.ShellHeadUserItem;
/**
* Creates a new subclass of class sap.ui.unified.ShellHeadUserItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:press press} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.ShellHeadUserItem} Reference to this
in order to allow method chaining
*/
protected firePress(mParameters?: any): sap.ui.unified.ShellHeadUserItem;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getImage image}.
*
* An image of the user, normally a URI to an image but also an icon from the sap.ui.core.IconPool is possible.
* @returns {sap.ui.core.URI} Value of property image
*/
public getImage(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.ui.unified.ShellHeadUserItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowPopupIndicator showPopupIndicator}.
*
* The user item is intended to be used for user settings. Normally these settings are done via a Menu or Dialog.
* If this property is set to true an indicator for such a popup mechanismn is shown in the item.
*
* Default value is true
.
* @returns {boolean} Value of property showPopupIndicator
*/
public getShowPopupIndicator(): boolean;
/**
* Gets current value of property {@link #getUsername username}.
*
* The name of the user.
*
* Default value is
.
* @returns {string} Value of property username
*/
public getUsername(): string;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Sets a new value for property {@link #getImage image}.
*
* An image of the user, normally a URI to an image but also an icon from the sap.ui.core.IconPool is possible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sImage - New value for property image
* @returns {sap.ui.unified.ShellHeadUserItem} Reference to this
in order to allow method chaining
*/
public setImage(sImage: sap.ui.core.URI): sap.ui.unified.ShellHeadUserItem;
/**
* Sets a new value for property {@link #getShowPopupIndicator showPopupIndicator}.
*
* The user item is intended to be used for user settings. Normally these settings are done via a Menu or Dialog.
* If this property is set to true an indicator for such a popup mechanismn is shown in the item.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowPopupIndicator - New value for property showPopupIndicator
* @returns {sap.ui.unified.ShellHeadUserItem} Reference to this
in order to allow method chaining
*/
public setShowPopupIndicator(bShowPopupIndicator: boolean): sap.ui.unified.ShellHeadUserItem;
/**
* Sets a new value for property {@link #getUsername username}.
*
* The name of the user.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sUsername - New value for property username
* @returns {sap.ui.unified.ShellHeadUserItem} Reference to this
in order to allow method chaining
*/
public setUsername(sUsername: string): sap.ui.unified.ShellHeadUserItem;
}
/**
* The shell layout is the base for the shell control which is meant as root control (full-screen) of an application.
* It was build as root control of the Fiori Launchpad application and provides the basic capabilities
* for this purpose. Do not use this control within applications which run inside the Fiori Lauchpad and
* do not use it for other scenarios than the root control usecase.
*/
export class ShellLayout extends sap.ui.core.Control {
/**
* Constructor for a new ShellLayout.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.unified.ShellLayout} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.unified.ShellLayout;
/**
* Adds some paneContent to the aggregation {@link #getPaneContent paneContent}.
* @param {sap.ui.core.Control} oPaneContent - the paneContent to add; if empty, nothing is inserted
* @returns {sap.ui.unified.ShellLayout} Reference to this
in order to allow method chaining
*/
public addPaneContent(oPaneContent: sap.ui.core.Control): sap.ui.unified.ShellLayout;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.unified.ShellLayout} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.unified.ShellLayout;
/**
* Destroys the header in the aggregation {@link #getHeader header}.
* @returns {sap.ui.unified.ShellLayout} Reference to this
in order to allow method chaining
*/
public destroyHeader(): sap.ui.unified.ShellLayout;
/**
* Destroys all the paneContent in the aggregation {@link #getPaneContent paneContent}.
* @returns {sap.ui.unified.ShellLayout} Reference to this
in order to allow method chaining
*/
public destroyPaneContent(): sap.ui.unified.ShellLayout;
/**
* Creates a new subclass of class sap.ui.unified.ShellLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content to appear in the main canvas.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets content of aggregation {@link #getHeader header}.
*
* The control to appear in the header area.
* @returns {sap.ui.core.Control}
*/
public getHeader(): sap.ui.core.Control;
/**
* Gets current value of property {@link #getHeaderHiding headerHiding}.
*
* Whether the header can be hidden (manually or automatically). This feature is only available when touch events are supported.
*
* Default value is false
.
* @returns {boolean} Value of property headerHiding
*/
public getHeaderHiding(): boolean;
/**
* Gets current value of property {@link #getHeaderVisible headerVisible}.
*
* If set to false, no header (and no items, search, ...) is shown.
*
* Default value is true
.
* @returns {boolean} Value of property headerVisible
*/
public getHeaderVisible(): boolean;
/**
* Returns a metadata object for class sap.ui.unified.ShellLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getPaneContent paneContent}.
*
* The content to appear in the pane area.
* @returns {sap.ui.core.Control[]}
*/
public getPaneContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getShowPane showPane}.
*
* Shows / Hides the side pane.
*
* Default value is false
.
* @returns {boolean} Value of property showPane
*/
public getShowPane(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getPaneContent paneContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oPaneContent - The paneContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfPaneContent(oPaneContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.unified.ShellLayout} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.unified.ShellLayout;
/**
* Inserts a paneContent into the aggregation {@link #getPaneContent paneContent}.
* @param {sap.ui.core.Control} oPaneContent - the paneContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the paneContent should be inserted at; for a negative value of iIndex
, the paneContent is inserted at position 0; for a value greater than the current size of the aggregation, the paneContent is inserted at the last position
* @returns {sap.ui.unified.ShellLayout} Reference to this
in order to allow method chaining
*/
public insertPaneContent(oPaneContent: sap.ui.core.Control, iIndex: number): sap.ui.unified.ShellLayout;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getPaneContent paneContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllPaneContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a paneContent from the aggregation {@link #getPaneContent paneContent}.
* @param {number|string|sap.ui.core.Control} vPaneContent - The paneContent to remove or its index or id
* @returns {sap.ui.core.Control} The removed paneContent or null
*/
public removePaneContent(vPaneContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets the aggregated {@link #getHeader header}.
* @param {sap.ui.core.Control} oHeader - The header to set
* @returns {sap.ui.unified.ShellLayout} Reference to this
in order to allow method chaining
*/
public setHeader(oHeader: sap.ui.core.Control): sap.ui.unified.ShellLayout;
/**
* Sets a new value for property {@link #getHeaderHiding headerHiding}.
*
* Whether the header can be hidden (manually or automatically). This feature is only available when touch events are supported.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bHeaderHiding - New value for property headerHiding
* @returns {sap.ui.unified.ShellLayout} Reference to this
in order to allow method chaining
*/
public setHeaderHiding(bHeaderHiding: boolean): sap.ui.unified.ShellLayout;
/**
* Sets a new value for property {@link #getHeaderVisible headerVisible}.
*
* If set to false, no header (and no items, search, ...) is shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bHeaderVisible - New value for property headerVisible
* @returns {sap.ui.unified.ShellLayout} Reference to this
in order to allow method chaining
*/
public setHeaderVisible(bHeaderVisible: boolean): sap.ui.unified.ShellLayout;
/**
* Sets a new value for property {@link #getShowPane showPane}.
*
* Shows / Hides the side pane.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowPane - New value for property showPane
* @returns {sap.ui.unified.ShellLayout} Reference to this
in order to allow method chaining
*/
public setShowPane(bShowPane: boolean): sap.ui.unified.ShellLayout;
}
/**
* ShellOverlay to be opened in front of an sap.ui.unified.Shell
*/
export class ShellOverlay extends sap.ui.core.Control {
/**
* Constructor for a new ShellOverlay.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - the ariaLabelledBy to add; if empty, nothing is inserted
* @returns {sap.ui.unified.ShellOverlay} Reference to this
in order to allow method chaining
*/
public addAriaLabelledBy(vAriaLabelledBy: sap.ui.core.ID|sap.ui.core.Control): sap.ui.unified.ShellOverlay;
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.unified.ShellOverlay} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.unified.ShellOverlay;
/**
* Attaches event handler fnFunction
to the {@link #event:closed closed} event of this sap.ui.unified.ShellOverlay
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.ShellOverlay
itself.
*
* Fired when the overlay was closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.ShellOverlay
itself
* @returns {sap.ui.unified.ShellOverlay} Reference to this
in order to allow method chaining
*/
public attachClosed(fnFunction: Function, oListener?: any): sap.ui.unified.ShellOverlay;
/**
* Attaches event handler fnFunction
to the {@link #event:closed closed} event of this sap.ui.unified.ShellOverlay
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.unified.ShellOverlay
itself.
*
* Fired when the overlay was closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.unified.ShellOverlay
itself
* @returns {sap.ui.unified.ShellOverlay} Reference to this
in order to allow method chaining
*/
public attachClosed(oData: any, fnFunction: Function, oListener?: any): sap.ui.unified.ShellOverlay;
/**
* Closes the ShellOverlay.
*/
public close(): void;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.unified.ShellOverlay} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.unified.ShellOverlay;
/**
* Destroys the search in the aggregation {@link #getSearch search}.
* @returns {sap.ui.unified.ShellOverlay} Reference to this
in order to allow method chaining
*/
public destroySearch(): sap.ui.unified.ShellOverlay;
/**
* Detaches event handler fnFunction
from the {@link #event:closed closed} event of this sap.ui.unified.ShellOverlay
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.unified.ShellOverlay} Reference to this
in order to allow method chaining
*/
public detachClosed(fnFunction: Function, oListener: any): sap.ui.unified.ShellOverlay;
/**
* Creates a new subclass of class sap.ui.unified.ShellOverlay with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:closed closed} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.unified.ShellOverlay} Reference to this
in order to allow method chaining
*/
protected fireClosed(mParameters?: any): sap.ui.unified.ShellOverlay;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]}
*/
public getAriaLabelledBy(): sap.ui.core.ID[];
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content to appear in the overlay.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.ui.unified.ShellOverlay.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getSearch search}.
*
* Experimental (This aggregation might change in future!): The search control which should be displayed in the overlay header.
* @returns {sap.ui.core.Control}
*/
public getSearch(): sap.ui.core.Control;
/**
* ID of the element which is the current target of the association {@link #getShell shell}, or null
.
* @returns {sap.ui.core.ID}
*/
public getShell(): sap.ui.core.ID;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.unified.ShellOverlay} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.unified.ShellOverlay;
/**
* Opens the ShellOverlay.
*/
public open(): void;
/**
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAriaLabelledBy(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
* @param {number|sap.ui.core.ID|sap.ui.core.Control} vAriaLabelledBy - The ariaLabelledBy to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed ariaLabelledBy or null
*/
public removeAriaLabelledBy(vAriaLabelledBy: number|sap.ui.core.ID|sap.ui.core.Control): sap.ui.core.ID;
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets the aggregated {@link #getSearch search}.
* @param {sap.ui.core.Control} oSearch - The search to set
* @returns {sap.ui.unified.ShellOverlay} Reference to this
in order to allow method chaining
*/
public setSearch(oSearch: sap.ui.core.Control): sap.ui.unified.ShellOverlay;
/**
* Sets the associated {@link #getShell shell}.
* @param {sap.ui.core.ID|sap.ui.unified.ShellLayout} oShell - ID of an element which becomes the new target of this shell association; alternatively, an element instance may be given
* @returns {sap.ui.unified.ShellOverlay} Reference to this
in order to allow method chaining
*/
public setShell(oShell: sap.ui.core.ID|sap.ui.unified.ShellLayout): sap.ui.unified.ShellOverlay;
}
/**
* Provides a main content and a secondary content area
*/
export class SplitContainer extends sap.ui.core.Control {
/**
* Constructor for a new SplitContainer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.unified.SplitContainer} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.unified.SplitContainer;
/**
* Adds some secondaryContent to the aggregation {@link #getSecondaryContent secondaryContent}.
* @param {sap.ui.core.Control} oSecondaryContent - the secondaryContent to add; if empty, nothing is inserted
* @returns {sap.ui.unified.SplitContainer} Reference to this
in order to allow method chaining
*/
public addSecondaryContent(oSecondaryContent: sap.ui.core.Control): sap.ui.unified.SplitContainer;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.unified.SplitContainer} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.unified.SplitContainer;
/**
* Destroys all the secondaryContent in the aggregation {@link #getSecondaryContent secondaryContent}.
* @returns {sap.ui.unified.SplitContainer} Reference to this
in order to allow method chaining
*/
public destroySecondaryContent(): sap.ui.unified.SplitContainer;
/**
* Creates a new subclass of class sap.ui.unified.SplitContainer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content to appear in the main area.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.ui.unified.SplitContainer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getOrientation orientation}.
*
* Whether to show the secondary content on the left ("Horizontal", default) or on the top ("Vertical").
*
* Default value is Horizontal
.
* @returns {sap.ui.core.Orientation} Value of property orientation
*/
public getOrientation(): sap.ui.core.Orientation;
/**
* Gets content of aggregation {@link #getSecondaryContent secondaryContent}.
*
* The content to appear in the secondary area.
* @returns {sap.ui.core.Control[]}
*/
public getSecondaryContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getSecondaryContentSize secondaryContentSize}.
*
* The width if the secondary content. The height is always 100%.
*
* Default value is 250px
.
* @returns {sap.ui.core.CSSSize} Value of property secondaryContentSize
*/
public getSecondaryContentSize(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getSecondaryContentWidth secondaryContentWidth}.
*
* Do not use. Use secondaryContentSize instead.
*
* Default value is 250px
.
* @returns {sap.ui.core.CSSSize} Value of property secondaryContentWidth
*/
public getSecondaryContentWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getShowSecondaryContent showSecondaryContent}.
*
* Shows / Hides the secondary area.
* @returns {boolean} Value of property showSecondaryContent
*/
public getShowSecondaryContent(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getSecondaryContent secondaryContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oSecondaryContent - The secondaryContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSecondaryContent(oSecondaryContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.unified.SplitContainer} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.unified.SplitContainer;
/**
* Inserts a secondaryContent into the aggregation {@link #getSecondaryContent secondaryContent}.
* @param {sap.ui.core.Control} oSecondaryContent - the secondaryContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the secondaryContent should be inserted at; for a negative value of iIndex
, the secondaryContent is inserted at position 0; for a value greater than the current size of the aggregation, the secondaryContent is inserted at the last position
* @returns {sap.ui.unified.SplitContainer} Reference to this
in order to allow method chaining
*/
public insertSecondaryContent(oSecondaryContent: sap.ui.core.Control, iIndex: number): sap.ui.unified.SplitContainer;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getSecondaryContent secondaryContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllSecondaryContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a secondaryContent from the aggregation {@link #getSecondaryContent secondaryContent}.
* @param {number|string|sap.ui.core.Control} vSecondaryContent - The secondaryContent to remove or its index or id
* @returns {sap.ui.core.Control} The removed secondaryContent or null
*/
public removeSecondaryContent(vSecondaryContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getOrientation orientation}.
*
* Whether to show the secondary content on the left ("Horizontal", default) or on the top ("Vertical").
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Horizontal
.
* @param {sap.ui.core.Orientation} sOrientation - New value for property orientation
* @returns {sap.ui.unified.SplitContainer} Reference to this
in order to allow method chaining
*/
public setOrientation(sOrientation: sap.ui.core.Orientation): sap.ui.unified.SplitContainer;
/**
* Sets a new value for property {@link #getSecondaryContentSize secondaryContentSize}.
*
* The width if the secondary content. The height is always 100%.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 250px
.
* @param {sap.ui.core.CSSSize} sSecondaryContentSize - New value for property secondaryContentSize
* @returns {sap.ui.unified.SplitContainer} Reference to this
in order to allow method chaining
*/
public setSecondaryContentSize(sSecondaryContentSize: sap.ui.core.CSSSize): sap.ui.unified.SplitContainer;
/**
* Sets a new value for property {@link #getSecondaryContentWidth secondaryContentWidth}.
*
* Do not use. Use secondaryContentSize instead.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 250px
.
* @param {sap.ui.core.CSSSize} sSecondaryContentWidth - New value for property secondaryContentWidth
* @returns {sap.ui.unified.SplitContainer} Reference to this
in order to allow method chaining
*/
public setSecondaryContentWidth(sSecondaryContentWidth: sap.ui.core.CSSSize): sap.ui.unified.SplitContainer;
/**
* Sets a new value for property {@link #getShowSecondaryContent showSecondaryContent}.
*
* Shows / Hides the secondary area.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bShowSecondaryContent - New value for property showSecondaryContent
* @returns {sap.ui.unified.SplitContainer} Reference to this
in order to allow method chaining
*/
public setShowSecondaryContent(bShowSecondaryContent: boolean): sap.ui.unified.SplitContainer;
}
}
/**
* Controls that implement the SAP User Experience (UX) Guidelines 3.0
*/
namespace ux3 {
/**
* Experimental implementation of visual Ux3 Shell personalization / branding.
*
* DO NOT USE PRODUCTIVELY!!!
*
*
* Being completely non-generic as of now, this is supposed to facilitate discussions with Ux
* about the personalization capabilities. Once that concept is more final, we can go for a cleaner implementation,
* considering the number of configurable properties etc.
*/
var ShellPersonalization: any;
/**
* A special toolbar with predefined social actions which can be shown as needed. These are: Create an update (Feed), Follow, Mark for Follow Up, Mark as Favorite and Open Thing.
*
* In addition business actions (ThingAction instances) can be added which are either displayed as MenuItems of the 'More' menu button or as individual tool bar buttons.
*
* When using this control, please be aware that it fulfills rather specific requirements: it has been designed for and is used within composite controls QuickView and ThingInspector.
*/
export class ActionBar extends sap.ui.core.Control {
/**
* Constructor for a new ActionBar.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:actionSelected actionSelected} event of this sap.ui.ux3.ActionBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ActionBar
itself.
*
* Fired when any of the social action’s toolbar buttons except ‘Update’ or any of the business action’s menu items resp. buttons is pressed. The selected action can be identified by its id and newState (the latter if applicable only)
* ‘Follow’ button + menu: id: follow, newState: Follow/Hold/Default
* ‘Mark for follow up’ button: id: flag, newState: true/false
* ‘Favorite’ button: id: favorite, newState: true/false
* ‘Open Thing Inspector’ button id: open
* Business Actions: id: the ThingAction id
*
* For ‘Update’, please refer to event ‘feedSubmit’
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ActionBar
itself
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public attachActionSelected(fnFunction: Function, oListener?: any): sap.ui.ux3.ActionBar;
/**
* Attaches event handler fnFunction
to the {@link #event:actionSelected actionSelected} event of this sap.ui.ux3.ActionBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ActionBar
itself.
*
* Fired when any of the social action’s toolbar buttons except ‘Update’ or any of the business action’s menu items resp. buttons is pressed. The selected action can be identified by its id and newState (the latter if applicable only)
* ‘Follow’ button + menu: id: follow, newState: Follow/Hold/Default
* ‘Mark for follow up’ button: id: flag, newState: true/false
* ‘Favorite’ button: id: favorite, newState: true/false
* ‘Open Thing Inspector’ button id: open
* Business Actions: id: the ThingAction id
*
* For ‘Update’, please refer to event ‘feedSubmit’
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ActionBar
itself
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public attachActionSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ActionBar;
/**
* Attaches event handler fnFunction
to the {@link #event:feedSubmit feedSubmit} event of this sap.ui.ux3.ActionBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ActionBar
itself.
*
* Fired when a new feed entry is submitted.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ActionBar
itself
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public attachFeedSubmit(fnFunction: Function, oListener?: any): sap.ui.ux3.ActionBar;
/**
* Attaches event handler fnFunction
to the {@link #event:feedSubmit feedSubmit} event of this sap.ui.ux3.ActionBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ActionBar
itself.
*
* Fired when a new feed entry is submitted.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ActionBar
itself
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public attachFeedSubmit(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ActionBar;
/**
* Closes all popups which might be opened as ActionBar children
* These are the more- and follow menu and the feeder popup
*/
public closePopups(): void;
/**
* Detaches event handler fnFunction
from the {@link #event:actionSelected actionSelected} event of this sap.ui.ux3.ActionBar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public detachActionSelected(fnFunction: Function, oListener: any): sap.ui.ux3.ActionBar;
/**
* Detaches event handler fnFunction
from the {@link #event:feedSubmit feedSubmit} event of this sap.ui.ux3.ActionBar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public detachFeedSubmit(fnFunction: Function, oListener: any): sap.ui.ux3.ActionBar;
/**
* Creates a new subclass of class sap.ui.ux3.ActionBar with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:actionSelected actionSelected} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
protected fireActionSelected(mParameters?: any): sap.ui.ux3.ActionBar;
/**
* Fires event {@link #event:feedSubmit feedSubmit} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
protected fireFeedSubmit(mParameters?: any): sap.ui.ux3.ActionBar;
/**
* Gets current value of property {@link #getAlwaysShowMoreMenu alwaysShowMoreMenu}.
*
* If true, business actions are rendered as menu items of the 'More' menu button. Otherwise, 'More' menu button is only displayed for overflow and business actions are rendered as inidividual buttons.
*
* Default value is true
.
* @returns {boolean} Value of property alwaysShowMoreMenu
*/
public getAlwaysShowMoreMenu(): boolean;
/**
* Gets content of aggregation {@link #getBusinessActions businessActions}.
*
* Displayed on the actionBar's right hand-side, either as menu item under 'More' or as individual buttons
* @returns {sap.ui.ux3.ThingAction[]}
*/
public getBusinessActions(): sap.ui.ux3.ThingAction[];
/**
* Gets current value of property {@link #getDividerWidth dividerWidth}.
*
* The minimum width of ActionBar's the social actions part: business action controls have to be rendered outside this area
* @returns {sap.ui.core.CSSSize} Value of property dividerWidth
*/
public getDividerWidth(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getFavoriteState favoriteState}.
*
* Indicates whether “Favorite” is active
* @returns {boolean} Value of property favoriteState
*/
public getFavoriteState(): boolean;
/**
* Gets current value of property {@link #getFlagState flagState}.
*
* Indicates whether “Mark for Follow Up” is active
* @returns {boolean} Value of property flagState
*/
public getFlagState(): boolean;
/**
* Gets current value of property {@link #getFollowState followState}.
*
* Keeps track of the actionBars Follow/Unfollow button’s state. Its value is one of
* - FollowActionState.Default
* - FollowActionState.Follow
* - FollowActionState.Hold
*
* Default value is Default
.
* @returns {sap.ui.ux3.FollowActionState} Value of property followState
*/
public getFollowState(): sap.ui.ux3.FollowActionState;
/**
* Returns a metadata object for class sap.ui.ux3.ActionBar.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowFavorite showFavorite}.
*
* Indicates whether social action “Favorite” is shown, default is ‘true’
*
* Default value is true
.
* @returns {boolean} Value of property showFavorite
*/
public getShowFavorite(): boolean;
/**
* Gets current value of property {@link #getShowFlag showFlag}.
*
* Indicates whether social action “Mark for Follow Up” is shown, default is ‘true’
*
* Default value is true
.
* @returns {boolean} Value of property showFlag
*/
public getShowFlag(): boolean;
/**
* Gets current value of property {@link #getShowFollow showFollow}.
*
* Indicates whether social action “Follow” is shown, default is ‘true’
*
* Default value is true
.
* @returns {boolean} Value of property showFollow
*/
public getShowFollow(): boolean;
/**
* Gets current value of property {@link #getShowOpen showOpen}.
*
* Indicates whether social action “Open” is shown, default is ‘true’
*
* Default value is true
.
* @returns {boolean} Value of property showOpen
*/
public getShowOpen(): boolean;
/**
* Gets current value of property {@link #getShowUpdate showUpdate}.
*
* Indicates whether social action “Update” is shown, default is ‘true’
*
* Default value is true
.
* @returns {boolean} Value of property showUpdate
*/
public getShowUpdate(): boolean;
/**
* Gets current value of property {@link #getThingIconURI thingIconURI}.
*
* The thing icon uri. Icon will be displayed in Feeder
* @returns {sap.ui.core.URI} Value of property thingIconURI
*/
public getThingIconURI(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getUpdateState updateState}.
*
* Indicates whether “Update” is active
* @returns {boolean} Value of property updateState
*/
public getUpdateState(): boolean;
/**
* Checks for the provided sap.ui.ux3.ThingAction
in the aggregation {@link #getBusinessActions businessActions}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.ThingAction} oBusinessAction - The businessAction whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfBusinessAction(oBusinessAction: sap.ui.ux3.ThingAction): number;
/**
* Checks whether the control is still valid (is in the DOM). ActionBar
* instance is rendered if and only if 'isActive' returns 'true'. This
* check is called implicitely by the rendere, MUST not be removed.
* @returns {boolean} True if the control is still in the active DOM
*/
protected isActive(): boolean;
/**
* Sets a new value for property {@link #getAlwaysShowMoreMenu alwaysShowMoreMenu}.
*
* If true, business actions are rendered as menu items of the 'More' menu button. Otherwise, 'More' menu button is only displayed for overflow and business actions are rendered as inidividual buttons.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bAlwaysShowMoreMenu - New value for property alwaysShowMoreMenu
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public setAlwaysShowMoreMenu(bAlwaysShowMoreMenu: boolean): sap.ui.ux3.ActionBar;
/**
* Sets a new value for property {@link #getDividerWidth dividerWidth}.
*
* The minimum width of ActionBar's the social actions part: business action controls have to be rendered outside this area
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sDividerWidth - New value for property dividerWidth
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public setDividerWidth(sDividerWidth: sap.ui.core.CSSSize): sap.ui.ux3.ActionBar;
/**
* Sets a new value for property {@link #getFavoriteState favoriteState}.
*
* Indicates whether “Favorite” is active
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bFavoriteState - New value for property favoriteState
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public setFavoriteState(bFavoriteState: boolean): sap.ui.ux3.ActionBar;
/**
* Sets a new value for property {@link #getFlagState flagState}.
*
* Indicates whether “Mark for Follow Up” is active
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bFlagState - New value for property flagState
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public setFlagState(bFlagState: boolean): sap.ui.ux3.ActionBar;
/**
* Sets a new value for property {@link #getFollowState followState}.
*
* Keeps track of the actionBars Follow/Unfollow button’s state. Its value is one of
* - FollowActionState.Default
* - FollowActionState.Follow
* - FollowActionState.Hold
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Default
.
* @param {sap.ui.ux3.FollowActionState} sFollowState - New value for property followState
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public setFollowState(sFollowState: sap.ui.ux3.FollowActionState): sap.ui.ux3.ActionBar;
/**
* Sets a new value for property {@link #getShowFavorite showFavorite}.
*
* Indicates whether social action “Favorite” is shown, default is ‘true’
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowFavorite - New value for property showFavorite
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public setShowFavorite(bShowFavorite: boolean): sap.ui.ux3.ActionBar;
/**
* Sets a new value for property {@link #getShowFlag showFlag}.
*
* Indicates whether social action “Mark for Follow Up” is shown, default is ‘true’
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowFlag - New value for property showFlag
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public setShowFlag(bShowFlag: boolean): sap.ui.ux3.ActionBar;
/**
* Sets a new value for property {@link #getShowFollow showFollow}.
*
* Indicates whether social action “Follow” is shown, default is ‘true’
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowFollow - New value for property showFollow
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public setShowFollow(bShowFollow: boolean): sap.ui.ux3.ActionBar;
/**
* Sets a new value for property {@link #getShowOpen showOpen}.
*
* Indicates whether social action “Open” is shown, default is ‘true’
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowOpen - New value for property showOpen
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public setShowOpen(bShowOpen: boolean): sap.ui.ux3.ActionBar;
/**
* Sets a new value for property {@link #getShowUpdate showUpdate}.
*
* Indicates whether social action “Update” is shown, default is ‘true’
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowUpdate - New value for property showUpdate
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public setShowUpdate(bShowUpdate: boolean): sap.ui.ux3.ActionBar;
/**
* Sets a new value for property {@link #getThingIconURI thingIconURI}.
*
* The thing icon uri. Icon will be displayed in Feeder
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sThingIconURI - New value for property thingIconURI
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public setThingIconURI(sThingIconURI: sap.ui.core.URI): sap.ui.ux3.ActionBar;
/**
* Sets a new value for property {@link #getUpdateState updateState}.
*
* Indicates whether “Update” is active
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bUpdateState - New value for property updateState
* @returns {sap.ui.ux3.ActionBar} Reference to this
in order to allow method chaining
*/
public setUpdateState(bUpdateState: boolean): sap.ui.ux3.ActionBar;
}
/**
* Enumeration of available standard actions for 'sap.ui.ux3.ActionBar'. To be used as parameters for function 'sap.ui.ux3.ActionBar.getSocialAction'.
*/
export enum ActionBarSocialActions {
/**
* Standards action 'Mark as Favorite'
*/
Favorite = "Favorite",
/**
* Standard action 'Mark for Follow up'
*/
Flag = "Flag",
/**
* Standard action 'Follow/Unfollow'
*/
Follow = "Follow",
/**
* Standard action 'Open Thing Inspector'
*/
Open = "Open",
/**
* Standard action 'Create an update' (Feed)
*/
Update = "Update",
}
/**
* Collection
*/
export class Collection extends sap.ui.core.Element {
/**
* Constructor for a new Collection.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.ui.core.Item} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.Collection} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.ui.core.Item): sap.ui.ux3.Collection;
/**
* @param {string|sap.ui.core.Item} vSelectedItem - Id of a selectedItem which becomes an additional target of this selectedItems
association. Alternatively, a selectedItem instance may be given.
* @returns {sap.ui.ux3.Collection} this
to allow method chaining
*/
public addSelectedItem(vSelectedItem: string|sap.ui.core.Item): sap.ui.ux3.Collection;
/**
* Attaches event handler fnFunction
to the {@link #event:propertyChanged propertyChanged} event of this sap.ui.ux3.Collection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Collection
itself.
*
* Fires if a property has changed, and the collection inspector needs to do something after that
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Collection
itself
* @returns {sap.ui.ux3.Collection} Reference to this
in order to allow method chaining
*/
public attachPropertyChanged(fnFunction: Function, oListener?: any): sap.ui.ux3.Collection;
/**
* Attaches event handler fnFunction
to the {@link #event:propertyChanged propertyChanged} event of this sap.ui.ux3.Collection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Collection
itself.
*
* Fires if a property has changed, and the collection inspector needs to do something after that
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Collection
itself
* @returns {sap.ui.ux3.Collection} Reference to this
in order to allow method chaining
*/
public attachPropertyChanged(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Collection;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChanged selectionChanged} event of this sap.ui.ux3.Collection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Collection
itself.
*
* Fired when ever the selected items changer
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Collection
itself
* @returns {sap.ui.ux3.Collection} Reference to this
in order to allow method chaining
*/
public attachSelectionChanged(fnFunction: Function, oListener?: any): sap.ui.ux3.Collection;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChanged selectionChanged} event of this sap.ui.ux3.Collection
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Collection
itself.
*
* Fired when ever the selected items changer
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Collection
itself
* @returns {sap.ui.ux3.Collection} Reference to this
in order to allow method chaining
*/
public attachSelectionChanged(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Collection;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.ui.ux3.Collection} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.ui.ux3.Collection;
/**
* Detaches event handler fnFunction
from the {@link #event:propertyChanged propertyChanged} event of this sap.ui.ux3.Collection
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Collection} Reference to this
in order to allow method chaining
*/
public detachPropertyChanged(fnFunction: Function, oListener: any): sap.ui.ux3.Collection;
/**
* Detaches event handler fnFunction
from the {@link #event:selectionChanged selectionChanged} event of this sap.ui.ux3.Collection
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Collection} Reference to this
in order to allow method chaining
*/
public detachSelectionChanged(fnFunction: Function, oListener: any): sap.ui.ux3.Collection;
/**
* Creates a new subclass of class sap.ui.ux3.Collection with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:propertyChanged propertyChanged} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Collection} Reference to this
in order to allow method chaining
*/
protected firePropertyChanged(mParameters?: any): sap.ui.ux3.Collection;
/**
* Fires event {@link #event:selectionChanged selectionChanged} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Collection} Reference to this
in order to allow method chaining
*/
protected fireSelectionChanged(mParameters?: any): sap.ui.ux3.Collection;
/**
* Gets current value of property {@link #getEditable editable}.
*
* If a collection is editable an edit button will be displayed below the list of items
*
* Default value is false
.
* @returns {boolean} Value of property editable
*/
public getEditable(): boolean;
/**
* Gets content of aggregation {@link #getItems items}.
*
* Items in the collection
* @returns {sap.ui.core.Item[]}
*/
public getItems(): sap.ui.core.Item[];
/**
* Returns a metadata object for class sap.ui.ux3.Collection.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMultiSelection multiSelection}.
*
* Allow multi selection of items in collection
*
* Default value is false
.
* @returns {boolean} Value of property multiSelection
*/
public getMultiSelection(): boolean;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getSelectedItems selectedItems}.
* @returns {sap.ui.core.ID[]}
*/
public getSelectedItems(): sap.ui.core.ID[];
/**
* Gets current value of property {@link #getTitle title}.
*
* Name for the collection
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Checks for the provided sap.ui.core.Item
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Item} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.core.Item): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.ui.core.Item} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.ui.ux3.Collection} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.ui.core.Item, iIndex: number): sap.ui.ux3.Collection;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Item[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.ui.core.Item[];
/**
* @returns {string[]} an array with the ids of the removed elements (might be empty)
*/
public removeAllSelectedItems(): string[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.ui.core.Item} vItem - The item to remove or its index or id
* @returns {sap.ui.core.Item} The removed item or null
*/
public removeItem(vItem: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* @param {number|string|sap.ui.core.Item} vSelectedItem - the selectedItem to remove or its index or id
* @returns {string} the id of the removed selectedItem or null
*/
public removeSelectedItem(vSelectedItem: number|string|sap.ui.core.Item): string;
/**
* Sets a new value for property {@link #getEditable editable}.
*
* If a collection is editable an edit button will be displayed below the list of items
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEditable - New value for property editable
* @returns {sap.ui.ux3.Collection} Reference to this
in order to allow method chaining
*/
public setEditable(bEditable: boolean): sap.ui.ux3.Collection;
/**
* Sets a new value for property {@link #getMultiSelection multiSelection}.
*
* Allow multi selection of items in collection
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bMultiSelection - New value for property multiSelection
* @returns {sap.ui.ux3.Collection} Reference to this
in order to allow method chaining
*/
public setMultiSelection(bMultiSelection: boolean): sap.ui.ux3.Collection;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Name for the collection
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.ux3.Collection} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.ux3.Collection;
}
/**
* CollectionInspector
*/
export class CollectionInspector extends sap.ui.core.Control {
/**
* Constructor for a new CollectionInspector.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some collection oCollection
* to the aggregation named collections
.
* @param {sap.ui.ux3.Collection} oCollection - the collection to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.CollectionInspector} this
to allow method chaining
*/
public addCollection(oCollection: sap.ui.ux3.Collection): sap.ui.ux3.CollectionInspector;
/**
* Adds some content oContent
* to the aggregation named content
.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.CollectionInspector} this
to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.ux3.CollectionInspector;
/**
* Attaches event handler fnFunction
to the {@link #event:collectionSelected collectionSelected} event of this sap.ui.ux3.CollectionInspector
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.CollectionInspector
itself.
*
* Event is fired if user selects a collection
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.CollectionInspector
itself
* @returns {sap.ui.ux3.CollectionInspector} Reference to this
in order to allow method chaining
*/
public attachCollectionSelected(fnFunction: Function, oListener?: any): sap.ui.ux3.CollectionInspector;
/**
* Attaches event handler fnFunction
to the {@link #event:collectionSelected collectionSelected} event of this sap.ui.ux3.CollectionInspector
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.CollectionInspector
itself.
*
* Event is fired if user selects a collection
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.CollectionInspector
itself
* @returns {sap.ui.ux3.CollectionInspector} Reference to this
in order to allow method chaining
*/
public attachCollectionSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.CollectionInspector;
/**
* Attaches event handler fnFunction
to the {@link #event:editCollection editCollection} event of this sap.ui.ux3.CollectionInspector
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.CollectionInspector
itself.
*
* Fires when the edit button is clicked
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.CollectionInspector
itself
* @returns {sap.ui.ux3.CollectionInspector} Reference to this
in order to allow method chaining
*/
public attachEditCollection(fnFunction: Function, oListener?: any): sap.ui.ux3.CollectionInspector;
/**
* Attaches event handler fnFunction
to the {@link #event:editCollection editCollection} event of this sap.ui.ux3.CollectionInspector
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.CollectionInspector
itself.
*
* Fires when the edit button is clicked
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.CollectionInspector
itself
* @returns {sap.ui.ux3.CollectionInspector} Reference to this
in order to allow method chaining
*/
public attachEditCollection(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.CollectionInspector;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelectionChanged itemSelectionChanged} event of this sap.ui.ux3.CollectionInspector
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.CollectionInspector
itself.
*
* Fires when an item in a collection is selected
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.CollectionInspector
itself
* @returns {sap.ui.ux3.CollectionInspector} Reference to this
in order to allow method chaining
*/
public attachItemSelectionChanged(fnFunction: Function, oListener?: any): sap.ui.ux3.CollectionInspector;
/**
* Attaches event handler fnFunction
to the {@link #event:itemSelectionChanged itemSelectionChanged} event of this sap.ui.ux3.CollectionInspector
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.CollectionInspector
itself.
*
* Fires when an item in a collection is selected
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.CollectionInspector
itself
* @returns {sap.ui.ux3.CollectionInspector} Reference to this
in order to allow method chaining
*/
public attachItemSelectionChanged(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.CollectionInspector;
/**
* Closes the siedebar
*/
public closeSidebar(): void;
/**
* Destroys the collection aggregation
* @returns {sap.ui.ux3.CollectionInspector} this to allow method chaining
*/
public destroyCollections(): sap.ui.ux3.CollectionInspector;
/**
* Destroys all the content in the aggregation
* named content
.
* @returns {sap.ui.ux3.CollectionInspector} this
to allow method chaining
*/
public destroyContent(): sap.ui.ux3.CollectionInspector;
/**
* Detaches event handler fnFunction
from the {@link #event:collectionSelected collectionSelected} event of this sap.ui.ux3.CollectionInspector
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.CollectionInspector} Reference to this
in order to allow method chaining
*/
public detachCollectionSelected(fnFunction: Function, oListener: any): sap.ui.ux3.CollectionInspector;
/**
* Detaches event handler fnFunction
from the {@link #event:editCollection editCollection} event of this sap.ui.ux3.CollectionInspector
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.CollectionInspector} Reference to this
in order to allow method chaining
*/
public detachEditCollection(fnFunction: Function, oListener: any): sap.ui.ux3.CollectionInspector;
/**
* Detaches event handler fnFunction
from the {@link #event:itemSelectionChanged itemSelectionChanged} event of this sap.ui.ux3.CollectionInspector
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.CollectionInspector} Reference to this
in order to allow method chaining
*/
public detachItemSelectionChanged(fnFunction: Function, oListener: any): sap.ui.ux3.CollectionInspector;
/**
* Creates a new subclass of class sap.ui.ux3.CollectionInspector with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:collectionSelected collectionSelected} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.CollectionInspector} Reference to this
in order to allow method chaining
*/
protected fireCollectionSelected(mParameters?: any): sap.ui.ux3.CollectionInspector;
/**
* Fires event {@link #event:editCollection editCollection} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.CollectionInspector} Reference to this
in order to allow method chaining
*/
protected fireEditCollection(mParameters?: any): sap.ui.ux3.CollectionInspector;
/**
* Fires event {@link #event:itemSelectionChanged itemSelectionChanged} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.CollectionInspector} Reference to this
in order to allow method chaining
*/
protected fireItemSelectionChanged(mParameters?: any): sap.ui.ux3.CollectionInspector;
/**
* Gets content of aggregation {@link #getCollections collections}.
*
* Collections which are displayed in the COllectionInspector
* @returns {sap.ui.ux3.Collection[]}
*/
public getCollections(): sap.ui.ux3.Collection[];
/**
* Gets content of aggregation {@link #getContent content}.
*
* All controls that are currently displayed
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Return the edit button
* @returns {any}
*/
public getEditButton(): any;
/**
* Gets current value of property {@link #getFitParent fitParent}.
*
* If set to true, control will fit parents content area
*
* Default value is true
.
* @returns {boolean} Value of property fitParent
*/
public getFitParent(): boolean;
/**
* Returns a metadata object for class sap.ui.ux3.CollectionInspector.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* ID of the element which is the current target of the association {@link #getSelectedCollection selectedCollection}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedCollection(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getSidebarVisible sidebarVisible}.
*
* Defines if the list of collection items is visible on the left
*
* Default value is true
.
* @returns {boolean} Value of property sidebarVisible
*/
public getSidebarVisible(): boolean;
/**
* Checks for the provided sap.ui.ux3.Collection
in the aggregation {@link #getCollections collections}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.Collection} oCollection - The collection whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfCollection(oCollection: sap.ui.ux3.Collection): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a collection into the aggregation named collections
.
* @param {sap.ui.ux3.Collection} oCollection - the collection to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the collection should be inserted at; for a negative value of iIndex
, the collection is inserted at position 0; for a value greater than the current size of the aggregation, the collection is inserted at the last position
* @returns {sap.ui.ux3.CollectionInspector} this
to allow method chaining
*/
public insertCollection(oCollection: sap.ui.ux3.Collection, iIndex: number): sap.ui.ux3.CollectionInspector;
/**
* Inserts a content into the aggregation named content
.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.ux3.CollectionInspector} this
to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.ux3.CollectionInspector;
/**
* Opens the sidebar
*/
public openSidebar(): void;
/**
* Removes all the controls in the aggregation named collections
.
* Additionally unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.Collection[]} an array of the removed elements (might be empty)
*/
public removeAllCollections(): sap.ui.ux3.Collection[];
/**
* Removes all the controls in the aggregation named content
.
* Additionally unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} an array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a collection from the aggregation named collections
.
* @param {number|string|sap.ui.ux3.Collection} vCollection - the collection to remove or its index or id
* @returns {sap.ui.ux3.Collection} the removed collection or null
*/
public removeCollection(vCollection: number|string|sap.ui.ux3.Collection): sap.ui.ux3.Collection;
/**
* Removes a content from the aggregation named content
.
* @param {number|string|sap.ui.core.Control} vContent - the content to remove or its index or id
* @returns {sap.ui.core.Control} the removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getFitParent fitParent}.
*
* If set to true, control will fit parents content area
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bFitParent - New value for property fitParent
* @returns {sap.ui.ux3.CollectionInspector} Reference to this
in order to allow method chaining
*/
public setFitParent(bFitParent: boolean): sap.ui.ux3.CollectionInspector;
/**
* Sets the associated {@link #getSelectedCollection selectedCollection}.
* @param {sap.ui.core.ID|sap.ui.ux3.Collection} oSelectedCollection - ID of an element which becomes the new target of this selectedCollection association; alternatively, an element instance may be given
* @returns {sap.ui.ux3.CollectionInspector} Reference to this
in order to allow method chaining
*/
public setSelectedCollection(oSelectedCollection: sap.ui.core.ID|sap.ui.ux3.Collection): sap.ui.ux3.CollectionInspector;
/**
* Sets a new value for property {@link #getSidebarVisible sidebarVisible}.
*
* Defines if the list of collection items is visible on the left
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bSidebarVisible - New value for property sidebarVisible
* @returns {sap.ui.ux3.CollectionInspector} Reference to this
in order to allow method chaining
*/
public setSidebarVisible(bSidebarVisible: boolean): sap.ui.ux3.CollectionInspector;
}
/**
* DataSet
*/
export class DataSet extends sap.ui.core.Control {
/**
* Constructor for a new DataSet.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Rerendering of the FilterArea
*/
protected _rerenderFilter(): void;
/**
* Rerendering of the Toolbar
*/
protected _rerenderToolbar(): void;
/**
* Adds some filter to the aggregation {@link #getFilter filter}.
* @param {sap.ui.core.Control} oFilter - the filter to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public addFilter(oFilter: sap.ui.core.Control): sap.ui.ux3.DataSet;
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.ui.ux3.DataSetItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.ui.ux3.DataSetItem): sap.ui.ux3.DataSet;
/**
* add a toolbarItem to the toolbar
* @param {sap.ui.commons.ToolbarItem} oOToolbarItem - ToolbarItem
*/
public addToolbarItem(oOToolbarItem: sap.ui.commons.ToolbarItem): void;
/**
* Adds some view to the aggregation {@link #getViews views}.
* @param {sap.ui.ux3.DataSetView} oView - the view to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public addView(oView: sap.ui.ux3.DataSetView): sap.ui.ux3.DataSet;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.ui.ux3.DataSet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.DataSet
itself.
*
* Event which is fired when the user triggers a search
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.DataSet
itself
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public attachSearch(fnFunction: Function, oListener?: any): sap.ui.ux3.DataSet;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.ui.ux3.DataSet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.DataSet
itself.
*
* Event which is fired when the user triggers a search
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.DataSet
itself
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public attachSearch(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.DataSet;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChanged selectionChanged} event of this sap.ui.ux3.DataSet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.DataSet
itself.
*
* selection Changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.DataSet
itself
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public attachSelectionChanged(fnFunction: Function, oListener?: any): sap.ui.ux3.DataSet;
/**
* Attaches event handler fnFunction
to the {@link #event:selectionChanged selectionChanged} event of this sap.ui.ux3.DataSet
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.DataSet
itself.
*
* selection Changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.DataSet
itself
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public attachSelectionChanged(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.DataSet;
/**
* Binds aggregation {@link #getItems items} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public bindItems(oBindingInfo: any): sap.ui.ux3.DataSet;
/**
* clears dataset from all previous selections
*/
public clearSelection(): void;
/**
* Creates a view switch button
* @param {any} oView - View
* @param {number} iIndex - Index of view
* @returns {any} viewSwitch instance
*/
protected createViewSwitch(oView: any, iIndex: number): any;
/**
* Destroys all the filter in the aggregation {@link #getFilter filter}.
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public destroyFilter(): sap.ui.ux3.DataSet;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.ui.ux3.DataSet;
/**
* Destroys all the views in the aggregation {@link #getViews views}.
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public destroyViews(): sap.ui.ux3.DataSet;
/**
* Detaches event handler fnFunction
from the {@link #event:search search} event of this sap.ui.ux3.DataSet
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public detachSearch(fnFunction: Function, oListener: any): sap.ui.ux3.DataSet;
/**
* Detaches event handler fnFunction
from the {@link #event:selectionChanged selectionChanged} event of this sap.ui.ux3.DataSet
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public detachSelectionChanged(fnFunction: Function, oListener: any): sap.ui.ux3.DataSet;
/**
* Creates a new subclass of class sap.ui.ux3.DataSet with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:search search} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
protected fireSearch(mParameters?: any): sap.ui.ux3.DataSet;
/**
* Fires event {@link #event:selectionChanged selectionChanged} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
protected fireSelectionChanged(mParameters?: any): sap.ui.ux3.DataSet;
/**
* Gets content of aggregation {@link #getFilter filter}.
*
* Filter control (e.g. a FacetFilter) for the DataSet
* @returns {sap.ui.core.Control[]}
*/
public getFilter(): sap.ui.core.Control[];
/**
* Gets content of aggregation {@link #getItems items}.
*
* Aggregation of DataSetItems
* @returns {sap.ui.ux3.DataSetItem[]}
*/
public getItems(): sap.ui.ux3.DataSetItem[];
/**
* Returns the LeadSelection index
* @param {string} sItemId - Id of the selected DataSetItem
* @returns {number} selected index
*/
protected getLeadSelection(sItemId: string): number;
/**
* Returns a metadata object for class sap.ui.ux3.DataSet.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMultiSelect multiSelect}.
*
* Selection mode of the DataSet
*
* Default value is false
.
* @returns {boolean} Value of property multiSelect
*/
public getMultiSelect(): boolean;
/**
* use this function to retrieve the lead selected index
* @returns {any}
*/
public getSelectedIndex(): any;
/**
* use this function to retrieve all selected indices if multiple select is enabled
* @returns {any}
*/
public getSelectedIndices(): any;
/**
* Returns id of selected Item from given index
* @param {number} iIndex - index of selection
* @returns {string} id of selected item
*/
protected getSelectedItemId(iIndex: number): string;
/**
* ID of the element which is the current target of the association {@link #getSelectedView selectedView}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedView(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getShowFilter showFilter}.
*
* show filter
*
* Default value is true
.
* @returns {boolean} Value of property showFilter
*/
public getShowFilter(): boolean;
/**
* Gets current value of property {@link #getShowSearchField showSearchField}.
*
* Show/hide SearchField in Toolbar
*
* Default value is true
.
* @returns {boolean} Value of property showSearchField
*/
public getShowSearchField(): boolean;
/**
* Gets current value of property {@link #getShowToolbar showToolbar}.
*
* show Toolbar
*
* Default value is true
.
* @returns {boolean} Value of property showToolbar
*/
public getShowToolbar(): boolean;
/**
* Gets content of aggregation {@link #getViews views}.
*
* views
* @returns {sap.ui.ux3.DataSetView[]}
*/
public getViews(): sap.ui.ux3.DataSetView[];
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getFilter filter}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oFilter - The filter whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfFilter(oFilter: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.ux3.DataSetItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.DataSetItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.ux3.DataSetItem): number;
/**
* Checks for the provided sap.ui.ux3.DataSetView
in the aggregation {@link #getViews views}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.DataSetView} oView - The view whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfView(oView: sap.ui.ux3.DataSetView): number;
/**
* Inserts a filter into the aggregation {@link #getFilter filter}.
* @param {sap.ui.core.Control} oFilter - the filter to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the filter should be inserted at; for a negative value of iIndex
, the filter is inserted at position 0; for a value greater than the current size of the aggregation, the filter is inserted at the last position
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public insertFilter(oFilter: sap.ui.core.Control, iIndex: number): sap.ui.ux3.DataSet;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.ui.ux3.DataSetItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.ui.ux3.DataSetItem, iIndex: number): sap.ui.ux3.DataSet;
/**
* Inserts a view into the aggregation {@link #getViews views}.
* @param {sap.ui.ux3.DataSetView} oView - the view to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the view should be inserted at; for a negative value of iIndex
, the view is inserted at position 0; for a value greater than the current size of the aggregation, the view is inserted at the last position
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public insertView(oView: sap.ui.ux3.DataSetView, iIndex: number): sap.ui.ux3.DataSet;
/**
* Returns true if iIndex is selected
* @param {number} iIndex - index of selection
* @returns {boolean} index selected true/false
*/
protected isSelectedIndex(iIndex: number): boolean;
/**
* Removes all the controls from the aggregation {@link #getFilter filter}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllFilter(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.DataSetItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.ui.ux3.DataSetItem[];
/**
* Removes all the controls from the aggregation {@link #getViews views}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.DataSetView[]} An array of the removed elements (might be empty)
*/
public removeAllViews(): sap.ui.ux3.DataSetView[];
/**
* Removes a filter from the aggregation {@link #getFilter filter}.
* @param {number|string|sap.ui.core.Control} vFilter - The filter to remove or its index or id
* @returns {sap.ui.core.Control} The removed filter or null
*/
public removeFilter(vFilter: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.ui.ux3.DataSetItem} vItem - The item to remove or its index or id
* @returns {sap.ui.ux3.DataSetItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.ui.ux3.DataSetItem): sap.ui.ux3.DataSetItem;
/**
* remove a toolbarItem to the toolbar
* @param {sap.ui.commons.ToolbarItem} oOToolbarItem
*/
public removeToolbarItem(oOToolbarItem: sap.ui.commons.ToolbarItem): void;
/**
* Removes a view from the aggregation {@link #getViews views}.
* @param {number|string|sap.ui.ux3.DataSetView} vView - The view to remove or its index or id
* @returns {sap.ui.ux3.DataSetView} The removed view or null
*/
public removeView(vView: number|string|sap.ui.ux3.DataSetView): sap.ui.ux3.DataSetView;
/**
* Set the LeadSelection index
* @param {number} iIIndex - set LeadSelection index
*/
protected setLeadSelection(iIIndex: number): void;
/**
* setter for multi selection mode
* @param {boolean} bMode - true for multi mode, false for single mode
*/
public setMultiSelect(bMode: boolean): void;
/**
* Sets the associated {@link #getSelectedView selectedView}.
* @param {sap.ui.core.ID|sap.ui.ux3.DataSetView} oSelectedView - ID of an element which becomes the new target of this selectedView association; alternatively, an element instance may be given
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public setSelectedView(oSelectedView: sap.ui.core.ID|sap.ui.ux3.DataSetView): sap.ui.ux3.DataSet;
/**
* Sets a new value for property {@link #getShowFilter showFilter}.
*
* show filter
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowFilter - New value for property showFilter
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public setShowFilter(bShowFilter: boolean): sap.ui.ux3.DataSet;
/**
* Sets a new value for property {@link #getShowSearchField showSearchField}.
*
* Show/hide SearchField in Toolbar
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowSearchField - New value for property showSearchField
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public setShowSearchField(bShowSearchField: boolean): sap.ui.ux3.DataSet;
/**
* Sets a new value for property {@link #getShowToolbar showToolbar}.
*
* show Toolbar
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowToolbar - New value for property showToolbar
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public setShowToolbar(bShowToolbar: boolean): sap.ui.ux3.DataSet;
/**
* Unbinds aggregation {@link #getItems items} from model data.
* @returns {sap.ui.ux3.DataSet} Reference to this
in order to allow method chaining
*/
public unbindItems(): sap.ui.ux3.DataSet;
}
/**
* DataSet Item
*/
export class DataSetItem extends sap.ui.core.Element {
/**
* Constructor for a new DataSetItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:selected selected} event of this sap.ui.ux3.DataSetItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.DataSetItem
itself.
*
* Event Fired when Datset item is selected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.DataSetItem
itself
* @returns {sap.ui.ux3.DataSetItem} Reference to this
in order to allow method chaining
*/
public attachSelected(fnFunction: Function, oListener?: any): sap.ui.ux3.DataSetItem;
/**
* Attaches event handler fnFunction
to the {@link #event:selected selected} event of this sap.ui.ux3.DataSetItem
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.DataSetItem
itself.
*
* Event Fired when Datset item is selected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.DataSetItem
itself
* @returns {sap.ui.ux3.DataSetItem} Reference to this
in order to allow method chaining
*/
public attachSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.DataSetItem;
/**
* Detaches event handler fnFunction
from the {@link #event:selected selected} event of this sap.ui.ux3.DataSetItem
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.DataSetItem} Reference to this
in order to allow method chaining
*/
public detachSelected(fnFunction: Function, oListener: any): sap.ui.ux3.DataSetItem;
/**
* Creates a new subclass of class sap.ui.ux3.DataSetItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:selected selected} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.DataSetItem} Reference to this
in order to allow method chaining
*/
protected fireSelected(mParameters?: any): sap.ui.ux3.DataSetItem;
/**
* Gets current value of property {@link #getCheckable checkable}.
*
* checkable
*
* Default value is true
.
* @returns {boolean} Value of property checkable
*/
public getCheckable(): boolean;
/**
* Gets current value of property {@link #getIconSrc iconSrc}.
*
* image
* @returns {sap.ui.core.URI} Value of property iconSrc
*/
public getIconSrc(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.ui.ux3.DataSetItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSubtitle subtitle}.
*
* subtitle
*
* Default value is Subtitle
.
* @returns {string} Value of property subtitle
*/
public getSubtitle(): string;
/**
* Gets current value of property {@link #getTitle title}.
*
* title
*
* Default value is Title
.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Sets a new value for property {@link #getCheckable checkable}.
*
* checkable
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bCheckable - New value for property checkable
* @returns {sap.ui.ux3.DataSetItem} Reference to this
in order to allow method chaining
*/
public setCheckable(bCheckable: boolean): sap.ui.ux3.DataSetItem;
/**
* Sets a new value for property {@link #getIconSrc iconSrc}.
*
* image
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIconSrc - New value for property iconSrc
* @returns {sap.ui.ux3.DataSetItem} Reference to this
in order to allow method chaining
*/
public setIconSrc(sIconSrc: sap.ui.core.URI): sap.ui.ux3.DataSetItem;
/**
* Sets a new value for property {@link #getSubtitle subtitle}.
*
* subtitle
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Subtitle
.
* @param {string} sSubtitle - New value for property subtitle
* @returns {sap.ui.ux3.DataSetItem} Reference to this
in order to allow method chaining
*/
public setSubtitle(sSubtitle: string): sap.ui.ux3.DataSetItem;
/**
* Sets a new value for property {@link #getTitle title}.
*
* title
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Title
.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.ux3.DataSetItem} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.ux3.DataSetItem;
}
/**
* DataSetSimpleView provides a simple view example for DataSet usage.
*/
export class DataSetSimpleView extends sap.ui.core.Control {
/**
* Constructor for a new DataSetSimpleView.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Destroys the template in the aggregation {@link #getTemplate template}.
* @returns {sap.ui.ux3.DataSetSimpleView} Reference to this
in order to allow method chaining
*/
public destroyTemplate(): sap.ui.ux3.DataSetSimpleView;
/**
* View finalization: Called when leaving the view
* @param {sap.ui.ux3.DataSetItem[]} aItems
*/
protected exitView(aItems: sap.ui.ux3.DataSetItem[]): void;
/**
* Creates a new subclass of class sap.ui.ux3.DataSetSimpleView with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getFloating floating}.
*
* When true the DatSet items are floating containers. When set to false The Items are rendered in a 1 column Layout.
*
* Default value is true
.
* @returns {boolean} Value of property floating
*/
public getFloating(): boolean;
/**
* Gets current value of property {@link #getHeight height}.
*
* If the pagination feature is used without specifying a scroll area, a height for the dataset must be defined.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Icon source for this view
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconHovered iconHovered}.
*
* icon: hovered state
* @returns {sap.ui.core.URI} Value of property iconHovered
*/
public getIconHovered(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconSelected iconSelected}.
*
* icon: selected state
* @returns {sap.ui.core.URI} Value of property iconSelected
*/
public getIconSelected(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getInitialItemCount initialItemCount}.
*
* If this value is greater zero only this amount of items is loaded in the first place. New items are loaded automatically when the user scrolls down. The number of items which are reloaded can be defined with the property "reloadItemCount"
*
* Default value is 0
.
* @returns {number} Value of property initialItemCount
*/
public getInitialItemCount(): number;
/**
* Gets current value of property {@link #getItemMinWidth itemMinWidth}.
*
* When itemMinWidth>0 and the property floating is true the given minimum width in pixels is set to DatSet items. A minimum width must be given when the property responsive is set.
*
* Default value is 0
.
* @returns {number} Value of property itemMinWidth
*/
public getItemMinWidth(): number;
/**
* Returns a metadata object for class sap.ui.ux3.DataSetSimpleView.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getName name}.
*
* Name of the View
*
* Default value is Name of this View
.
* @returns {string} Value of property name
*/
public getName(): string;
/**
* Gets current value of property {@link #getReloadItemCount reloadItemCount}.
*
* This number defines the item count which is reloaded on scroll if initialItemCount is enabled.
*
* Default value is 0
.
* @returns {number} Value of property reloadItemCount
*/
public getReloadItemCount(): number;
/**
* Gets current value of property {@link #getResponsive responsive}.
*
* When true and the property floating is true the DatSet items are floating containers filling the whole space of a row.
*
* Default value is false
.
* @returns {boolean} Value of property responsive
*/
public getResponsive(): boolean;
/**
* Gets current value of property {@link #getScrollArea scrollArea}.
*
* ID of the DOM Element or jQuery reference to the dom which holds the scrollbar for the dataset
* @returns {any} Value of property scrollArea
*/
public getScrollArea(): any;
/**
* Gets content of aggregation {@link #getTemplate template}.
*
* template
* @returns {sap.ui.core.Control}
*/
public getTemplate(): sap.ui.core.Control;
/**
* Eventhandler for the selection of an Item
* @param {sap.ui.base.Event} oEvent - SelectionChanged event
*/
protected handleSelection(oEvent: sap.ui.base.Event): void;
/**
* View Initialization: Called when selecting the view
* @param {any[]} aItems - Array of DataSetItems added to the parent DataSet
*/
protected initView(aItems: any[]): void;
/**
* Check if Item oItem
is selected
* @param {sap.ui.ux3.DataSetItem} oItem - DataSetItem instance
*/
protected isItemSelected(oItem: sap.ui.ux3.DataSetItem): void;
/**
* Sets a new value for property {@link #getFloating floating}.
*
* When true the DatSet items are floating containers. When set to false The Items are rendered in a 1 column Layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bFloating - New value for property floating
* @returns {sap.ui.ux3.DataSetSimpleView} Reference to this
in order to allow method chaining
*/
public setFloating(bFloating: boolean): sap.ui.ux3.DataSetSimpleView;
/**
* Sets a new value for property {@link #getHeight height}.
*
* If the pagination feature is used without specifying a scroll area, a height for the dataset must be defined.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.ux3.DataSetSimpleView} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.ux3.DataSetSimpleView;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Icon source for this view
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.ux3.DataSetSimpleView} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.ux3.DataSetSimpleView;
/**
* Sets a new value for property {@link #getIconHovered iconHovered}.
*
* icon: hovered state
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIconHovered - New value for property iconHovered
* @returns {sap.ui.ux3.DataSetSimpleView} Reference to this
in order to allow method chaining
*/
public setIconHovered(sIconHovered: sap.ui.core.URI): sap.ui.ux3.DataSetSimpleView;
/**
* Sets a new value for property {@link #getIconSelected iconSelected}.
*
* icon: selected state
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIconSelected - New value for property iconSelected
* @returns {sap.ui.ux3.DataSetSimpleView} Reference to this
in order to allow method chaining
*/
public setIconSelected(sIconSelected: sap.ui.core.URI): sap.ui.ux3.DataSetSimpleView;
/**
* Sets a new value for property {@link #getInitialItemCount initialItemCount}.
*
* If this value is greater zero only this amount of items is loaded in the first place. New items are loaded automatically when the user scrolls down. The number of items which are reloaded can be defined with the property "reloadItemCount"
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iInitialItemCount - New value for property initialItemCount
* @returns {sap.ui.ux3.DataSetSimpleView} Reference to this
in order to allow method chaining
*/
public setInitialItemCount(iInitialItemCount: number): sap.ui.ux3.DataSetSimpleView;
/**
* Sets a new value for property {@link #getItemMinWidth itemMinWidth}.
*
* When itemMinWidth>0 and the property floating is true the given minimum width in pixels is set to DatSet items. A minimum width must be given when the property responsive is set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iItemMinWidth - New value for property itemMinWidth
* @returns {sap.ui.ux3.DataSetSimpleView} Reference to this
in order to allow method chaining
*/
public setItemMinWidth(iItemMinWidth: number): sap.ui.ux3.DataSetSimpleView;
/**
* Sets a new value for property {@link #getName name}.
*
* Name of the View
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Name of this View
.
* @param {string} sName - New value for property name
* @returns {sap.ui.ux3.DataSetSimpleView} Reference to this
in order to allow method chaining
*/
public setName(sName: string): sap.ui.ux3.DataSetSimpleView;
/**
* Sets a new value for property {@link #getReloadItemCount reloadItemCount}.
*
* This number defines the item count which is reloaded on scroll if initialItemCount is enabled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 0
.
* @param {number} iReloadItemCount - New value for property reloadItemCount
* @returns {sap.ui.ux3.DataSetSimpleView} Reference to this
in order to allow method chaining
*/
public setReloadItemCount(iReloadItemCount: number): sap.ui.ux3.DataSetSimpleView;
/**
* Sets a new value for property {@link #getResponsive responsive}.
*
* When true and the property floating is true the DatSet items are floating containers filling the whole space of a row.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bResponsive - New value for property responsive
* @returns {sap.ui.ux3.DataSetSimpleView} Reference to this
in order to allow method chaining
*/
public setResponsive(bResponsive: boolean): sap.ui.ux3.DataSetSimpleView;
/**
* @param {any[]} aScrollArea
* @param {boolean} bSupress
*/
public setScrollArea(aScrollArea: any[], bSupress: boolean): void;
/**
* Sets the aggregated {@link #getTemplate template}.
* @param {sap.ui.core.Control} oTemplate - The template to set
* @returns {sap.ui.ux3.DataSetSimpleView} Reference to this
in order to allow method chaining
*/
public setTemplate(oTemplate: sap.ui.core.Control): sap.ui.ux3.DataSetSimpleView;
/**
* View update: Called when pagination adds items
* @param {sap.ui.ux3.DataSetItem[]} aDiff - Array of DataSetItems added to the parent DataSet
*/
protected updateView(aDiff: sap.ui.ux3.DataSetItem[]): void;
}
/**
* Marker interface for controls which are suitable as view rendering for a DataSet.
*/
export interface DataSetView {
}
/**
* A comprehensive UI design approach with graphical and functional elements for searching data, exploring data, and acting on the data
* ("Explore and Act (Exact) Pattern").
*/
export class Exact extends sap.ui.core.Control {
/**
* Constructor for a new Exact.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some attribute to the aggregation {@link #getAttributes attributes}.
* @param {sap.ui.ux3.ExactAttribute} oAttribute - the attribute to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.Exact} Reference to this
in order to allow method chaining
*/
public addAttribute(oAttribute: sap.ui.ux3.ExactAttribute): sap.ui.ux3.Exact;
/**
* Attaches event handler fnFunction
to the {@link #event:refineSearch refineSearch} event of this sap.ui.ux3.Exact
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Exact
itself.
*
* Event which is fired when an attribute is selected or unselected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Exact
itself
* @returns {sap.ui.ux3.Exact} Reference to this
in order to allow method chaining
*/
public attachRefineSearch(fnFunction: Function, oListener?: any): sap.ui.ux3.Exact;
/**
* Attaches event handler fnFunction
to the {@link #event:refineSearch refineSearch} event of this sap.ui.ux3.Exact
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Exact
itself.
*
* Event which is fired when an attribute is selected or unselected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Exact
itself
* @returns {sap.ui.ux3.Exact} Reference to this
in order to allow method chaining
*/
public attachRefineSearch(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Exact;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.ui.ux3.Exact
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Exact
itself.
*
* Event is fired when the search button is clicked
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Exact
itself
* @returns {sap.ui.ux3.Exact} Reference to this
in order to allow method chaining
*/
public attachSearch(fnFunction: Function, oListener?: any): sap.ui.ux3.Exact;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.ui.ux3.Exact
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Exact
itself.
*
* Event is fired when the search button is clicked
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Exact
itself
* @returns {sap.ui.ux3.Exact} Reference to this
in order to allow method chaining
*/
public attachSearch(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Exact;
/**
* Destroys all the attributes in the aggregation {@link #getAttributes attributes}.
* @returns {sap.ui.ux3.Exact} Reference to this
in order to allow method chaining
*/
public destroyAttributes(): sap.ui.ux3.Exact;
/**
* Destroys the settingsMenu in the aggregation {@link #getSettingsMenu settingsMenu}.
* @returns {sap.ui.ux3.Exact} Reference to this
in order to allow method chaining
*/
public destroySettingsMenu(): sap.ui.ux3.Exact;
/**
* Detaches event handler fnFunction
from the {@link #event:refineSearch refineSearch} event of this sap.ui.ux3.Exact
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Exact} Reference to this
in order to allow method chaining
*/
public detachRefineSearch(fnFunction: Function, oListener: any): sap.ui.ux3.Exact;
/**
* Detaches event handler fnFunction
from the {@link #event:search search} event of this sap.ui.ux3.Exact
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Exact} Reference to this
in order to allow method chaining
*/
public detachSearch(fnFunction: Function, oListener: any): sap.ui.ux3.Exact;
/**
* Creates a new subclass of class sap.ui.ux3.Exact with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:refineSearch refineSearch} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Exact} Reference to this
in order to allow method chaining
*/
protected fireRefineSearch(mParameters?: any): sap.ui.ux3.Exact;
/**
* Fires event {@link #event:search search} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Exact} Reference to this
in order to allow method chaining
*/
protected fireSearch(mParameters?: any): sap.ui.ux3.Exact;
/**
* Gets content of aggregation {@link #getAttributes attributes}.
*
* The attributes which shall be available to refine the search
* @returns {sap.ui.ux3.ExactAttribute[]}
*/
public getAttributes(): sap.ui.ux3.ExactAttribute[];
/**
* Returns a metadata object for class sap.ui.ux3.Exact.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns the ExactArea representing the result section. Arbitrary content can be added here.
* @returns {sap.ui.ux3.ExactArea}
*/
public getResultArea(): sap.ui.ux3.ExactArea;
/**
* Gets current value of property {@link #getResultText resultText}.
*
* A title text which is displayed above the result section
* @returns {string} Value of property resultText
*/
public getResultText(): string;
/**
* Returns the SearchField control which is used by the Exact control.
* @returns {sap.ui.commons.SearchField}
*/
public getSearchField(): sap.ui.commons.SearchField;
/**
* Gets content of aggregation {@link #getSettingsMenu settingsMenu}.
*
* Defines the 'Settings' button in the browse section tool bar
* @returns {sap.ui.commons.Menu}
*/
public getSettingsMenu(): sap.ui.commons.Menu;
/**
* Checks for the provided sap.ui.ux3.ExactAttribute
in the aggregation {@link #getAttributes attributes}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.ExactAttribute} oAttribute - The attribute whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAttribute(oAttribute: sap.ui.ux3.ExactAttribute): number;
/**
* Inserts a attribute into the aggregation {@link #getAttributes attributes}.
* @param {sap.ui.ux3.ExactAttribute} oAttribute - the attribute to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the attribute should be inserted at; for a negative value of iIndex
, the attribute is inserted at position 0; for a value greater than the current size of the aggregation, the attribute is inserted at the last position
* @returns {sap.ui.ux3.Exact} Reference to this
in order to allow method chaining
*/
public insertAttribute(oAttribute: sap.ui.ux3.ExactAttribute, iIndex: number): sap.ui.ux3.Exact;
/**
* Removes all the controls from the aggregation {@link #getAttributes attributes}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.ExactAttribute[]} An array of the removed elements (might be empty)
*/
public removeAllAttributes(): sap.ui.ux3.ExactAttribute[];
/**
* Removes a attribute from the aggregation {@link #getAttributes attributes}.
* @param {number|string|sap.ui.ux3.ExactAttribute} vAttribute - The attribute to remove or its index or id
* @returns {sap.ui.ux3.ExactAttribute} The removed attribute or null
*/
public removeAttribute(vAttribute: number|string|sap.ui.ux3.ExactAttribute): sap.ui.ux3.ExactAttribute;
/**
* Sets a new value for property {@link #getResultText resultText}.
*
* A title text which is displayed above the result section
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sResultText - New value for property resultText
* @returns {sap.ui.ux3.Exact} Reference to this
in order to allow method chaining
*/
public setResultText(sResultText: string): sap.ui.ux3.Exact;
/**
* Sets the aggregated {@link #getSettingsMenu settingsMenu}.
* @param {sap.ui.commons.Menu} oSettingsMenu - The settingsMenu to set
* @returns {sap.ui.ux3.Exact} Reference to this
in order to allow method chaining
*/
public setSettingsMenu(oSettingsMenu: sap.ui.commons.Menu): sap.ui.ux3.Exact;
}
/**
* Consists of two sections: A tool bar and a content area where arbitrary controls can be added.
* The ExactArea is intended to be used for the Exact design approach but alternatively also in a stand alone version.
*/
export class ExactArea extends sap.ui.core.Control {
/**
* Constructor for a new ExactArea.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.ExactArea} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.ux3.ExactArea;
/**
* Adds some toolbarItem to the aggregation {@link #getToolbarItems toolbarItems}.
* @param {sap.ui.commons.ToolbarItem} oToolbarItem - the toolbarItem to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.ExactArea} Reference to this
in order to allow method chaining
*/
public addToolbarItem(oToolbarItem: sap.ui.commons.ToolbarItem): sap.ui.ux3.ExactArea;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.ux3.ExactArea} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.ux3.ExactArea;
/**
* Destroys all the toolbarItems in the aggregation {@link #getToolbarItems toolbarItems}.
* @returns {sap.ui.ux3.ExactArea} Reference to this
in order to allow method chaining
*/
public destroyToolbarItems(): sap.ui.ux3.ExactArea;
/**
* Creates a new subclass of class sap.ui.ux3.ExactArea with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Arbitrary child controls of the content area
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.ui.ux3.ExactArea.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getToolbarItems toolbarItems}.
*
* Tool bar items which shall be shown in the tool bar.
* @returns {sap.ui.commons.ToolbarItem[]}
*/
public getToolbarItems(): sap.ui.commons.ToolbarItem[];
/**
* Gets current value of property {@link #getToolbarVisible toolbarVisible}.
*
* Specifies whether the tool bar shall be visible
*
* Default value is true
.
* @returns {boolean} Value of property toolbarVisible
*/
public getToolbarVisible(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.commons.ToolbarItem
in the aggregation {@link #getToolbarItems toolbarItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.ToolbarItem} oToolbarItem - The toolbarItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfToolbarItem(oToolbarItem: sap.ui.commons.ToolbarItem): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.ux3.ExactArea} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.ux3.ExactArea;
/**
* Inserts a toolbarItem into the aggregation {@link #getToolbarItems toolbarItems}.
* @param {sap.ui.commons.ToolbarItem} oToolbarItem - the toolbarItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the toolbarItem should be inserted at; for a negative value of iIndex
, the toolbarItem is inserted at position 0; for a value greater than the current size of the aggregation, the toolbarItem is inserted at the last position
* @returns {sap.ui.ux3.ExactArea} Reference to this
in order to allow method chaining
*/
public insertToolbarItem(oToolbarItem: sap.ui.commons.ToolbarItem, iIndex: number): sap.ui.ux3.ExactArea;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getToolbarItems toolbarItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.ToolbarItem[]} An array of the removed elements (might be empty)
*/
public removeAllToolbarItems(): sap.ui.commons.ToolbarItem[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a toolbarItem from the aggregation {@link #getToolbarItems toolbarItems}.
* @param {number|string|sap.ui.commons.ToolbarItem} vToolbarItem - The toolbarItem to remove or its index or id
* @returns {sap.ui.commons.ToolbarItem} The removed toolbarItem or null
*/
public removeToolbarItem(vToolbarItem: number|string|sap.ui.commons.ToolbarItem): sap.ui.commons.ToolbarItem;
/**
* Sets a new value for property {@link #getToolbarVisible toolbarVisible}.
*
* Specifies whether the tool bar shall be visible
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bToolbarVisible - New value for property toolbarVisible
* @returns {sap.ui.ux3.ExactArea} Reference to this
in order to allow method chaining
*/
public setToolbarVisible(bToolbarVisible: boolean): sap.ui.ux3.ExactArea;
}
/**
* An element for defining attributes and sub-attributes used within the Exact pattern.
*/
export class ExactAttribute extends sap.ui.core.Element {
/**
* Constructor for a new ExactAttribute.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some attribute to the aggregation {@link #getAttributes attributes}.
* @param {sap.ui.ux3.ExactAttribute} oAttribute - the attribute to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.ExactAttribute} Reference to this
in order to allow method chaining
*/
public addAttribute(oAttribute: sap.ui.ux3.ExactAttribute): sap.ui.ux3.ExactAttribute;
/**
* Attaches event handler fnFunction
to the {@link #event:supplyAttributes supplyAttributes} event of this sap.ui.ux3.ExactAttribute
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ExactAttribute
itself.
*
* A supply function is a handler which is attached to the supplyAttributes event. The event is fired when the corresponding ExactAttribute is selected, it was already selected when a handler is attached or function getAttributes() is called.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ExactAttribute
itself
* @returns {sap.ui.ux3.ExactAttribute} Reference to this
in order to allow method chaining
*/
public attachSupplyAttributes(fnFunction: Function, oListener?: any): sap.ui.ux3.ExactAttribute;
/**
* Attaches event handler fnFunction
to the {@link #event:supplyAttributes supplyAttributes} event of this sap.ui.ux3.ExactAttribute
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ExactAttribute
itself.
*
* A supply function is a handler which is attached to the supplyAttributes event. The event is fired when the corresponding ExactAttribute is selected, it was already selected when a handler is attached or function getAttributes() is called.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ExactAttribute
itself
* @returns {sap.ui.ux3.ExactAttribute} Reference to this
in order to allow method chaining
*/
public attachSupplyAttributes(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ExactAttribute;
/**
* Destroys all the attributes in the aggregation {@link #getAttributes attributes}.
* @returns {sap.ui.ux3.ExactAttribute} Reference to this
in order to allow method chaining
*/
public destroyAttributes(): sap.ui.ux3.ExactAttribute;
/**
* Detaches event handler fnFunction
from the {@link #event:supplyAttributes supplyAttributes} event of this sap.ui.ux3.ExactAttribute
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ExactAttribute} Reference to this
in order to allow method chaining
*/
public detachSupplyAttributes(fnFunction: Function, oListener: any): sap.ui.ux3.ExactAttribute;
/**
* Creates a new subclass of class sap.ui.ux3.ExactAttribute with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:supplyAttributes supplyAttributes} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.ExactAttribute} Reference to this
in order to allow method chaining
*/
protected fireSupplyAttributes(mParameters?: any): sap.ui.ux3.ExactAttribute;
/**
* Gets current value of property {@link #getAdditionalData additionalData}.
*
* An example for additional data are database keys
* @returns {any} Value of property additionalData
*/
public getAdditionalData(): any;
/**
* Gets content of aggregation {@link #getAttributes attributes}.
*
* Values (sub attributes) of this attribute
* @returns {sap.ui.ux3.ExactAttribute[]}
*/
public getAttributes(): sap.ui.ux3.ExactAttribute[];
/**
* Gets current value of property {@link #getAutoActivateSupply autoActivateSupply}.
*
* If you want the supply function to be called on every select, you can set the autoActivateSupply attribute to true. In this case, supplyActive is automatically
* set to true on every unselect.
*
* Default value is false
.
* @returns {boolean} Value of property autoActivateSupply
*/
public getAutoActivateSupply(): boolean;
/**
* Gets current value of property {@link #getListOrder listOrder}.
*
* The order how the sublists of this attribute should be displayed.
*
* Default value is Select
.
* @returns {sap.ui.ux3.ExactOrder} Value of property listOrder
*/
public getListOrder(): sap.ui.ux3.ExactOrder;
/**
* Returns a metadata object for class sap.ui.ux3.ExactAttribute.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSelected selected}.
*
* Specifies whether the attribute shall be selected
* @returns {boolean} Value of property selected
*/
public getSelected(): boolean;
/**
* Gets current value of property {@link #getShowSubAttributesIndicator showSubAttributesIndicator}.
*
* Specifies whether the attribute shall have sub values for visual purposes.
* The indicator which is a little arrow beside an attribute in the list is computed automatically
* (getShowSubAttributesIndicator_Computed() of sap.ui.ux3.ExactAttribute).
* In the case that a supply function is attached, and the supplyActive attribute has value 'true',
* then the Exact pattern needs a hint if sub attributes are available. The showSubAttributesIndicator attribute is
* considered then and has to be maintained. If the back-end does not support count-calls, for example,
* showSubAttributesIndicator should be set to true.
*
* Default value is true
.
* @returns {boolean} Value of property showSubAttributesIndicator
*/
public getShowSubAttributesIndicator(): boolean;
/**
* See attribute showSubAttributesIndicator
* @returns {any}
*/
public getShowSubAttributesIndicator_Computed(): any;
/**
* Gets current value of property {@link #getSupplyActive supplyActive}.
*
* The supplyAttributes event is only fired if supplyActive has value true which is the default. After firing the event, the attribute is automatically set to false.
* The idea is that a supply function is called only once when the data is requested. To enable the event again it is possible to manually set the attribute back to true.
*
* Default value is true
.
* @returns {boolean} Value of property supplyActive
*/
public getSupplyActive(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* The attribute name
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Specifies the width of the corresponding list in pixels. The value must be between 70 and 500.
*
* Default value is 168
.
* @returns {number} Value of property width
*/
public getWidth(): number;
/**
* Checks for the provided sap.ui.ux3.ExactAttribute
in the aggregation {@link #getAttributes attributes}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.ExactAttribute} oAttribute - The attribute whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAttribute(oAttribute: sap.ui.ux3.ExactAttribute): number;
/**
* Inserts a attribute into the aggregation {@link #getAttributes attributes}.
* @param {sap.ui.ux3.ExactAttribute} oAttribute - the attribute to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the attribute should be inserted at; for a negative value of iIndex
, the attribute is inserted at position 0; for a value greater than the current size of the aggregation, the attribute is inserted at the last position
* @returns {sap.ui.ux3.ExactAttribute} Reference to this
in order to allow method chaining
*/
public insertAttribute(oAttribute: sap.ui.ux3.ExactAttribute, iIndex: number): sap.ui.ux3.ExactAttribute;
/**
* Removes all the controls from the aggregation {@link #getAttributes attributes}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.ExactAttribute[]} An array of the removed elements (might be empty)
*/
public removeAllAttributes(): sap.ui.ux3.ExactAttribute[];
/**
* Removes a attribute from the aggregation {@link #getAttributes attributes}.
* @param {number|string|sap.ui.ux3.ExactAttribute} vAttribute - The attribute to remove or its index or id
* @returns {sap.ui.ux3.ExactAttribute} The removed attribute or null
*/
public removeAttribute(vAttribute: number|string|sap.ui.ux3.ExactAttribute): sap.ui.ux3.ExactAttribute;
/**
* Scrolls the corresponding list of this attribute until the given direct child attribute is visible. If the corresponding list is not yet visible the call is buffered until the list is available.
* @param {sap.ui.ux3.ExactAttribute} oOAttribute - The direct child attribute
*/
public scrollTo(oOAttribute: sap.ui.ux3.ExactAttribute): void;
/**
* Sets a new value for property {@link #getAdditionalData additionalData}.
*
* An example for additional data are database keys
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {any} oAdditionalData - New value for property additionalData
* @returns {sap.ui.ux3.ExactAttribute} Reference to this
in order to allow method chaining
*/
public setAdditionalData(oAdditionalData: any): sap.ui.ux3.ExactAttribute;
/**
* Sets a new value for property {@link #getAutoActivateSupply autoActivateSupply}.
*
* If you want the supply function to be called on every select, you can set the autoActivateSupply attribute to true. In this case, supplyActive is automatically
* set to true on every unselect.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bAutoActivateSupply - New value for property autoActivateSupply
* @returns {sap.ui.ux3.ExactAttribute} Reference to this
in order to allow method chaining
*/
public setAutoActivateSupply(bAutoActivateSupply: boolean): sap.ui.ux3.ExactAttribute;
/**
* Sets a new value for property {@link #getListOrder listOrder}.
*
* The order how the sublists of this attribute should be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Select
.
* @param {sap.ui.ux3.ExactOrder} sListOrder - New value for property listOrder
* @returns {sap.ui.ux3.ExactAttribute} Reference to this
in order to allow method chaining
*/
public setListOrder(sListOrder: sap.ui.ux3.ExactOrder): sap.ui.ux3.ExactAttribute;
/**
* @param {string} sPropertyName
* @param {any} oValue
* @param {boolean} bSuppressRerendering
* @returns {sap.ui.base.ManagedObject}
*/
protected setProperty(sPropertyName: string, oValue: any, bSuppressRerendering: boolean): sap.ui.base.ManagedObject;
/**
* Sets a new value for property {@link #getSelected selected}.
*
* Specifies whether the attribute shall be selected
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bSelected - New value for property selected
* @returns {sap.ui.ux3.ExactAttribute} Reference to this
in order to allow method chaining
*/
public setSelected(bSelected: boolean): sap.ui.ux3.ExactAttribute;
/**
* Sets a new value for property {@link #getShowSubAttributesIndicator showSubAttributesIndicator}.
*
* Specifies whether the attribute shall have sub values for visual purposes.
* The indicator which is a little arrow beside an attribute in the list is computed automatically
* (getShowSubAttributesIndicator_Computed() of sap.ui.ux3.ExactAttribute).
* In the case that a supply function is attached, and the supplyActive attribute has value 'true',
* then the Exact pattern needs a hint if sub attributes are available. The showSubAttributesIndicator attribute is
* considered then and has to be maintained. If the back-end does not support count-calls, for example,
* showSubAttributesIndicator should be set to true.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowSubAttributesIndicator - New value for property showSubAttributesIndicator
* @returns {sap.ui.ux3.ExactAttribute} Reference to this
in order to allow method chaining
*/
public setShowSubAttributesIndicator(bShowSubAttributesIndicator: boolean): sap.ui.ux3.ExactAttribute;
/**
* Sets a new value for property {@link #getSupplyActive supplyActive}.
*
* The supplyAttributes event is only fired if supplyActive has value true which is the default. After firing the event, the attribute is automatically set to false.
* The idea is that a supply function is called only once when the data is requested. To enable the event again it is possible to manually set the attribute back to true.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bSupplyActive - New value for property supplyActive
* @returns {sap.ui.ux3.ExactAttribute} Reference to this
in order to allow method chaining
*/
public setSupplyActive(bSupplyActive: boolean): sap.ui.ux3.ExactAttribute;
/**
* Sets a new value for property {@link #getText text}.
*
* The attribute name
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.ux3.ExactAttribute} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.ux3.ExactAttribute;
/**
* @param {string|sap.ui.core.TooltipBase} oTooltip
*/
public setTooltip(oTooltip: string|sap.ui.core.TooltipBase): void;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Specifies the width of the corresponding list in pixels. The value must be between 70 and 500.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 168
.
* @param {number} iWidth - New value for property width
* @returns {sap.ui.ux3.ExactAttribute} Reference to this
in order to allow method chaining
*/
public setWidth(iWidth: number): sap.ui.ux3.ExactAttribute;
}
/**
* Attribute browse area used within the Exact pattern. The main benefit of this control is the high flexibility when large data amounts shall be displayed
* in the form of structured data sets with a high or low interdependency level. From lists - which can be nested according to the defined attributes - the user can choose
* entries and thereby trigger the display of further information, depending on the chosen entry/entries (multiple selection supported).
*/
export class ExactBrowser extends sap.ui.core.Control {
/**
* Constructor for a new ExactBrowser.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some attribute to the aggregation {@link #getAttributes attributes}.
* @param {sap.ui.ux3.ExactAttribute} oAttribute - the attribute to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public addAttribute(oAttribute: sap.ui.ux3.ExactAttribute): sap.ui.ux3.ExactBrowser;
/**
* Attaches event handler fnFunction
to the {@link #event:attributeSelected attributeSelected} event of this sap.ui.ux3.ExactBrowser
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ExactBrowser
itself.
*
* Event is fired when an attribute is selected or unselected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ExactBrowser
itself
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public attachAttributeSelected(fnFunction: Function, oListener?: any): sap.ui.ux3.ExactBrowser;
/**
* Attaches event handler fnFunction
to the {@link #event:attributeSelected attributeSelected} event of this sap.ui.ux3.ExactBrowser
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ExactBrowser
itself.
*
* Event is fired when an attribute is selected or unselected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ExactBrowser
itself
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public attachAttributeSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ExactBrowser;
/**
* Attaches event handler fnFunction
to the {@link #event:save save} event of this sap.ui.ux3.ExactBrowser
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ExactBrowser
itself.
*
* Event is fired when an attribute is selected or unselected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ExactBrowser
itself
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public attachSave(fnFunction: Function, oListener?: any): sap.ui.ux3.ExactBrowser;
/**
* Attaches event handler fnFunction
to the {@link #event:save save} event of this sap.ui.ux3.ExactBrowser
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ExactBrowser
itself.
*
* Event is fired when an attribute is selected or unselected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ExactBrowser
itself
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public attachSave(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ExactBrowser;
/**
* Destroys all the attributes in the aggregation {@link #getAttributes attributes}.
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public destroyAttributes(): sap.ui.ux3.ExactBrowser;
/**
* Destroys the optionsMenu in the aggregation {@link #getOptionsMenu optionsMenu}.
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public destroyOptionsMenu(): sap.ui.ux3.ExactBrowser;
/**
* Detaches event handler fnFunction
from the {@link #event:attributeSelected attributeSelected} event of this sap.ui.ux3.ExactBrowser
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public detachAttributeSelected(fnFunction: Function, oListener: any): sap.ui.ux3.ExactBrowser;
/**
* Detaches event handler fnFunction
from the {@link #event:save save} event of this sap.ui.ux3.ExactBrowser
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public detachSave(fnFunction: Function, oListener: any): sap.ui.ux3.ExactBrowser;
/**
* Creates a new subclass of class sap.ui.ux3.ExactBrowser with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:attributeSelected attributeSelected} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
protected fireAttributeSelected(mParameters?: any): sap.ui.ux3.ExactBrowser;
/**
* Fires event {@link #event:save save} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
protected fireSave(mParameters?: any): sap.ui.ux3.ExactBrowser;
/**
* Gets content of aggregation {@link #getAttributes attributes}.
*
* The attributes which shall be available.
* @returns {sap.ui.ux3.ExactAttribute[]}
*/
public getAttributes(): sap.ui.ux3.ExactAttribute[];
/**
* Gets current value of property {@link #getEnableListClose enableListClose}.
*
* Enables the close icons of the displayed lists.
*
* Default value is false
.
* @returns {boolean} Value of property enableListClose
*/
public getEnableListClose(): boolean;
/**
* Gets current value of property {@link #getEnableReset enableReset}.
*
* Whether the reset functionality should be available in the header area.
*
* Default value is true
.
* @returns {boolean} Value of property enableReset
*/
public getEnableReset(): boolean;
/**
* Gets current value of property {@link #getEnableSave enableSave}.
*
* Whether the save button should be available in the header area.
*
* Default value is false
.
* @returns {boolean} Value of property enableSave
*/
public getEnableSave(): boolean;
/**
* ID of the element which is the current target of the association {@link #getFollowUpControl followUpControl}, or null
.
* @returns {sap.ui.core.ID}
*/
public getFollowUpControl(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getHeaderTitle headerTitle}.
*
* Title text in the header of the Exact Browser.
* @returns {string} Value of property headerTitle
*/
public getHeaderTitle(): string;
/**
* Gets current value of property {@link #getListHeight listHeight}.
*
* The height of the list area in px.
*
* Default value is 290
.
* @returns {number} Value of property listHeight
*/
public getListHeight(): number;
/**
* Returns a metadata object for class sap.ui.ux3.ExactBrowser.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getOptionsMenu optionsMenu}.
*
* Menu with options. The menu can not used when the property showTopList is set to false.
* @returns {sap.ui.commons.Menu}
*/
public getOptionsMenu(): sap.ui.commons.Menu;
/**
* Gets current value of property {@link #getShowHeader showHeader}.
*
* Whether the header area of the ExactBrowser should be shown.
*
* Default value is false
.
* @returns {boolean} Value of property showHeader
*/
public getShowHeader(): boolean;
/**
* Gets current value of property {@link #getShowTopList showTopList}.
*
* Whether the top list of the ExactBrowser should be shown. When the property is set to false the
* application must ensure to select top level attributes appropriately.
*
* Default value is true
.
* @returns {boolean} Value of property showTopList
*/
public getShowTopList(): boolean;
/**
* Gets current value of property {@link #getTitle title}.
*
* Title text in the list area of the Exact Browser. The title is not shown when the property showTopList is set to false.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getTopListOrder topListOrder}.
*
* The order how the sublists of the top level list should be displayed.
*
* Default value is Select
.
* @returns {sap.ui.ux3.ExactOrder} Value of property topListOrder
*/
public getTopListOrder(): sap.ui.ux3.ExactOrder;
/**
* Gets current value of property {@link #getTopListWidth topListWidth}.
*
* Specifies the width of the top list in pixels. The value must be between 70 and 500.
*
* Default value is 168
.
* @returns {number} Value of property topListWidth
*/
public getTopListWidth(): number;
/**
* Checks for the provided sap.ui.ux3.ExactAttribute
in the aggregation {@link #getAttributes attributes}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.ExactAttribute} oAttribute - The attribute whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAttribute(oAttribute: sap.ui.ux3.ExactAttribute): number;
/**
* Inserts a attribute into the aggregation {@link #getAttributes attributes}.
* @param {sap.ui.ux3.ExactAttribute} oAttribute - the attribute to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the attribute should be inserted at; for a negative value of iIndex
, the attribute is inserted at position 0; for a value greater than the current size of the aggregation, the attribute is inserted at the last position
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public insertAttribute(oAttribute: sap.ui.ux3.ExactAttribute, iIndex: number): sap.ui.ux3.ExactBrowser;
/**
* Removes all the controls from the aggregation {@link #getAttributes attributes}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.ExactAttribute[]} An array of the removed elements (might be empty)
*/
public removeAllAttributes(): sap.ui.ux3.ExactAttribute[];
/**
* Removes a attribute from the aggregation {@link #getAttributes attributes}.
* @param {number|string|sap.ui.ux3.ExactAttribute} vAttribute - The attribute to remove or its index or id
* @returns {sap.ui.ux3.ExactAttribute} The removed attribute or null
*/
public removeAttribute(vAttribute: number|string|sap.ui.ux3.ExactAttribute): sap.ui.ux3.ExactAttribute;
/**
* Deselects all currently selected attributes and closes all attribute lists.
*/
public reset(): void;
/**
* Sets a new value for property {@link #getEnableListClose enableListClose}.
*
* Enables the close icons of the displayed lists.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableListClose - New value for property enableListClose
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public setEnableListClose(bEnableListClose: boolean): sap.ui.ux3.ExactBrowser;
/**
* Sets a new value for property {@link #getEnableReset enableReset}.
*
* Whether the reset functionality should be available in the header area.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableReset - New value for property enableReset
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public setEnableReset(bEnableReset: boolean): sap.ui.ux3.ExactBrowser;
/**
* Sets a new value for property {@link #getEnableSave enableSave}.
*
* Whether the save button should be available in the header area.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableSave - New value for property enableSave
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public setEnableSave(bEnableSave: boolean): sap.ui.ux3.ExactBrowser;
/**
* Sets the associated {@link #getFollowUpControl followUpControl}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oFollowUpControl - ID of an element which becomes the new target of this followUpControl association; alternatively, an element instance may be given
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public setFollowUpControl(oFollowUpControl: sap.ui.core.ID|sap.ui.core.Control): sap.ui.ux3.ExactBrowser;
/**
* Sets a new value for property {@link #getHeaderTitle headerTitle}.
*
* Title text in the header of the Exact Browser.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sHeaderTitle - New value for property headerTitle
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public setHeaderTitle(sHeaderTitle: string): sap.ui.ux3.ExactBrowser;
/**
* Sets a new value for property {@link #getListHeight listHeight}.
*
* The height of the list area in px.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 290
.
* @param {number} iListHeight - New value for property listHeight
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public setListHeight(iListHeight: number): sap.ui.ux3.ExactBrowser;
/**
* Sets the aggregated {@link #getOptionsMenu optionsMenu}.
* @param {sap.ui.commons.Menu} oOptionsMenu - The optionsMenu to set
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public setOptionsMenu(oOptionsMenu: sap.ui.commons.Menu): sap.ui.ux3.ExactBrowser;
/**
* Sets a new value for property {@link #getShowHeader showHeader}.
*
* Whether the header area of the ExactBrowser should be shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowHeader - New value for property showHeader
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public setShowHeader(bShowHeader: boolean): sap.ui.ux3.ExactBrowser;
/**
* Sets a new value for property {@link #getShowTopList showTopList}.
*
* Whether the top list of the ExactBrowser should be shown. When the property is set to false the
* application must ensure to select top level attributes appropriately.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowTopList - New value for property showTopList
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public setShowTopList(bShowTopList: boolean): sap.ui.ux3.ExactBrowser;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Title text in the list area of the Exact Browser. The title is not shown when the property showTopList is set to false.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.ux3.ExactBrowser;
/**
* Sets a new value for property {@link #getTopListOrder topListOrder}.
*
* The order how the sublists of the top level list should be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Select
.
* @param {sap.ui.ux3.ExactOrder} sTopListOrder - New value for property topListOrder
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public setTopListOrder(sTopListOrder: sap.ui.ux3.ExactOrder): sap.ui.ux3.ExactBrowser;
/**
* Sets a new value for property {@link #getTopListWidth topListWidth}.
*
* Specifies the width of the top list in pixels. The value must be between 70 and 500.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 168
.
* @param {number} iTopListWidth - New value for property topListWidth
* @returns {sap.ui.ux3.ExactBrowser} Reference to this
in order to allow method chaining
*/
public setTopListWidth(iTopListWidth: number): sap.ui.ux3.ExactBrowser;
}
/**
* Defines the order of the sub lists of a list in the ExactBrowser.
*/
export enum ExactOrder {
/**
* The order of the sub lists is defined by order of the defined sub attributes.
*/
Fixed = "Fixed",
/**
* The order of the sub lists is defined by the selection order of the user.
*/
Select = "Select",
}
/**
* FacetFilter Control.
*/
export class FacetFilter extends sap.ui.core.Control {
/**
* Constructor for a new FacetFilter.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some list to the aggregation {@link #getLists lists}.
* @param {sap.ui.ux3.FacetFilterList} oList - the list to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.FacetFilter} Reference to this
in order to allow method chaining
*/
public addList(oList: sap.ui.ux3.FacetFilterList): sap.ui.ux3.FacetFilter;
/**
* Destroys all the lists in the aggregation {@link #getLists lists}.
* @returns {sap.ui.ux3.FacetFilter} Reference to this
in order to allow method chaining
*/
public destroyLists(): sap.ui.ux3.FacetFilter;
/**
* Creates a new subclass of class sap.ui.ux3.FacetFilter with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getLists lists}.
*
* Facet Filter list represents the list of the filter values and the title of this list.
* @returns {sap.ui.ux3.FacetFilterList[]}
*/
public getLists(): sap.ui.ux3.FacetFilterList[];
/**
* Returns a metadata object for class sap.ui.ux3.FacetFilter.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getVisibleItemCountMode visibleItemCountMode}.
*
* If the value is "Auto" - the Facet Filter takes the whole available height. If "Fixed" , then the default number of Facet Filter Items (5) is visible.
*
* Default value is Fixed
.
* @returns {sap.ui.ux3.VisibleItemCountMode} Value of property visibleItemCountMode
*/
public getVisibleItemCountMode(): sap.ui.ux3.VisibleItemCountMode;
/**
* Checks for the provided sap.ui.ux3.FacetFilterList
in the aggregation {@link #getLists lists}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.FacetFilterList} oList - The list whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfList(oList: sap.ui.ux3.FacetFilterList): number;
/**
* Inserts a list into the aggregation {@link #getLists lists}.
* @param {sap.ui.ux3.FacetFilterList} oList - the list to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the list should be inserted at; for a negative value of iIndex
, the list is inserted at position 0; for a value greater than the current size of the aggregation, the list is inserted at the last position
* @returns {sap.ui.ux3.FacetFilter} Reference to this
in order to allow method chaining
*/
public insertList(oList: sap.ui.ux3.FacetFilterList, iIndex: number): sap.ui.ux3.FacetFilter;
/**
* Removes all the controls from the aggregation {@link #getLists lists}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.FacetFilterList[]} An array of the removed elements (might be empty)
*/
public removeAllLists(): sap.ui.ux3.FacetFilterList[];
/**
* Removes a list from the aggregation {@link #getLists lists}.
* @param {number|string|sap.ui.ux3.FacetFilterList} vList - The list to remove or its index or id
* @returns {sap.ui.ux3.FacetFilterList} The removed list or null
*/
public removeList(vList: number|string|sap.ui.ux3.FacetFilterList): sap.ui.ux3.FacetFilterList;
/**
* Sets a new value for property {@link #getVisibleItemCountMode visibleItemCountMode}.
*
* If the value is "Auto" - the Facet Filter takes the whole available height. If "Fixed" , then the default number of Facet Filter Items (5) is visible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Fixed
.
* @param {sap.ui.ux3.VisibleItemCountMode} sVisibleItemCountMode - New value for property visibleItemCountMode
* @returns {sap.ui.ux3.FacetFilter} Reference to this
in order to allow method chaining
*/
public setVisibleItemCountMode(sVisibleItemCountMode: sap.ui.ux3.VisibleItemCountMode): sap.ui.ux3.FacetFilter;
}
/**
* List to be used with the FacetFilter control. The control is not intended to be used stand alone.
*/
export class FacetFilterList extends sap.ui.core.Control {
/**
* Constructor for a new FacetFilterList.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.ui.core.ListItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.FacetFilterList} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.ui.core.ListItem): sap.ui.ux3.FacetFilterList;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.ux3.FacetFilterList
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FacetFilterList
itself.
*
* On Select event.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FacetFilterList
itself
* @returns {sap.ui.ux3.FacetFilterList} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.ux3.FacetFilterList;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.ux3.FacetFilterList
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FacetFilterList
itself.
*
* On Select event.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FacetFilterList
itself
* @returns {sap.ui.ux3.FacetFilterList} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.FacetFilterList;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.ui.ux3.FacetFilterList} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.ui.ux3.FacetFilterList;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.ux3.FacetFilterList
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.FacetFilterList} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.ux3.FacetFilterList;
/**
* Creates a new subclass of class sap.ui.ux3.FacetFilterList with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.FacetFilterList} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.ux3.FacetFilterList;
/**
* Gets current value of property {@link #getDisplaySecondaryValues displaySecondaryValues}.
*
* Specifies whether the text values from the additionalText property (see sap.ui.core.ListItems) shall be displayed.
*
* Default value is false
.
* @returns {boolean} Value of property displaySecondaryValues
*/
public getDisplaySecondaryValues(): boolean;
/**
* Gets content of aggregation {@link #getItems items}.
*
* The filter values that are presented as a list.
* @returns {sap.ui.core.ListItem[]}
*/
public getItems(): sap.ui.core.ListItem[];
/**
* Returns a metadata object for class sap.ui.ux3.FacetFilterList.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMultiSelect multiSelect}.
*
* Specifies whether multiple or single selection is used.
*
* Default value is true
.
* @returns {boolean} Value of property multiSelect
*/
public getMultiSelect(): boolean;
/**
* Gets current value of property {@link #getSelectedKeys selectedKeys}.
*
* Array of type string containing the selected keys.
* @returns {string[]} Value of property selectedKeys
*/
public getSelectedKeys(): string[];
/**
* Gets current value of property {@link #getShowCounter showCounter}.
*
* Specifies whether the counter for all entries is shown.
*
* Default value is true
.
* @returns {boolean} Value of property showCounter
*/
public getShowCounter(): boolean;
/**
* Gets current value of property {@link #getTitle title}.
*
* The title of this list.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Checks for the provided sap.ui.core.ListItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.ListItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.core.ListItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.ui.core.ListItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.ui.ux3.FacetFilterList} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.ui.core.ListItem, iIndex: number): sap.ui.ux3.FacetFilterList;
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.ListItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.ui.core.ListItem[];
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.ui.core.ListItem} vItem - The item to remove or its index or id
* @returns {sap.ui.core.ListItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.ui.core.ListItem): sap.ui.core.ListItem;
/**
* Sets a new value for property {@link #getDisplaySecondaryValues displaySecondaryValues}.
*
* Specifies whether the text values from the additionalText property (see sap.ui.core.ListItems) shall be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bDisplaySecondaryValues - New value for property displaySecondaryValues
* @returns {sap.ui.ux3.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setDisplaySecondaryValues(bDisplaySecondaryValues: boolean): sap.ui.ux3.FacetFilterList;
/**
* Sets a new value for property {@link #getMultiSelect multiSelect}.
*
* Specifies whether multiple or single selection is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bMultiSelect - New value for property multiSelect
* @returns {sap.ui.ux3.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setMultiSelect(bMultiSelect: boolean): sap.ui.ux3.FacetFilterList;
/**
* Sets a new value for property {@link #getSelectedKeys selectedKeys}.
*
* Array of type string containing the selected keys.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string[]} sSelectedKeys - New value for property selectedKeys
* @returns {sap.ui.ux3.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setSelectedKeys(sSelectedKeys: string[]): sap.ui.ux3.FacetFilterList;
/**
* Sets a new value for property {@link #getShowCounter showCounter}.
*
* Specifies whether the counter for all entries is shown.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowCounter - New value for property showCounter
* @returns {sap.ui.ux3.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setShowCounter(bShowCounter: boolean): sap.ui.ux3.FacetFilterList;
/**
* Sets a new value for property {@link #getTitle title}.
*
* The title of this list.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.ux3.FacetFilterList} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.ux3.FacetFilterList;
}
/**
* A container control representing a full feed page, including feeder and updates.
*/
export class Feed extends sap.ui.core.Control {
/**
* Constructor for a new Feed.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some chunk to the aggregation {@link #getChunks chunks}.
* @param {sap.ui.ux3.FeedChunk} oChunk - the chunk to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public addChunk(oChunk: sap.ui.ux3.FeedChunk): sap.ui.ux3.Feed;
/**
* Adds some filterItem to the aggregation {@link #getFilterItems filterItems}.
* @param {sap.ui.core.ListItem} oFilterItem - the filterItem to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public addFilterItem(oFilterItem: sap.ui.core.ListItem): sap.ui.ux3.Feed;
/**
* Adds some toolsMenuItem to the aggregation {@link #getToolsMenuItems toolsMenuItems}.
* @param {sap.ui.commons.MenuItem} oToolsMenuItem - the toolsMenuItem to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public addToolsMenuItem(oToolsMenuItem: sap.ui.commons.MenuItem): sap.ui.ux3.Feed;
/**
* Attaches event handler fnFunction
to the {@link #event:chunkAdded chunkAdded} event of this sap.ui.ux3.Feed
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Feed
itself.
*
* Event is fired when a new chunk is added
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Feed
itself
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public attachChunkAdded(fnFunction: Function, oListener?: any): sap.ui.ux3.Feed;
/**
* Attaches event handler fnFunction
to the {@link #event:chunkAdded chunkAdded} event of this sap.ui.ux3.Feed
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Feed
itself.
*
* Event is fired when a new chunk is added
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Feed
itself
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public attachChunkAdded(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Feed;
/**
* Attaches event handler fnFunction
to the {@link #event:filterChange filterChange} event of this sap.ui.ux3.Feed
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Feed
itself.
*
* Event is fired when the filter is changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Feed
itself
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public attachFilterChange(fnFunction: Function, oListener?: any): sap.ui.ux3.Feed;
/**
* Attaches event handler fnFunction
to the {@link #event:filterChange filterChange} event of this sap.ui.ux3.Feed
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Feed
itself.
*
* Event is fired when the filter is changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Feed
itself
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public attachFilterChange(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Feed;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.ui.ux3.Feed
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Feed
itself.
*
* Event is fired when the search function on SearchField is triggered
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Feed
itself
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public attachSearch(fnFunction: Function, oListener?: any): sap.ui.ux3.Feed;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.ui.ux3.Feed
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Feed
itself.
*
* Event is fired when the search function on SearchField is triggered
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Feed
itself
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public attachSearch(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Feed;
/**
* Attaches event handler fnFunction
to the {@link #event:toggleLive toggleLive} event of this sap.ui.ux3.Feed
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Feed
itself.
*
* Event is fired when the live mode has changed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Feed
itself
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public attachToggleLive(fnFunction: Function, oListener?: any): sap.ui.ux3.Feed;
/**
* Attaches event handler fnFunction
to the {@link #event:toggleLive toggleLive} event of this sap.ui.ux3.Feed
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Feed
itself.
*
* Event is fired when the live mode has changed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Feed
itself
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public attachToggleLive(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Feed;
/**
* Attaches event handler fnFunction
to the {@link #event:toolsItemSelected toolsItemSelected} event of this sap.ui.ux3.Feed
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Feed
itself.
*
* Event is fired when an item from the tools MenuButton was selected
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Feed
itself
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public attachToolsItemSelected(fnFunction: Function, oListener?: any): sap.ui.ux3.Feed;
/**
* Attaches event handler fnFunction
to the {@link #event:toolsItemSelected toolsItemSelected} event of this sap.ui.ux3.Feed
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Feed
itself.
*
* Event is fired when an item from the tools MenuButton was selected
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Feed
itself
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public attachToolsItemSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Feed;
/**
* Binds aggregation {@link #getChunks chunks} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public bindChunks(oBindingInfo: any): sap.ui.ux3.Feed;
/**
* Binds aggregation {@link #getFilterItems filterItems} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public bindFilterItems(oBindingInfo: any): sap.ui.ux3.Feed;
/**
* Binds aggregation {@link #getToolsMenuItems toolsMenuItems} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public bindToolsMenuItems(oBindingInfo: any): sap.ui.ux3.Feed;
/**
* Destroys all the chunks in the aggregation {@link #getChunks chunks}.
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public destroyChunks(): sap.ui.ux3.Feed;
/**
* Destroys all the filterItems in the aggregation {@link #getFilterItems filterItems}.
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public destroyFilterItems(): sap.ui.ux3.Feed;
/**
* Destroys all the toolsMenuItems in the aggregation {@link #getToolsMenuItems toolsMenuItems}.
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public destroyToolsMenuItems(): sap.ui.ux3.Feed;
/**
* Detaches event handler fnFunction
from the {@link #event:chunkAdded chunkAdded} event of this sap.ui.ux3.Feed
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public detachChunkAdded(fnFunction: Function, oListener: any): sap.ui.ux3.Feed;
/**
* Detaches event handler fnFunction
from the {@link #event:filterChange filterChange} event of this sap.ui.ux3.Feed
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public detachFilterChange(fnFunction: Function, oListener: any): sap.ui.ux3.Feed;
/**
* Detaches event handler fnFunction
from the {@link #event:search search} event of this sap.ui.ux3.Feed
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public detachSearch(fnFunction: Function, oListener: any): sap.ui.ux3.Feed;
/**
* Detaches event handler fnFunction
from the {@link #event:toggleLive toggleLive} event of this sap.ui.ux3.Feed
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public detachToggleLive(fnFunction: Function, oListener: any): sap.ui.ux3.Feed;
/**
* Detaches event handler fnFunction
from the {@link #event:toolsItemSelected toolsItemSelected} event of this sap.ui.ux3.Feed
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public detachToolsItemSelected(fnFunction: Function, oListener: any): sap.ui.ux3.Feed;
/**
* Creates a new subclass of class sap.ui.ux3.Feed with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:chunkAdded chunkAdded} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
protected fireChunkAdded(mParameters?: any): sap.ui.ux3.Feed;
/**
* Fires event {@link #event:filterChange filterChange} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
protected fireFilterChange(mParameters?: any): sap.ui.ux3.Feed;
/**
* Fires event {@link #event:search search} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
protected fireSearch(mParameters?: any): sap.ui.ux3.Feed;
/**
* Fires event {@link #event:toggleLive toggleLive} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
protected fireToggleLive(mParameters?: any): sap.ui.ux3.Feed;
/**
* Fires event {@link #event:toolsItemSelected toolsItemSelected} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
protected fireToolsItemSelected(mParameters?: any): sap.ui.ux3.Feed;
/**
* Gets content of aggregation {@link #getChunks chunks}.
*
* The chunks
* @returns {sap.ui.ux3.FeedChunk[]}
*/
public getChunks(): sap.ui.ux3.FeedChunk[];
/**
* Gets current value of property {@link #getFeederSender feederSender}.
*
* The sender of the feeder
* @returns {string} Value of property feederSender
*/
public getFeederSender(): string;
/**
* Gets current value of property {@link #getFeederThumbnailSrc feederThumbnailSrc}.
*
* The path to the thumbnail image used for the feeder
* @returns {sap.ui.core.URI} Value of property feederThumbnailSrc
*/
public getFeederThumbnailSrc(): sap.ui.core.URI;
/**
* Gets content of aggregation {@link #getFilterItems filterItems}.
*
* Items of the filter
* @returns {sap.ui.core.ListItem[]}
*/
public getFilterItems(): sap.ui.core.ListItem[];
/**
* Gets current value of property {@link #getLive live}.
*
* Specifies whether the feed shall be in live mode
*
* Default value is true
.
* @returns {boolean} Value of property live
*/
public getLive(): boolean;
/**
* Returns a metadata object for class sap.ui.ux3.Feed.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTitle title}.
*
* Title text of the Feed. If no text is entered "FEED" is displayed.
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets content of aggregation {@link #getToolsMenuItems toolsMenuItems}.
*
* MenuItems to open when the tool button is clicked by the user
* @returns {sap.ui.commons.MenuItem[]}
*/
public getToolsMenuItems(): sap.ui.commons.MenuItem[];
/**
* Checks for the provided sap.ui.ux3.FeedChunk
in the aggregation {@link #getChunks chunks}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.FeedChunk} oChunk - The chunk whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfChunk(oChunk: sap.ui.ux3.FeedChunk): number;
/**
* Checks for the provided sap.ui.core.ListItem
in the aggregation {@link #getFilterItems filterItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.ListItem} oFilterItem - The filterItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfFilterItem(oFilterItem: sap.ui.core.ListItem): number;
/**
* Checks for the provided sap.ui.commons.MenuItem
in the aggregation {@link #getToolsMenuItems toolsMenuItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.MenuItem} oToolsMenuItem - The toolsMenuItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfToolsMenuItem(oToolsMenuItem: sap.ui.commons.MenuItem): number;
/**
* Inserts a chunk into the aggregation {@link #getChunks chunks}.
* @param {sap.ui.ux3.FeedChunk} oChunk - the chunk to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the chunk should be inserted at; for a negative value of iIndex
, the chunk is inserted at position 0; for a value greater than the current size of the aggregation, the chunk is inserted at the last position
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public insertChunk(oChunk: sap.ui.ux3.FeedChunk, iIndex: number): sap.ui.ux3.Feed;
/**
* Inserts a filterItem into the aggregation {@link #getFilterItems filterItems}.
* @param {sap.ui.core.ListItem} oFilterItem - the filterItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the filterItem should be inserted at; for a negative value of iIndex
, the filterItem is inserted at position 0; for a value greater than the current size of the aggregation, the filterItem is inserted at the last position
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public insertFilterItem(oFilterItem: sap.ui.core.ListItem, iIndex: number): sap.ui.ux3.Feed;
/**
* Inserts a toolsMenuItem into the aggregation {@link #getToolsMenuItems toolsMenuItems}.
* @param {sap.ui.commons.MenuItem} oToolsMenuItem - the toolsMenuItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the toolsMenuItem should be inserted at; for a negative value of iIndex
, the toolsMenuItem is inserted at position 0; for a value greater than the current size of the aggregation, the toolsMenuItem is inserted at the last position
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public insertToolsMenuItem(oToolsMenuItem: sap.ui.commons.MenuItem, iIndex: number): sap.ui.ux3.Feed;
/**
* Removes all the controls from the aggregation {@link #getChunks chunks}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.FeedChunk[]} An array of the removed elements (might be empty)
*/
public removeAllChunks(): sap.ui.ux3.FeedChunk[];
/**
* Removes all the controls from the aggregation {@link #getFilterItems filterItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.ListItem[]} An array of the removed elements (might be empty)
*/
public removeAllFilterItems(): sap.ui.core.ListItem[];
/**
* Removes all the controls from the aggregation {@link #getToolsMenuItems toolsMenuItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.MenuItem[]} An array of the removed elements (might be empty)
*/
public removeAllToolsMenuItems(): sap.ui.commons.MenuItem[];
/**
* Removes a chunk from the aggregation {@link #getChunks chunks}.
* @param {number|string|sap.ui.ux3.FeedChunk} vChunk - The chunk to remove or its index or id
* @returns {sap.ui.ux3.FeedChunk} The removed chunk or null
*/
public removeChunk(vChunk: number|string|sap.ui.ux3.FeedChunk): sap.ui.ux3.FeedChunk;
/**
* Removes a filterItem from the aggregation {@link #getFilterItems filterItems}.
* @param {number|string|sap.ui.core.ListItem} vFilterItem - The filterItem to remove or its index or id
* @returns {sap.ui.core.ListItem} The removed filterItem or null
*/
public removeFilterItem(vFilterItem: number|string|sap.ui.core.ListItem): sap.ui.core.ListItem;
/**
* Removes a toolsMenuItem from the aggregation {@link #getToolsMenuItems toolsMenuItems}.
* @param {number|string|sap.ui.commons.MenuItem} vToolsMenuItem - The toolsMenuItem to remove or its index or id
* @returns {sap.ui.commons.MenuItem} The removed toolsMenuItem or null
*/
public removeToolsMenuItem(vToolsMenuItem: number|string|sap.ui.commons.MenuItem): sap.ui.commons.MenuItem;
/**
* Sets a new value for property {@link #getFeederSender feederSender}.
*
* The sender of the feeder
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sFeederSender - New value for property feederSender
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public setFeederSender(sFeederSender: string): sap.ui.ux3.Feed;
/**
* Sets a new value for property {@link #getFeederThumbnailSrc feederThumbnailSrc}.
*
* The path to the thumbnail image used for the feeder
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sFeederThumbnailSrc - New value for property feederThumbnailSrc
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public setFeederThumbnailSrc(sFeederThumbnailSrc: sap.ui.core.URI): sap.ui.ux3.Feed;
/**
* Sets a new value for property {@link #getLive live}.
*
* Specifies whether the feed shall be in live mode
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bLive - New value for property live
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public setLive(bLive: boolean): sap.ui.ux3.Feed;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Title text of the Feed. If no text is entered "FEED" is displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.ux3.Feed;
/**
* Unbinds aggregation {@link #getChunks chunks} from model data.
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public unbindChunks(): sap.ui.ux3.Feed;
/**
* Unbinds aggregation {@link #getFilterItems filterItems} from model data.
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public unbindFilterItems(): sap.ui.ux3.Feed;
/**
* Unbinds aggregation {@link #getToolsMenuItems toolsMenuItems} from model data.
* @returns {sap.ui.ux3.Feed} Reference to this
in order to allow method chaining
*/
public unbindToolsMenuItems(): sap.ui.ux3.Feed;
}
/**
* The unit that is embedded - single-wise or in a multiple way - into a Feed control.
* The control provides a set of properties for text, sender information, time stamp,
* comments, and functions such as flagging the entry to be favorite, shared, or flagged.
*/
export class FeedChunk extends sap.ui.core.Control {
/**
* Constructor for a new FeedChunk.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some actionMenuItem to the aggregation {@link #getActionMenuItems actionMenuItems}.
* @param {sap.ui.commons.MenuItem} oActionMenuItem - the actionMenuItem to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public addActionMenuItem(oActionMenuItem: sap.ui.commons.MenuItem): sap.ui.ux3.FeedChunk;
/**
* Adds some comment to the aggregation {@link #getComments comments}.
* @param {sap.ui.ux3.FeedChunk} oComment - the comment to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public addComment(oComment: sap.ui.ux3.FeedChunk): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:actionItemSelected actionItemSelected} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is fired when an item from the action menu button was selected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachActionItemSelected(fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:actionItemSelected actionItemSelected} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is fired when an item from the action menu button was selected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachActionItemSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:commentAdded commentAdded} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is raised when a comment is added to the entry. This event is not supported for comment chunks.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachCommentAdded(fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:commentAdded commentAdded} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is raised when a comment is added to the entry. This event is not supported for comment chunks.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachCommentAdded(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:deleted deleted} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is fired when the deletion button is pressed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachDeleted(fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:deleted deleted} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is fired when the deletion button is pressed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachDeleted(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:inspect inspect} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is fired when the inspect button was pressed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachInspect(fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:inspect inspect} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is fired when the inspect button was pressed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachInspect(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:referenceClicked referenceClicked} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Click on a @-reference
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachReferenceClicked(fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:referenceClicked referenceClicked} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Click on a @-reference
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachReferenceClicked(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:senderClicked senderClicked} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is fired when the thumbnail or the name of the sender is clicked.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachSenderClicked(fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:senderClicked senderClicked} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is fired when the thumbnail or the name of the sender is clicked.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachSenderClicked(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:toggleFavorite toggleFavorite} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is raised when the user clicks to set the entry as favorite. This event is not supported for comment chunks.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachToggleFavorite(fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:toggleFavorite toggleFavorite} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is raised when the user clicks to set the entry as favorite. This event is not supported for comment chunks.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachToggleFavorite(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:toggleFlagged toggleFlagged} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is raised when the user clicks to flag the entry. This event is not supported for comment chunks.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachToggleFlagged(fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:toggleFlagged toggleFlagged} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is raised when the user clicks to flag the entry. This event is not supported for comment chunks.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachToggleFlagged(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:toggleShared toggleShared} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is raised when the user clicks to share the entry. This event is not supported for comment chunks.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachToggleShared(fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Attaches event handler fnFunction
to the {@link #event:toggleShared toggleShared} event of this sap.ui.ux3.FeedChunk
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.FeedChunk
itself.
*
* Event is raised when the user clicks to share the entry. This event is not supported for comment chunks.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.FeedChunk
itself
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public attachToggleShared(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.FeedChunk;
/**
* Binds aggregation {@link #getActionMenuItems actionMenuItems} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public bindActionMenuItems(oBindingInfo: any): sap.ui.ux3.FeedChunk;
/**
* Binds aggregation {@link #getComments comments} to model data.
*
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a
* detailed description of the possible properties of oBindingInfo
.
* @param {any} oBindingInfo - The binding information
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public bindComments(oBindingInfo: any): sap.ui.ux3.FeedChunk;
/**
* Destroys all the actionMenuItems in the aggregation {@link #getActionMenuItems actionMenuItems}.
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public destroyActionMenuItems(): sap.ui.ux3.FeedChunk;
/**
* Destroys all the comments in the aggregation {@link #getComments comments}.
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public destroyComments(): sap.ui.ux3.FeedChunk;
/**
* Detaches event handler fnFunction
from the {@link #event:actionItemSelected actionItemSelected} event of this sap.ui.ux3.FeedChunk
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public detachActionItemSelected(fnFunction: Function, oListener: any): sap.ui.ux3.FeedChunk;
/**
* Detaches event handler fnFunction
from the {@link #event:commentAdded commentAdded} event of this sap.ui.ux3.FeedChunk
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public detachCommentAdded(fnFunction: Function, oListener: any): sap.ui.ux3.FeedChunk;
/**
* Detaches event handler fnFunction
from the {@link #event:deleted deleted} event of this sap.ui.ux3.FeedChunk
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public detachDeleted(fnFunction: Function, oListener: any): sap.ui.ux3.FeedChunk;
/**
* Detaches event handler fnFunction
from the {@link #event:inspect inspect} event of this sap.ui.ux3.FeedChunk
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public detachInspect(fnFunction: Function, oListener: any): sap.ui.ux3.FeedChunk;
/**
* Detaches event handler fnFunction
from the {@link #event:referenceClicked referenceClicked} event of this sap.ui.ux3.FeedChunk
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public detachReferenceClicked(fnFunction: Function, oListener: any): sap.ui.ux3.FeedChunk;
/**
* Detaches event handler fnFunction
from the {@link #event:senderClicked senderClicked} event of this sap.ui.ux3.FeedChunk
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public detachSenderClicked(fnFunction: Function, oListener: any): sap.ui.ux3.FeedChunk;
/**
* Detaches event handler fnFunction
from the {@link #event:toggleFavorite toggleFavorite} event of this sap.ui.ux3.FeedChunk
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public detachToggleFavorite(fnFunction: Function, oListener: any): sap.ui.ux3.FeedChunk;
/**
* Detaches event handler fnFunction
from the {@link #event:toggleFlagged toggleFlagged} event of this sap.ui.ux3.FeedChunk
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public detachToggleFlagged(fnFunction: Function, oListener: any): sap.ui.ux3.FeedChunk;
/**
* Detaches event handler fnFunction
from the {@link #event:toggleShared toggleShared} event of this sap.ui.ux3.FeedChunk
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public detachToggleShared(fnFunction: Function, oListener: any): sap.ui.ux3.FeedChunk;
/**
* Creates a new subclass of class sap.ui.ux3.FeedChunk with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:actionItemSelected actionItemSelected} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
protected fireActionItemSelected(mParameters?: any): sap.ui.ux3.FeedChunk;
/**
* Fires event {@link #event:commentAdded commentAdded} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
protected fireCommentAdded(mParameters?: any): sap.ui.ux3.FeedChunk;
/**
* Fires event {@link #event:deleted deleted} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
protected fireDeleted(mParameters?: any): sap.ui.ux3.FeedChunk;
/**
* Fires event {@link #event:inspect inspect} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
protected fireInspect(mParameters?: any): sap.ui.ux3.FeedChunk;
/**
* Fires event {@link #event:referenceClicked referenceClicked} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
protected fireReferenceClicked(mParameters?: any): sap.ui.ux3.FeedChunk;
/**
* Fires event {@link #event:senderClicked senderClicked} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
protected fireSenderClicked(mParameters?: any): sap.ui.ux3.FeedChunk;
/**
* Fires event {@link #event:toggleFavorite toggleFavorite} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
protected fireToggleFavorite(mParameters?: any): sap.ui.ux3.FeedChunk;
/**
* Fires event {@link #event:toggleFlagged toggleFlagged} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
protected fireToggleFlagged(mParameters?: any): sap.ui.ux3.FeedChunk;
/**
* Fires event {@link #event:toggleShared toggleShared} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
protected fireToggleShared(mParameters?: any): sap.ui.ux3.FeedChunk;
/**
* Gets content of aggregation {@link #getActionMenuItems actionMenuItems}.
*
* MenuItems to open when there is a click on the action menu button
* @returns {sap.ui.commons.MenuItem[]}
*/
public getActionMenuItems(): sap.ui.commons.MenuItem[];
/**
* Gets current value of property {@link #getCommentChunk commentChunk}.
*
* This flag changes a FeedChunk into a CommentChunk. In this case, it can not have own comments,
* furthermore it must be assigned to a FeedChunk.
*
* Default value is false
.
* @returns {boolean} Value of property commentChunk
*/
public getCommentChunk(): boolean;
/**
* Gets content of aggregation {@link #getComments comments}.
*
* Comments on this chunk
* @returns {sap.ui.ux3.FeedChunk[]}
*/
public getComments(): sap.ui.ux3.FeedChunk[];
/**
* Gets current value of property {@link #getDeletionAllowed deletionAllowed}.
*
* Flag if the deletion of the chunk shall be allowed
*
* Default value is false
.
* @returns {boolean} Value of property deletionAllowed
*/
public getDeletionAllowed(): boolean;
/**
* Gets current value of property {@link #getEnableComment enableComment}.
*
* If true the comment action is enabled.
*
* Default value is true
.
* @returns {boolean} Value of property enableComment
*/
public getEnableComment(): boolean;
/**
* Gets current value of property {@link #getEnableFavorite enableFavorite}.
*
* If true the favorite action is enabled.
*
* Default value is true
.
* @returns {boolean} Value of property enableFavorite
*/
public getEnableFavorite(): boolean;
/**
* Gets current value of property {@link #getEnableFlag enableFlag}.
*
* If true the flag action is enabled.
*
* Default value is true
.
* @returns {boolean} Value of property enableFlag
*/
public getEnableFlag(): boolean;
/**
* Gets current value of property {@link #getEnableInspect enableInspect}.
*
* If true the inspect action is enabled.
*
* Default value is true
.
* @returns {boolean} Value of property enableInspect
*/
public getEnableInspect(): boolean;
/**
* Gets current value of property {@link #getEnableShare enableShare}.
*
* If true the share action is enabled.
*
* Default value is true
.
* @returns {boolean} Value of property enableShare
*/
public getEnableShare(): boolean;
/**
* Gets current value of property {@link #getFavorite favorite}.
*
* Defines whether the entry shall be displayed as favorite. This property is not supported for comment chunks.
* @returns {boolean} Value of property favorite
*/
public getFavorite(): boolean;
/**
* Gets current value of property {@link #getFeederSender feederSender}.
*
* Sender for the comment feeder
* This property is optional if the chunk is a sub-control of a feed control. In this case the value of the feed control is used if it's not set. So it must be only set once on the feed control.
* @returns {string} Value of property feederSender
*/
public getFeederSender(): string;
/**
* Gets current value of property {@link #getFeederThumbnailSrc feederThumbnailSrc}.
*
* URL to the thumbnail image for the comment feeder.
* This property is optional if the chunk is a sub-control of a feed control. In this case the value of the feed control is used if it's not set. So it must be only set once on the feed control.
* @returns {sap.ui.core.URI} Value of property feederThumbnailSrc
*/
public getFeederThumbnailSrc(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getFlagged flagged}.
*
* Defines whether the entry is flagged. This property is not supported for comment chunks.
*
* Default value is false
.
* @returns {boolean} Value of property flagged
*/
public getFlagged(): boolean;
/**
* Returns a metadata object for class sap.ui.ux3.FeedChunk.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSender sender}.
*
* Sender of the chunk
* @returns {string} Value of property sender
*/
public getSender(): string;
/**
* Gets current value of property {@link #getShared shared}.
*
* Defines whether the entry shall be shared. This property is not supported for comment chunks.
*
* Default value is false
.
* @returns {boolean} Value of property shared
*/
public getShared(): boolean;
/**
* Gets current value of property {@link #getText text}.
*
* The FeedChunk text. @References are supported.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getThumbnailSrc thumbnailSrc}.
*
* URL to the thumbnail image.
* @returns {sap.ui.core.URI} Value of property thumbnailSrc
*/
public getThumbnailSrc(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getTimestamp timestamp}.
*
* Format is ISO 8601 YYYY-MM-DDThh:mm:ss.sZ, Z meaning the time is in UTC time zone
* @returns {string} Value of property timestamp
*/
public getTimestamp(): string;
/**
* Checks for the provided sap.ui.commons.MenuItem
in the aggregation {@link #getActionMenuItems actionMenuItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.commons.MenuItem} oActionMenuItem - The actionMenuItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfActionMenuItem(oActionMenuItem: sap.ui.commons.MenuItem): number;
/**
* Checks for the provided sap.ui.ux3.FeedChunk
in the aggregation {@link #getComments comments}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.FeedChunk} oComment - The comment whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfComment(oComment: sap.ui.ux3.FeedChunk): number;
/**
* Inserts a actionMenuItem into the aggregation {@link #getActionMenuItems actionMenuItems}.
* @param {sap.ui.commons.MenuItem} oActionMenuItem - the actionMenuItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the actionMenuItem should be inserted at; for a negative value of iIndex
, the actionMenuItem is inserted at position 0; for a value greater than the current size of the aggregation, the actionMenuItem is inserted at the last position
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public insertActionMenuItem(oActionMenuItem: sap.ui.commons.MenuItem, iIndex: number): sap.ui.ux3.FeedChunk;
/**
* Inserts a comment into the aggregation {@link #getComments comments}.
* @param {sap.ui.ux3.FeedChunk} oComment - the comment to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the comment should be inserted at; for a negative value of iIndex
, the comment is inserted at position 0; for a value greater than the current size of the aggregation, the comment is inserted at the last position
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public insertComment(oComment: sap.ui.ux3.FeedChunk, iIndex: number): sap.ui.ux3.FeedChunk;
/**
* Removes a actionMenuItem from the aggregation {@link #getActionMenuItems actionMenuItems}.
* @param {number|string|sap.ui.commons.MenuItem} vActionMenuItem - The actionMenuItem to remove or its index or id
* @returns {sap.ui.commons.MenuItem} The removed actionMenuItem or null
*/
public removeActionMenuItem(vActionMenuItem: number|string|sap.ui.commons.MenuItem): sap.ui.commons.MenuItem;
/**
* Removes all the controls from the aggregation {@link #getActionMenuItems actionMenuItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.commons.MenuItem[]} An array of the removed elements (might be empty)
*/
public removeAllActionMenuItems(): sap.ui.commons.MenuItem[];
/**
* Removes all the controls from the aggregation {@link #getComments comments}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.FeedChunk[]} An array of the removed elements (might be empty)
*/
public removeAllComments(): sap.ui.ux3.FeedChunk[];
/**
* Removes a comment from the aggregation {@link #getComments comments}.
* @param {number|string|sap.ui.ux3.FeedChunk} vComment - The comment to remove or its index or id
* @returns {sap.ui.ux3.FeedChunk} The removed comment or null
*/
public removeComment(vComment: number|string|sap.ui.ux3.FeedChunk): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getCommentChunk commentChunk}.
*
* This flag changes a FeedChunk into a CommentChunk. In this case, it can not have own comments,
* furthermore it must be assigned to a FeedChunk.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bCommentChunk - New value for property commentChunk
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setCommentChunk(bCommentChunk: boolean): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getDeletionAllowed deletionAllowed}.
*
* Flag if the deletion of the chunk shall be allowed
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bDeletionAllowed - New value for property deletionAllowed
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setDeletionAllowed(bDeletionAllowed: boolean): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getEnableComment enableComment}.
*
* If true the comment action is enabled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableComment - New value for property enableComment
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setEnableComment(bEnableComment: boolean): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getEnableFavorite enableFavorite}.
*
* If true the favorite action is enabled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableFavorite - New value for property enableFavorite
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setEnableFavorite(bEnableFavorite: boolean): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getEnableFlag enableFlag}.
*
* If true the flag action is enabled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableFlag - New value for property enableFlag
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setEnableFlag(bEnableFlag: boolean): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getEnableInspect enableInspect}.
*
* If true the inspect action is enabled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableInspect - New value for property enableInspect
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setEnableInspect(bEnableInspect: boolean): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getEnableShare enableShare}.
*
* If true the share action is enabled.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnableShare - New value for property enableShare
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setEnableShare(bEnableShare: boolean): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getFavorite favorite}.
*
* Defines whether the entry shall be displayed as favorite. This property is not supported for comment chunks.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {boolean} bFavorite - New value for property favorite
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setFavorite(bFavorite: boolean): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getFeederSender feederSender}.
*
* Sender for the comment feeder
* This property is optional if the chunk is a sub-control of a feed control. In this case the value of the feed control is used if it's not set. So it must be only set once on the feed control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sFeederSender - New value for property feederSender
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setFeederSender(sFeederSender: string): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getFeederThumbnailSrc feederThumbnailSrc}.
*
* URL to the thumbnail image for the comment feeder.
* This property is optional if the chunk is a sub-control of a feed control. In this case the value of the feed control is used if it's not set. So it must be only set once on the feed control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sFeederThumbnailSrc - New value for property feederThumbnailSrc
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setFeederThumbnailSrc(sFeederThumbnailSrc: sap.ui.core.URI): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getFlagged flagged}.
*
* Defines whether the entry is flagged. This property is not supported for comment chunks.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bFlagged - New value for property flagged
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setFlagged(bFlagged: boolean): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getSender sender}.
*
* Sender of the chunk
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sSender - New value for property sender
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setSender(sSender: string): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getShared shared}.
*
* Defines whether the entry shall be shared. This property is not supported for comment chunks.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShared - New value for property shared
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setShared(bShared: boolean): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getText text}.
*
* The FeedChunk text. @References are supported.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getThumbnailSrc thumbnailSrc}.
*
* URL to the thumbnail image.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sThumbnailSrc - New value for property thumbnailSrc
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setThumbnailSrc(sThumbnailSrc: sap.ui.core.URI): sap.ui.ux3.FeedChunk;
/**
* Sets a new value for property {@link #getTimestamp timestamp}.
*
* Format is ISO 8601 YYYY-MM-DDThh:mm:ss.sZ, Z meaning the time is in UTC time zone
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTimestamp - New value for property timestamp
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public setTimestamp(sTimestamp: string): sap.ui.ux3.FeedChunk;
/**
* Unbinds aggregation {@link #getActionMenuItems actionMenuItems} from model data.
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public unbindActionMenuItems(): sap.ui.ux3.FeedChunk;
/**
* Unbinds aggregation {@link #getComments comments} from model data.
* @returns {sap.ui.ux3.FeedChunk} Reference to this
in order to allow method chaining
*/
public unbindComments(): sap.ui.ux3.FeedChunk;
}
/**
* This feed control flavor represents a lean common feed, or a comment feed, with a text commit function.
* The control can be used stand alone or in a multiple way, and generally would be integrated directly into a UIArea.
*/
export class Feeder extends sap.ui.core.Control {
/**
* Constructor for a new Feeder.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:submit submit} event of this sap.ui.ux3.Feeder
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Feeder
itself.
*
* Event is fired when the entered text is submitted
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Feeder
itself
* @returns {sap.ui.ux3.Feeder} Reference to this
in order to allow method chaining
*/
public attachSubmit(fnFunction: Function, oListener?: any): sap.ui.ux3.Feeder;
/**
* Attaches event handler fnFunction
to the {@link #event:submit submit} event of this sap.ui.ux3.Feeder
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Feeder
itself.
*
* Event is fired when the entered text is submitted
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Feeder
itself
* @returns {sap.ui.ux3.Feeder} Reference to this
in order to allow method chaining
*/
public attachSubmit(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Feeder;
/**
* Detaches event handler fnFunction
from the {@link #event:submit submit} event of this sap.ui.ux3.Feeder
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Feeder} Reference to this
in order to allow method chaining
*/
public detachSubmit(fnFunction: Function, oListener: any): sap.ui.ux3.Feeder;
/**
* Creates a new subclass of class sap.ui.ux3.Feeder with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:submit submit} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Feeder} Reference to this
in order to allow method chaining
*/
protected fireSubmit(mParameters?: any): sap.ui.ux3.Feeder;
/**
* Returns a metadata object for class sap.ui.ux3.Feeder.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getPlaceholderText placeholderText}.
*
* This property could be used for costum placeholder. If it is not set, the default text is used.
* @returns {string} Value of property placeholderText
*/
public getPlaceholderText(): string;
/**
* Gets current value of property {@link #getText text}.
*
* The text for the Feeder. @References are supported.
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Gets current value of property {@link #getThumbnailSrc thumbnailSrc}.
*
* URL to the thumb nail image
* This property is optional if the feeder is a sub-control of a feed or a feedChunk control. In this case the value of the feed or feddChunk control is used if it's not set. So it must be only set once on the feed or feedChunk control.
* @returns {sap.ui.core.URI} Value of property thumbnailSrc
*/
public getThumbnailSrc(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getType type}.
*
* Type and size of the Feeder
*
* Default value is Large
.
* @returns {sap.ui.ux3.FeederType} Value of property type
*/
public getType(): sap.ui.ux3.FeederType;
/**
* Sets a new value for property {@link #getPlaceholderText placeholderText}.
*
* This property could be used for costum placeholder. If it is not set, the default text is used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sPlaceholderText - New value for property placeholderText
* @returns {sap.ui.ux3.Feeder} Reference to this
in order to allow method chaining
*/
public setPlaceholderText(sPlaceholderText: string): sap.ui.ux3.Feeder;
/**
* Sets a new value for property {@link #getText text}.
*
* The text for the Feeder. @References are supported.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.ux3.Feeder} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.ux3.Feeder;
/**
* Sets a new value for property {@link #getThumbnailSrc thumbnailSrc}.
*
* URL to the thumb nail image
* This property is optional if the feeder is a sub-control of a feed or a feedChunk control. In this case the value of the feed or feddChunk control is used if it's not set. So it must be only set once on the feed or feedChunk control.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sThumbnailSrc - New value for property thumbnailSrc
* @returns {sap.ui.ux3.Feeder} Reference to this
in order to allow method chaining
*/
public setThumbnailSrc(sThumbnailSrc: sap.ui.core.URI): sap.ui.ux3.Feeder;
/**
* Sets a new value for property {@link #getType type}.
*
* Type and size of the Feeder
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Large
.
* @param {sap.ui.ux3.FeederType} sType - New value for property type
* @returns {sap.ui.ux3.Feeder} Reference to this
in order to allow method chaining
*/
public setType(sType: sap.ui.ux3.FeederType): sap.ui.ux3.Feeder;
}
/**
* Type of a Feeder.
*/
export enum FeederType {
/**
* comment feeder (small)
*/
Comment = "Comment",
/**
* large Feeder
*/
Large = "Large",
/**
* medium feeder
*/
Medium = "Medium",
}
/**
* Defines the states of the follow action
*/
export enum FollowActionState {
/**
* default state
*/
Default = "Default",
/**
* follow state
*/
Follow = "Follow",
/**
* hold state
*/
Hold = "Hold",
}
/**
* Provides enhanced navigation capabilities and is the parent control of NavigationItem. It is displayed in the form of a horizontal line
* with switching markers depending on the currently selected item. The size of an item which is currently chosen by the user is enlarged. In the case
* that a large number of items are defined for the bar, this is made transparent to the user by showing symbols for scrolling options (forwards and backwards)
* to see the next or previous items.
*/
export class NavigationBar extends sap.ui.core.Control {
/**
* Constructor for a new NavigationBar.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some associatedItem into the association {@link #getAssociatedItems associatedItems}.
* @param {sap.ui.core.ID|sap.ui.ux3.NavigationItem} vAssociatedItem - the associatedItems to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.NavigationBar} Reference to this
in order to allow method chaining
*/
public addAssociatedItem(vAssociatedItem: sap.ui.core.ID|sap.ui.ux3.NavigationItem): sap.ui.ux3.NavigationBar;
/**
* Adds some item to the aggregation {@link #getItems items}.
* @param {sap.ui.ux3.NavigationItem} oItem - the item to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.NavigationBar} Reference to this
in order to allow method chaining
*/
public addItem(oItem: sap.ui.ux3.NavigationItem): sap.ui.ux3.NavigationBar;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.ux3.NavigationBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.NavigationBar
itself.
*
* Event is fired when an item is selected by the user
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.NavigationBar
itself
* @returns {sap.ui.ux3.NavigationBar} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.ux3.NavigationBar;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.ux3.NavigationBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.NavigationBar
itself.
*
* Event is fired when an item is selected by the user
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.NavigationBar
itself
* @returns {sap.ui.ux3.NavigationBar} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.NavigationBar;
/**
* Destroys all the items in the aggregation {@link #getItems items}.
* @returns {sap.ui.ux3.NavigationBar} Reference to this
in order to allow method chaining
*/
public destroyItems(): sap.ui.ux3.NavigationBar;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.ux3.NavigationBar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.NavigationBar} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.ux3.NavigationBar;
/**
* Creates a new subclass of class sap.ui.ux3.NavigationBar with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:select select} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireSelect(mParameters?: any): boolean;
/**
* Returns array of IDs of the elements which are the current targets of the association {@link #getAssociatedItems associatedItems}.
* @returns {sap.ui.core.ID[]}
*/
public getAssociatedItems(): sap.ui.core.ID[];
/**
* Gets content of aggregation {@link #getItems items}.
*
* If the navigation items need to have a different parent than the NavigationBar, alternatively the associatedItems association can be used.
* The NavigationBar follows the approach to use the items aggregation. If this aggregation is empty, associatedItems is used.
* @returns {sap.ui.ux3.NavigationItem[]}
*/
public getItems(): sap.ui.ux3.NavigationItem[];
/**
* Returns a metadata object for class sap.ui.ux3.NavigationBar.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getOverflowItemsToUpperCase overflowItemsToUpperCase}.
*
* Sets the appearance of the menu items in the overflow menu to uppercase
*
* Default value is false
.
* @returns {boolean} Value of property overflowItemsToUpperCase
*/
public getOverflowItemsToUpperCase(): boolean;
/**
* ID of the element which is the current target of the association {@link #getSelectedItem selectedItem}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedItem(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getToplevelVariant toplevelVariant}.
*
* Defines whether the navigation bar shall have top-level appearance
*
* Default value is false
.
* @returns {boolean} Value of property toplevelVariant
*/
public getToplevelVariant(): boolean;
/**
* Checks for the provided sap.ui.ux3.NavigationItem
in the aggregation {@link #getItems items}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.NavigationItem} oItem - The item whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfItem(oItem: sap.ui.ux3.NavigationItem): number;
/**
* Inserts a item into the aggregation {@link #getItems items}.
* @param {sap.ui.ux3.NavigationItem} oItem - the item to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the item should be inserted at; for a negative value of iIndex
, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
* @returns {sap.ui.ux3.NavigationBar} Reference to this
in order to allow method chaining
*/
public insertItem(oItem: sap.ui.ux3.NavigationItem, iIndex: number): sap.ui.ux3.NavigationBar;
/**
* Returns whether there is a selectedItem set which is actually present in the items aggregation; or, if the aggregation is empty, in the associatedItems association.
* @returns {boolean}
*/
public isSelectedItemValid(): boolean;
/**
* Removes all the controls in the association named {@link #getAssociatedItems associatedItems}.
* @returns {sap.ui.core.ID[]} An array of the removed elements (might be empty)
*/
public removeAllAssociatedItems(): sap.ui.core.ID[];
/**
* Removes all the controls from the aggregation {@link #getItems items}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.NavigationItem[]} An array of the removed elements (might be empty)
*/
public removeAllItems(): sap.ui.ux3.NavigationItem[];
/**
* Removes an associatedItem from the association named {@link #getAssociatedItems associatedItems}.
* @param {number|sap.ui.core.ID|sap.ui.ux3.NavigationItem} vAssociatedItem - The associatedItem to be removed or its index or ID
* @returns {sap.ui.core.ID} The removed associatedItem or null
*/
public removeAssociatedItem(vAssociatedItem: number|sap.ui.core.ID|sap.ui.ux3.NavigationItem): sap.ui.core.ID;
/**
* Removes a item from the aggregation {@link #getItems items}.
* @param {number|string|sap.ui.ux3.NavigationItem} vItem - The item to remove or its index or id
* @returns {sap.ui.ux3.NavigationItem} The removed item or null
*/
public removeItem(vItem: number|string|sap.ui.ux3.NavigationItem): sap.ui.ux3.NavigationItem;
/**
* Replaces the currently associated items with the ones in the given array
* @param {sap.ui.ux3.NavigationItem[]} aItems - The items to associate
* @returns {sap.ui.ux3.NavigationBar}
*/
public setAssociatedItems(aItems: sap.ui.ux3.NavigationItem[]): sap.ui.ux3.NavigationBar;
/**
* Sets a new value for property {@link #getOverflowItemsToUpperCase overflowItemsToUpperCase}.
*
* Sets the appearance of the menu items in the overflow menu to uppercase
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bOverflowItemsToUpperCase - New value for property overflowItemsToUpperCase
* @returns {sap.ui.ux3.NavigationBar} Reference to this
in order to allow method chaining
*/
public setOverflowItemsToUpperCase(bOverflowItemsToUpperCase: boolean): sap.ui.ux3.NavigationBar;
/**
* Sets the associated {@link #getSelectedItem selectedItem}.
* @param {sap.ui.core.ID|sap.ui.ux3.NavigationItem} oSelectedItem - ID of an element which becomes the new target of this selectedItem association; alternatively, an element instance may be given
* @returns {sap.ui.ux3.NavigationBar} Reference to this
in order to allow method chaining
*/
public setSelectedItem(oSelectedItem: sap.ui.core.ID|sap.ui.ux3.NavigationItem): sap.ui.ux3.NavigationBar;
/**
* Sets a new value for property {@link #getToplevelVariant toplevelVariant}.
*
* Defines whether the navigation bar shall have top-level appearance
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bToplevelVariant - New value for property toplevelVariant
* @returns {sap.ui.ux3.NavigationBar} Reference to this
in order to allow method chaining
*/
public setToplevelVariant(bToplevelVariant: boolean): sap.ui.ux3.NavigationBar;
}
/**
* Is the item to be used within the NavigationBar
*/
export class NavigationItem extends sap.ui.core.Item {
/**
* Constructor for a new NavigationItem.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some subItem to the aggregation {@link #getSubItems subItems}.
* @param {sap.ui.ux3.NavigationItem} oSubItem - the subItem to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.NavigationItem} Reference to this
in order to allow method chaining
*/
public addSubItem(oSubItem: sap.ui.ux3.NavigationItem): sap.ui.ux3.NavigationItem;
/**
* Destroys all the subItems in the aggregation {@link #getSubItems subItems}.
* @returns {sap.ui.ux3.NavigationItem} Reference to this
in order to allow method chaining
*/
public destroySubItems(): sap.ui.ux3.NavigationItem;
/**
* Creates a new subclass of class sap.ui.ux3.NavigationItem with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getHref href}.
*
* Defines the link target URL. This property is optional and should only be set when required!
* The use of the href property is to not only allow users to navigate in-place by left-clicking NavigationItems, but also to allow right-click and then "open in new tab" or "open in new window". As long as href is not set, an empty window will open and stay blank. But when href is set, the new window/tab will load this URL and it is the application's responsibility to display what the user expects (e.g. the Shell, with the respective NavigationItem being selected).
* @returns {sap.ui.core.URI} Value of property href
*/
public getHref(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.ui.ux3.NavigationItem.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getSubItems subItems}.
*
* Any NavigationItems on the next hierarchy level connected to this NavigationItem
* @returns {sap.ui.ux3.NavigationItem[]}
*/
public getSubItems(): sap.ui.ux3.NavigationItem[];
/**
* Gets current value of property {@link #getVisible visible}.
*
* Whether the NavigationItem is currently visible. When making NavigationItems invisible at runtime it is the application's responsibility to make sure it is not the currently selected one - or to select another one in this case.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Checks for the provided sap.ui.ux3.NavigationItem
in the aggregation {@link #getSubItems subItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.NavigationItem} oSubItem - The subItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSubItem(oSubItem: sap.ui.ux3.NavigationItem): number;
/**
* Inserts a subItem into the aggregation {@link #getSubItems subItems}.
* @param {sap.ui.ux3.NavigationItem} oSubItem - the subItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the subItem should be inserted at; for a negative value of iIndex
, the subItem is inserted at position 0; for a value greater than the current size of the aggregation, the subItem is inserted at the last position
* @returns {sap.ui.ux3.NavigationItem} Reference to this
in order to allow method chaining
*/
public insertSubItem(oSubItem: sap.ui.ux3.NavigationItem, iIndex: number): sap.ui.ux3.NavigationItem;
/**
* Removes all the controls from the aggregation {@link #getSubItems subItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.NavigationItem[]} An array of the removed elements (might be empty)
*/
public removeAllSubItems(): sap.ui.ux3.NavigationItem[];
/**
* Removes a subItem from the aggregation {@link #getSubItems subItems}.
* @param {number|string|sap.ui.ux3.NavigationItem} vSubItem - The subItem to remove or its index or id
* @returns {sap.ui.ux3.NavigationItem} The removed subItem or null
*/
public removeSubItem(vSubItem: number|string|sap.ui.ux3.NavigationItem): sap.ui.ux3.NavigationItem;
/**
* Sets a new value for property {@link #getHref href}.
*
* Defines the link target URL. This property is optional and should only be set when required!
* The use of the href property is to not only allow users to navigate in-place by left-clicking NavigationItems, but also to allow right-click and then "open in new tab" or "open in new window". As long as href is not set, an empty window will open and stay blank. But when href is set, the new window/tab will load this URL and it is the application's responsibility to display what the user expects (e.g. the Shell, with the respective NavigationItem being selected).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sHref - New value for property href
* @returns {sap.ui.ux3.NavigationItem} Reference to this
in order to allow method chaining
*/
public setHref(sHref: sap.ui.core.URI): sap.ui.ux3.NavigationItem;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Whether the NavigationItem is currently visible. When making NavigationItems invisible at runtime it is the application's responsibility to make sure it is not the currently selected one - or to select another one in this case.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.ui.ux3.NavigationItem} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.ui.ux3.NavigationItem;
}
/**
* A NotificationBar is a "toolbar" that can be added to a page to show messages and notifications from the application.
* Its position, height and width is inherited from the element that the notification bar is added to.
* The NotificationBar uses position: fixed; to always stay at the bottom of the screen. This CSS may sometimes cause
* issues when nested deeply inside other controls. To have a proper behavior of the NotificationBar use it as high
* in the control hierarchy as possible.
*/
export class NotificationBar extends sap.ui.core.Control {
/**
* Constructor for a new NotificationBar.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some notifier to the aggregation {@link #getNotifiers notifiers}.
* @param {sap.ui.core.Element} oNotifier - the notifier to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.NotificationBar} Reference to this
in order to allow method chaining
*/
public addNotifier(oNotifier: sap.ui.core.Element): sap.ui.ux3.NotificationBar;
/**
* Attaches event handler fnFunction
to the {@link #event:display display} event of this sap.ui.ux3.NotificationBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.NotificationBar
itself.
*
* Event is fired when the bar wants to be displayed depending on given flag. This allows the application to decide what to do.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.NotificationBar
itself
* @returns {sap.ui.ux3.NotificationBar} Reference to this
in order to allow method chaining
*/
public attachDisplay(fnFunction: Function, oListener?: any): sap.ui.ux3.NotificationBar;
/**
* Attaches event handler fnFunction
to the {@link #event:display display} event of this sap.ui.ux3.NotificationBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.NotificationBar
itself.
*
* Event is fired when the bar wants to be displayed depending on given flag. This allows the application to decide what to do.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.NotificationBar
itself
* @returns {sap.ui.ux3.NotificationBar} Reference to this
in order to allow method chaining
*/
public attachDisplay(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.NotificationBar;
/**
* Attaches event handler fnFunction
to the {@link #event:resize resize} event of this sap.ui.ux3.NotificationBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.NotificationBar
itself.
*
* This event is thrown when the bar was resized (to the different valid states: Min, Max, Default, None). The event itself can be used from SAPUI5-version 1.12.2 since there was a bug in the previous versions firing this event.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.NotificationBar
itself
* @returns {sap.ui.ux3.NotificationBar} Reference to this
in order to allow method chaining
*/
public attachResize(fnFunction: Function, oListener?: any): sap.ui.ux3.NotificationBar;
/**
* Attaches event handler fnFunction
to the {@link #event:resize resize} event of this sap.ui.ux3.NotificationBar
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.NotificationBar
itself.
*
* This event is thrown when the bar was resized (to the different valid states: Min, Max, Default, None). The event itself can be used from SAPUI5-version 1.12.2 since there was a bug in the previous versions firing this event.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.NotificationBar
itself
* @returns {sap.ui.ux3.NotificationBar} Reference to this
in order to allow method chaining
*/
public attachResize(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.NotificationBar;
/**
* Destroys the messageNotifier in the aggregation {@link #getMessageNotifier messageNotifier}.
* @returns {sap.ui.ux3.NotificationBar} Reference to this
in order to allow method chaining
*/
public destroyMessageNotifier(): sap.ui.ux3.NotificationBar;
/**
* Destroys all the notifiers in the aggregation {@link #getNotifiers notifiers}.
* @returns {sap.ui.ux3.NotificationBar} Reference to this
in order to allow method chaining
*/
public destroyNotifiers(): sap.ui.ux3.NotificationBar;
/**
* Detaches event handler fnFunction
from the {@link #event:display display} event of this sap.ui.ux3.NotificationBar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.NotificationBar} Reference to this
in order to allow method chaining
*/
public detachDisplay(fnFunction: Function, oListener: any): sap.ui.ux3.NotificationBar;
/**
* Detaches event handler fnFunction
from the {@link #event:resize resize} event of this sap.ui.ux3.NotificationBar
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.NotificationBar} Reference to this
in order to allow method chaining
*/
public detachResize(fnFunction: Function, oListener: any): sap.ui.ux3.NotificationBar;
/**
* Creates a new subclass of class sap.ui.ux3.NotificationBar with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:display display} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.NotificationBar} Reference to this
in order to allow method chaining
*/
protected fireDisplay(mParameters?: any): sap.ui.ux3.NotificationBar;
/**
* Fires event {@link #event:resize resize} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.NotificationBar} Reference to this
in order to allow method chaining
*/
protected fireResize(mParameters?: any): sap.ui.ux3.NotificationBar;
/**
* Gets current value of property {@link #getAlwaysShowToggler alwaysShowToggler}.
*
* This property defines if the toggler should be displayed the whole time when the NotificationBar is shown.
*
* Default value is false
.
* @returns {boolean} Value of property alwaysShowToggler
*/
public getAlwaysShowToggler(): boolean;
/**
* Gets content of aggregation {@link #getMessageNotifier messageNotifier}.
*
* Notifier that shows messages
* @returns {sap.ui.core.Element}
*/
public getMessageNotifier(): sap.ui.core.Element;
/**
* Returns a metadata object for class sap.ui.ux3.NotificationBar.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getNotifiers notifiers}.
*
* Notifiers that monitor something within the application and display the corresponding notifications.
* @returns {sap.ui.core.Element[]}
*/
public getNotifiers(): sap.ui.core.Element[];
/**
* Gets current value of property {@link #getResizeEnabled resizeEnabled}.
*
* This property enables the bar to be resized by the user.
*
* Default value is true
.
* @returns {boolean} Value of property resizeEnabled
*/
public getResizeEnabled(): boolean;
/**
* Gets current value of property {@link #getVisibleStatus visibleStatus}.
*
* This property displays the bar corresponding to given status
*
* Default value is Default
.
* @returns {sap.ui.ux3.NotificationBarStatus} Value of property visibleStatus
*/
public getVisibleStatus(): sap.ui.ux3.NotificationBarStatus;
/**
* This method checks if the NotificationBar has any items (notifications or messages) to show and returns true if there are any items to show. So the application should decide if the bar should be displayed.
* @returns {boolean}
*/
public hasItems(): boolean;
/**
* Checks for the provided sap.ui.core.Element
in the aggregation {@link #getNotifiers notifiers}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Element} oNotifier - The notifier whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfNotifier(oNotifier: sap.ui.core.Element): number;
/**
* Inserts a notifier into the aggregation {@link #getNotifiers notifiers}.
* @param {sap.ui.core.Element} oNotifier - the notifier to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the notifier should be inserted at; for a negative value of iIndex
, the notifier is inserted at position 0; for a value greater than the current size of the aggregation, the notifier is inserted at the last position
* @returns {sap.ui.ux3.NotificationBar} Reference to this
in order to allow method chaining
*/
public insertNotifier(oNotifier: sap.ui.core.Element, iIndex: number): sap.ui.ux3.NotificationBar;
/**
* Removes all the controls from the aggregation {@link #getNotifiers notifiers}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Element[]} An array of the removed elements (might be empty)
*/
public removeAllNotifiers(): sap.ui.core.Element[];
/**
* Removes a notifier from the aggregation {@link #getNotifiers notifiers}.
* @param {number|string|sap.ui.core.Element} vNotifier - The notifier to remove or its index or id
* @returns {sap.ui.core.Element} The removed notifier or null
*/
public removeNotifier(vNotifier: number|string|sap.ui.core.Element): sap.ui.core.Element;
/**
* @param {boolean} bAlwaysShow - if the toggler should be visible all the time set this parameter to true
*/
public setAlwaysShowToggler(bAlwaysShow: boolean): void;
/**
* Sets the aggregated {@link #getMessageNotifier messageNotifier}.
* @param {sap.ui.core.Element} oMessageNotifier - The messageNotifier to set
* @returns {sap.ui.ux3.NotificationBar} Reference to this
in order to allow method chaining
*/
public setMessageNotifier(oMessageNotifier: sap.ui.core.Element): sap.ui.ux3.NotificationBar;
/**
* Sets a new value for property {@link #getResizeEnabled resizeEnabled}.
*
* This property enables the bar to be resized by the user.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bResizeEnabled - New value for property resizeEnabled
* @returns {sap.ui.ux3.NotificationBar} Reference to this
in order to allow method chaining
*/
public setResizeEnabled(bResizeEnabled: boolean): sap.ui.ux3.NotificationBar;
/**
* Sets a new value for property {@link #getVisibleStatus visibleStatus}.
*
* This property displays the bar corresponding to given status
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Default
.
* @param {sap.ui.ux3.NotificationBarStatus} sVisibleStatus - New value for property visibleStatus
* @returns {sap.ui.ux3.NotificationBar} Reference to this
in order to allow method chaining
*/
public setVisibleStatus(sVisibleStatus: sap.ui.ux3.NotificationBarStatus): sap.ui.ux3.NotificationBar;
}
/**
* This entries are used to set the visibility status of a NotificationBar
*/
export enum NotificationBarStatus {
/**
* Default height for the bar
*/
Default = "Default",
/**
* Bar should be maximized
*/
Max = "Max",
/**
* Bar should be minimized
*/
Min = "Min",
/**
* Bar should not be visible
*/
None = "None",
}
/**
* This element can be docked to a notification bar to show notification items
*/
export class Notifier extends sap.ui.core.Element {
/**
* Constructor for a new Notifier.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some message to the aggregation {@link #getMessages messages}.
* @param {sap.ui.core.Message} oMessage - the message to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.Notifier} Reference to this
in order to allow method chaining
*/
public addMessage(oMessage: sap.ui.core.Message): sap.ui.ux3.Notifier;
/**
* Attaches event handler fnFunction
to the {@link #event:messageSelected messageSelected} event of this sap.ui.ux3.Notifier
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Notifier
itself.
*
* Event is fired when a message of the notifiers was selected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Notifier
itself
* @returns {sap.ui.ux3.Notifier} Reference to this
in order to allow method chaining
*/
public attachMessageSelected(fnFunction: Function, oListener?: any): sap.ui.ux3.Notifier;
/**
* Attaches event handler fnFunction
to the {@link #event:messageSelected messageSelected} event of this sap.ui.ux3.Notifier
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Notifier
itself.
*
* Event is fired when a message of the notifiers was selected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Notifier
itself
* @returns {sap.ui.ux3.Notifier} Reference to this
in order to allow method chaining
*/
public attachMessageSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Notifier;
/**
* Destroys all the messages in the aggregation {@link #getMessages messages}.
* @returns {sap.ui.ux3.Notifier} Reference to this
in order to allow method chaining
*/
public destroyMessages(): sap.ui.ux3.Notifier;
/**
* Detaches event handler fnFunction
from the {@link #event:messageSelected messageSelected} event of this sap.ui.ux3.Notifier
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Notifier} Reference to this
in order to allow method chaining
*/
public detachMessageSelected(fnFunction: Function, oListener: any): sap.ui.ux3.Notifier;
/**
* Creates a new subclass of class sap.ui.ux3.Notifier with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:messageSelected messageSelected} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Notifier} Reference to this
in order to allow method chaining
*/
protected fireMessageSelected(mParameters?: any): sap.ui.ux3.Notifier;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Icon of the control that should be displayed within the corresponding bar
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets content of aggregation {@link #getMessages messages}.
*
* Messages of this notifier.
* @returns {sap.ui.core.Message[]}
*/
public getMessages(): sap.ui.core.Message[];
/**
* Returns a metadata object for class sap.ui.ux3.Notifier.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTitle title}.
*
* Defines the title that should be displayed within the opening popup
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* This method checks if the notifier has any items.
* @returns {boolean}
*/
public hasItems(): boolean;
/**
* Checks for the provided sap.ui.core.Message
in the aggregation {@link #getMessages messages}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Message} oMessage - The message whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfMessage(oMessage: sap.ui.core.Message): number;
/**
* Inserts a message into the aggregation {@link #getMessages messages}.
* @param {sap.ui.core.Message} oMessage - the message to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the message should be inserted at; for a negative value of iIndex
, the message is inserted at position 0; for a value greater than the current size of the aggregation, the message is inserted at the last position
* @returns {sap.ui.ux3.Notifier} Reference to this
in order to allow method chaining
*/
public insertMessage(oMessage: sap.ui.core.Message, iIndex: number): sap.ui.ux3.Notifier;
/**
* Removes all the controls from the aggregation {@link #getMessages messages}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Message[]} An array of the removed elements (might be empty)
*/
public removeAllMessages(): sap.ui.core.Message[];
/**
* Removes a message from the aggregation {@link #getMessages messages}.
* @param {number|string|sap.ui.core.Message} vMessage - The message to remove or its index or id
* @returns {sap.ui.core.Message} The removed message or null
*/
public removeMessage(vMessage: number|string|sap.ui.core.Message): sap.ui.core.Message;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Icon of the control that should be displayed within the corresponding bar
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.ux3.Notifier} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.ux3.Notifier;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Defines the title that should be displayed within the opening popup
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.ux3.Notifier} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.ux3.Notifier;
}
/**
* Overlay Control
*/
export class Overlay extends sap.ui.core.Control {
/**
* Constructor for a new Overlay.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:close close} event of this sap.ui.ux3.Overlay
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Overlay
itself.
*
* Event is fired when the Overlay starts closing.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Overlay
itself
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
public attachClose(fnFunction: Function, oListener?: any): sap.ui.ux3.Overlay;
/**
* Attaches event handler fnFunction
to the {@link #event:close close} event of this sap.ui.ux3.Overlay
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Overlay
itself.
*
* Event is fired when the Overlay starts closing.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Overlay
itself
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
public attachClose(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Overlay;
/**
* Attaches event handler fnFunction
to the {@link #event:closed closed} event of this sap.ui.ux3.Overlay
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Overlay
itself.
*
* Event is fired when the Overlay is closed.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Overlay
itself
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
public attachClosed(fnFunction: Function, oListener?: any): sap.ui.ux3.Overlay;
/**
* Attaches event handler fnFunction
to the {@link #event:closed closed} event of this sap.ui.ux3.Overlay
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Overlay
itself.
*
* Event is fired when the Overlay is closed.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Overlay
itself
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
public attachClosed(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Overlay;
/**
* Attaches event handler fnFunction
to the {@link #event:open open} event of this sap.ui.ux3.Overlay
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Overlay
itself.
*
* Event is fired when the Overlay is opened.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Overlay
itself
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
public attachOpen(fnFunction: Function, oListener?: any): sap.ui.ux3.Overlay;
/**
* Attaches event handler fnFunction
to the {@link #event:open open} event of this sap.ui.ux3.Overlay
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Overlay
itself.
*
* Event is fired when the Overlay is opened.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Overlay
itself
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
public attachOpen(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Overlay;
/**
* Attaches event handler fnFunction
to the {@link #event:openNew openNew} event of this sap.ui.ux3.Overlay
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Overlay
itself.
*
* Event is fired when the 'Open' button of the Overlay is clicked.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Overlay
itself
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
public attachOpenNew(fnFunction: Function, oListener?: any): sap.ui.ux3.Overlay;
/**
* Attaches event handler fnFunction
to the {@link #event:openNew openNew} event of this sap.ui.ux3.Overlay
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Overlay
itself.
*
* Event is fired when the 'Open' button of the Overlay is clicked.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Overlay
itself
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
public attachOpenNew(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Overlay;
/**
* Closes the Overlay.
*/
public close(): void;
/**
* Detaches event handler fnFunction
from the {@link #event:close close} event of this sap.ui.ux3.Overlay
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
public detachClose(fnFunction: Function, oListener: any): sap.ui.ux3.Overlay;
/**
* Detaches event handler fnFunction
from the {@link #event:closed closed} event of this sap.ui.ux3.Overlay
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
public detachClosed(fnFunction: Function, oListener: any): sap.ui.ux3.Overlay;
/**
* Detaches event handler fnFunction
from the {@link #event:open open} event of this sap.ui.ux3.Overlay
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
public detachOpen(fnFunction: Function, oListener: any): sap.ui.ux3.Overlay;
/**
* Detaches event handler fnFunction
from the {@link #event:openNew openNew} event of this sap.ui.ux3.Overlay
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
public detachOpenNew(fnFunction: Function, oListener: any): sap.ui.ux3.Overlay;
/**
* Creates a new subclass of class sap.ui.ux3.Overlay with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:close close} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireClose(mParameters?: any): boolean;
/**
* Fires event {@link #event:closed closed} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireClosed(mParameters?: any): boolean;
/**
* Fires event {@link #event:open open} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
protected fireOpen(mParameters?: any): sap.ui.ux3.Overlay;
/**
* Fires event {@link #event:openNew openNew} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
protected fireOpenNew(mParameters?: any): sap.ui.ux3.Overlay;
/**
* Gets current value of property {@link #getCloseButtonVisible closeButtonVisible}.
*
* Defines whether the 'Close' button shall be visible.
*
* Default value is true
.
* @returns {boolean} Value of property closeButtonVisible
*/
public getCloseButtonVisible(): boolean;
/**
* Returns a metadata object for class sap.ui.ux3.Overlay.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getOpenButtonVisible openButtonVisible}.
*
* Defines whether the 'Open' button shall be visible.
*
* Default value is true
.
* @returns {boolean} Value of property openButtonVisible
*/
public getOpenButtonVisible(): boolean;
/**
* Checks whether Overlay is open.
* @returns {boolean}
*/
public isOpen(): boolean;
/**
* Opens the Overlay.
* @param {string} initialFocusId - ID of the control that gets focused when the overlay is openend
*/
public open(initialFocusId: string): void;
/**
* Sets a new value for property {@link #getCloseButtonVisible closeButtonVisible}.
*
* Defines whether the 'Close' button shall be visible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bCloseButtonVisible - New value for property closeButtonVisible
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
public setCloseButtonVisible(bCloseButtonVisible: boolean): sap.ui.ux3.Overlay;
/**
* Sets a new value for property {@link #getOpenButtonVisible openButtonVisible}.
*
* Defines whether the 'Open' button shall be visible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bOpenButtonVisible - New value for property openButtonVisible
* @returns {sap.ui.ux3.Overlay} Reference to this
in order to allow method chaining
*/
public setOpenButtonVisible(bOpenButtonVisible: boolean): sap.ui.ux3.Overlay;
}
/**
* Is to be embedded into the Overlay control as content container
*/
export class OverlayContainer extends sap.ui.ux3.Overlay {
/**
* Constructor for a new OverlayContainer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.OverlayContainer} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.ux3.OverlayContainer;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.ux3.OverlayContainer} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.ux3.OverlayContainer;
/**
* Creates a new subclass of class sap.ui.ux3.OverlayContainer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.ux3.Overlay.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Aggregation for content
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.ui.ux3.OverlayContainer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.ux3.OverlayContainer} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.ux3.OverlayContainer;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
}
/**
* Dialog implementation based on the Overlay. If used in a Shell it leaves the Tool-Palette, Pane-Bar and Header-Items accessible.
*/
export class OverlayDialog extends sap.ui.ux3.Overlay {
/**
* Constructor for a new OverlayDialog.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given.
* @param {any} mSettings - Initial settings for the new control.
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.OverlayDialog} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.ux3.OverlayDialog;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.ux3.OverlayDialog} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.ux3.OverlayDialog;
/**
* Creates a new subclass of class sap.ui.ux3.OverlayDialog with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.ux3.Overlay.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Content for the OverlayDialog.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getHeight height}.
*
* Determines the height of the Overlay Dialog. If the height is set to "auto" it is always 50% of the overlay height.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.ux3.OverlayDialog.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getWidth width}.
*
* Determines the width of the Overlay Dialog. If the width is set to "auto" it is always 50% of the overlay width.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.ux3.OverlayDialog} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.ux3.OverlayDialog;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* The height for the OverlayDialog.
* @param {sap.ui.core.CSSSize} sHeight
*/
public setHeight(sHeight: sap.ui.core.CSSSize): void;
/**
* This Method is not supported for the OverlayDialog.
* @param {boolean} bVisible
* @returns {sap.ui.ux3.OverlayDialog}
*/
public setOpenButtonVisible(bVisible: boolean): sap.ui.ux3.OverlayDialog;
/**
* The width for the OverlayDialog.
* @param {sap.ui.core.CSSSize} sWidth
*/
public setWidth(sWidth: sap.ui.core.CSSSize): void;
}
/**
* QuickView is a small popup with a short overview of a Thing.
* QuickView is shown when a user holds the mouse pointer over a related screen element.
*/
export class QuickView extends sap.ui.commons.CalloutBase {
/**
* Constructor for a new QuickView.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some action to the aggregation {@link #getActions actions}.
* @param {sap.ui.ux3.ThingAction} oAction - the action to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public addAction(oAction: sap.ui.ux3.ThingAction): sap.ui.ux3.QuickView;
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Element} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Element): sap.ui.ux3.QuickView;
/**
* Attaches event handler fnFunction
to the {@link #event:actionSelected actionSelected} event of this sap.ui.ux3.QuickView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.QuickView
itself.
*
* Action is selected in Action Bar
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.QuickView
itself
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public attachActionSelected(fnFunction: Function, oListener?: any): sap.ui.ux3.QuickView;
/**
* Attaches event handler fnFunction
to the {@link #event:actionSelected actionSelected} event of this sap.ui.ux3.QuickView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.QuickView
itself.
*
* Action is selected in Action Bar
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.QuickView
itself
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public attachActionSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.QuickView;
/**
* Attaches event handler fnFunction
to the {@link #event:feedSubmit feedSubmit} event of this sap.ui.ux3.QuickView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.QuickView
itself.
*
* Fired when a new feed entry is submitted.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.QuickView
itself
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public attachFeedSubmit(fnFunction: Function, oListener?: any): sap.ui.ux3.QuickView;
/**
* Attaches event handler fnFunction
to the {@link #event:feedSubmit feedSubmit} event of this sap.ui.ux3.QuickView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.QuickView
itself.
*
* Fired when a new feed entry is submitted.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.QuickView
itself
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public attachFeedSubmit(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.QuickView;
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.ui.ux3.QuickView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.QuickView
itself.
*
* Event is fired when a user clicks on the firstTitle link. Call the preventDefault method of the event object to cancel browser navigation.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.QuickView
itself
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public attachNavigate(fnFunction: Function, oListener?: any): sap.ui.ux3.QuickView;
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.ui.ux3.QuickView
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.QuickView
itself.
*
* Event is fired when a user clicks on the firstTitle link. Call the preventDefault method of the event object to cancel browser navigation.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.QuickView
itself
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public attachNavigate(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.QuickView;
/**
* Destroys the actionBar in the aggregation {@link #getActionBar actionBar}.
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public destroyActionBar(): sap.ui.ux3.QuickView;
/**
* Destroys all the actions in the aggregation {@link #getActions actions}.
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public destroyActions(): sap.ui.ux3.QuickView;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.ux3.QuickView;
/**
* Detaches event handler fnFunction
from the {@link #event:actionSelected actionSelected} event of this sap.ui.ux3.QuickView
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public detachActionSelected(fnFunction: Function, oListener: any): sap.ui.ux3.QuickView;
/**
* Detaches event handler fnFunction
from the {@link #event:feedSubmit feedSubmit} event of this sap.ui.ux3.QuickView
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public detachFeedSubmit(fnFunction: Function, oListener: any): sap.ui.ux3.QuickView;
/**
* Detaches event handler fnFunction
from the {@link #event:navigate navigate} event of this sap.ui.ux3.QuickView
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public detachNavigate(fnFunction: Function, oListener: any): sap.ui.ux3.QuickView;
/**
* Creates a new subclass of class sap.ui.ux3.QuickView with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.commons.CalloutBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:actionSelected actionSelected} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
protected fireActionSelected(mParameters?: any): sap.ui.ux3.QuickView;
/**
* Fires event {@link #event:feedSubmit feedSubmit} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
protected fireFeedSubmit(mParameters?: any): sap.ui.ux3.QuickView;
/**
* Fires event {@link #event:navigate navigate} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireNavigate(mParameters?: any): boolean;
/**
* Gets content of aggregation {@link #getActionBar actionBar}.
*
* ActionBar. If no actionBar is set a default ActionBar will be created.
* In any case, ActionBar is displayed only when the showActionBar property is set to true.
* @returns {sap.ui.ux3.ActionBar}
*/
public getActionBar(): sap.ui.ux3.ActionBar;
/**
* Gets content of aggregation {@link #getActions actions}.
*
* Actions of a Thing
* @returns {sap.ui.ux3.ThingAction[]}
*/
public getActions(): sap.ui.ux3.ThingAction[];
/**
* Gets content of aggregation {@link #getContent content}.
*
* Body content of the QuickView
* @returns {sap.ui.core.Element[]}
*/
public getContent(): sap.ui.core.Element[];
/**
* Gets current value of property {@link #getFavoriteActionEnabled favoriteActionEnabled}.
*
* Favorite action enabled/disabled. If disabled the action will be invisible.
*
* Default value is true
.
* @returns {boolean} Value of property favoriteActionEnabled
*/
public getFavoriteActionEnabled(): boolean;
/**
* Gets current value of property {@link #getFavoriteState favoriteState}.
*
* State Of favorite Action
*
* Default value is false
.
* @returns {boolean} Value of property favoriteState
*/
public getFavoriteState(): boolean;
/**
* Gets current value of property {@link #getFirstTitle firstTitle}.
*
* Thing name shown in the header of the QuickView
* @returns {string} Value of property firstTitle
*/
public getFirstTitle(): string;
/**
* Gets current value of property {@link #getFirstTitleHref firstTitleHref}.
*
* URI to Thing Inspector
* @returns {string} Value of property firstTitleHref
*/
public getFirstTitleHref(): string;
/**
* Gets current value of property {@link #getFlagActionEnabled flagActionEnabled}.
*
* Flag action enabled/disabled. If disabled the action will be invisible.
*
* Default value is true
.
* @returns {boolean} Value of property flagActionEnabled
*/
public getFlagActionEnabled(): boolean;
/**
* Gets current value of property {@link #getFlagState flagState}.
*
* State of Flag Action
*
* Default value is false
.
* @returns {boolean} Value of property flagState
*/
public getFlagState(): boolean;
/**
* Gets current value of property {@link #getFollowActionEnabled followActionEnabled}.
*
* Follow action enabled/disabled. If disabled the action will be invisible.
*
* Default value is true
.
* @returns {boolean} Value of property followActionEnabled
*/
public getFollowActionEnabled(): boolean;
/**
* Gets current value of property {@link #getFollowState followState}.
*
* Follow State of a Thing
*
* Default value is Default
.
* @returns {sap.ui.ux3.FollowActionState} Value of property followState
*/
public getFollowState(): sap.ui.ux3.FollowActionState;
/**
* Gets current value of property {@link #getIcon icon}.
*
* URI of the Thing icon image (mandatory). The image is scaled down to the maximal size of 32 pixel (vertical or horizontal).
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.ui.ux3.QuickView.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getOpenActionEnabled openActionEnabled}.
*
* Open Thing action enabled/disabled. If disabled the action will be invisible.
*
* Default value is true
.
* @returns {boolean} Value of property openActionEnabled
*/
public getOpenActionEnabled(): boolean;
/**
* Gets current value of property {@link #getSecondTitle secondTitle}.
*
* Optional short text shown under the firstTitle
* @returns {string} Value of property secondTitle
*/
public getSecondTitle(): string;
/**
* Gets current value of property {@link #getShowActionBar showActionBar}.
*
* Show Action Bar
*
* Default value is true
.
* @returns {boolean} Value of property showActionBar
*/
public getShowActionBar(): boolean;
/**
* Gets current value of property {@link #getType type}.
*
* Thing type (mandatory) like Account, Material, Employee etc. is displayed in a header at the top part of the QuickView.
* @returns {string} Value of property type
*/
public getType(): string;
/**
* Gets current value of property {@link #getUpdateActionEnabled updateActionEnabled}.
*
* Update action enabled/disabled. If disabled the action will be invisible.
*
* Default value is true
.
* @returns {boolean} Value of property updateActionEnabled
*/
public getUpdateActionEnabled(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* Control width as common CSS-size (px or % as unit, for example).
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.ux3.ThingAction
in the aggregation {@link #getActions actions}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.ThingAction} oAction - The action whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAction(oAction: sap.ui.ux3.ThingAction): number;
/**
* Checks for the provided sap.ui.core.Element
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Element} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Element): number;
/**
* Inserts a action into the aggregation {@link #getActions actions}.
* @param {sap.ui.ux3.ThingAction} oAction - the action to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the action should be inserted at; for a negative value of iIndex
, the action is inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted at the last position
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public insertAction(oAction: sap.ui.ux3.ThingAction, iIndex: number): sap.ui.ux3.QuickView;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Element} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Element, iIndex: number): sap.ui.ux3.QuickView;
/**
* Removes a action from the aggregation {@link #getActions actions}.
* @param {number|string|sap.ui.ux3.ThingAction} vAction - The action to remove or its index or id
* @returns {sap.ui.ux3.ThingAction} The removed action or null
*/
public removeAction(vAction: number|string|sap.ui.ux3.ThingAction): sap.ui.ux3.ThingAction;
/**
* Removes all the controls from the aggregation {@link #getActions actions}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.ThingAction[]} An array of the removed elements (might be empty)
*/
public removeAllActions(): sap.ui.ux3.ThingAction[];
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Element[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Element[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Element} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Element} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Element): sap.ui.core.Element;
/**
* Sets the aggregated {@link #getActionBar actionBar}.
* @param {sap.ui.ux3.ActionBar} oActionBar - The actionBar to set
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setActionBar(oActionBar: sap.ui.ux3.ActionBar): sap.ui.ux3.QuickView;
/**
* Sets a new value for property {@link #getFavoriteActionEnabled favoriteActionEnabled}.
*
* Favorite action enabled/disabled. If disabled the action will be invisible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bFavoriteActionEnabled - New value for property favoriteActionEnabled
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setFavoriteActionEnabled(bFavoriteActionEnabled: boolean): sap.ui.ux3.QuickView;
/**
* Sets a new value for property {@link #getFavoriteState favoriteState}.
*
* State Of favorite Action
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bFavoriteState - New value for property favoriteState
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setFavoriteState(bFavoriteState: boolean): sap.ui.ux3.QuickView;
/**
* Sets a new value for property {@link #getFirstTitle firstTitle}.
*
* Thing name shown in the header of the QuickView
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sFirstTitle - New value for property firstTitle
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setFirstTitle(sFirstTitle: string): sap.ui.ux3.QuickView;
/**
* Sets a new value for property {@link #getFirstTitleHref firstTitleHref}.
*
* URI to Thing Inspector
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sFirstTitleHref - New value for property firstTitleHref
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setFirstTitleHref(sFirstTitleHref: string): sap.ui.ux3.QuickView;
/**
* Sets a new value for property {@link #getFlagActionEnabled flagActionEnabled}.
*
* Flag action enabled/disabled. If disabled the action will be invisible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bFlagActionEnabled - New value for property flagActionEnabled
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setFlagActionEnabled(bFlagActionEnabled: boolean): sap.ui.ux3.QuickView;
/**
* Sets a new value for property {@link #getFlagState flagState}.
*
* State of Flag Action
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bFlagState - New value for property flagState
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setFlagState(bFlagState: boolean): sap.ui.ux3.QuickView;
/**
* Sets a new value for property {@link #getFollowActionEnabled followActionEnabled}.
*
* Follow action enabled/disabled. If disabled the action will be invisible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bFollowActionEnabled - New value for property followActionEnabled
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setFollowActionEnabled(bFollowActionEnabled: boolean): sap.ui.ux3.QuickView;
/**
* Sets a new value for property {@link #getFollowState followState}.
*
* Follow State of a Thing
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Default
.
* @param {sap.ui.ux3.FollowActionState} sFollowState - New value for property followState
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setFollowState(sFollowState: sap.ui.ux3.FollowActionState): sap.ui.ux3.QuickView;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* URI of the Thing icon image (mandatory). The image is scaled down to the maximal size of 32 pixel (vertical or horizontal).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.ux3.QuickView;
/**
* Sets a new value for property {@link #getOpenActionEnabled openActionEnabled}.
*
* Open Thing action enabled/disabled. If disabled the action will be invisible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bOpenActionEnabled - New value for property openActionEnabled
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setOpenActionEnabled(bOpenActionEnabled: boolean): sap.ui.ux3.QuickView;
/**
* Sets a new value for property {@link #getSecondTitle secondTitle}.
*
* Optional short text shown under the firstTitle
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sSecondTitle - New value for property secondTitle
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setSecondTitle(sSecondTitle: string): sap.ui.ux3.QuickView;
/**
* Sets a new value for property {@link #getShowActionBar showActionBar}.
*
* Show Action Bar
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowActionBar - New value for property showActionBar
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setShowActionBar(bShowActionBar: boolean): sap.ui.ux3.QuickView;
/**
* Sets a new value for property {@link #getType type}.
*
* Thing type (mandatory) like Account, Material, Employee etc. is displayed in a header at the top part of the QuickView.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sType - New value for property type
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setType(sType: string): sap.ui.ux3.QuickView;
/**
* Sets a new value for property {@link #getUpdateActionEnabled updateActionEnabled}.
*
* Update action enabled/disabled. If disabled the action will be invisible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bUpdateActionEnabled - New value for property updateActionEnabled
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setUpdateActionEnabled(bUpdateActionEnabled: boolean): sap.ui.ux3.QuickView;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Control width as common CSS-size (px or % as unit, for example).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.ux3.QuickView} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.ux3.QuickView;
}
/**
* The Ux3 GoldReflection Shell, which is an application frame with navigation capabilities.
* It is supposed to be added to a direct child of the BODY tag of a page and there should be no other parts of the page consuming space outside the Shell.
*/
export class Shell extends sap.ui.core.Control {
/**
* Constructor for a new Shell.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.ux3.Shell;
/**
* Adds some headerItem to the aggregation {@link #getHeaderItems headerItems}.
* @param {sap.ui.core.Control} oHeaderItem - the headerItem to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public addHeaderItem(oHeaderItem: sap.ui.core.Control): sap.ui.ux3.Shell;
/**
* Adds some paneBarItem to the aggregation {@link #getPaneBarItems paneBarItems}.
* @param {sap.ui.core.Item} oPaneBarItem - the paneBarItem to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public addPaneBarItem(oPaneBarItem: sap.ui.core.Item): sap.ui.ux3.Shell;
/**
* Adds some paneContent to the aggregation {@link #getPaneContent paneContent}.
* @param {sap.ui.core.Control} oPaneContent - the paneContent to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public addPaneContent(oPaneContent: sap.ui.core.Control): sap.ui.ux3.Shell;
/**
* Adds some toolPopup to the aggregation {@link #getToolPopups toolPopups}.
* @param {sap.ui.ux3.ToolPopup} oToolPopup - the toolPopup to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public addToolPopup(oToolPopup: sap.ui.ux3.ToolPopup): sap.ui.ux3.Shell;
/**
* Adds some worksetItem to the aggregation {@link #getWorksetItems worksetItems}.
* @param {sap.ui.ux3.NavigationItem} oWorksetItem - the worksetItem to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public addWorksetItem(oWorksetItem: sap.ui.ux3.NavigationItem): sap.ui.ux3.Shell;
/**
* Attaches event handler fnFunction
to the {@link #event:feedSubmit feedSubmit} event of this sap.ui.ux3.Shell
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Shell
itself.
*
* Fired when a new feed entry is submitted.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell
itself
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public attachFeedSubmit(fnFunction: Function, oListener?: any): sap.ui.ux3.Shell;
/**
* Attaches event handler fnFunction
to the {@link #event:feedSubmit feedSubmit} event of this sap.ui.ux3.Shell
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Shell
itself.
*
* Fired when a new feed entry is submitted.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell
itself
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public attachFeedSubmit(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Shell;
/**
* Attaches event handler fnFunction
to the {@link #event:logout logout} event of this sap.ui.ux3.Shell
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Shell
itself.
*
* Fired when the user clicks the "Log-off" button
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell
itself
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public attachLogout(fnFunction: Function, oListener?: any): sap.ui.ux3.Shell;
/**
* Attaches event handler fnFunction
to the {@link #event:logout logout} event of this sap.ui.ux3.Shell
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Shell
itself.
*
* Fired when the user clicks the "Log-off" button
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell
itself
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public attachLogout(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Shell;
/**
* Attaches event handler fnFunction
to the {@link #event:paneBarItemSelected paneBarItemSelected} event of this sap.ui.ux3.Shell
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Shell
itself.
*
* An item in the right-hand-side pane bar has been selected, the pane is now visible and can be filled with UI elements.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell
itself
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public attachPaneBarItemSelected(fnFunction: Function, oListener?: any): sap.ui.ux3.Shell;
/**
* Attaches event handler fnFunction
to the {@link #event:paneBarItemSelected paneBarItemSelected} event of this sap.ui.ux3.Shell
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Shell
itself.
*
* An item in the right-hand-side pane bar has been selected, the pane is now visible and can be filled with UI elements.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell
itself
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public attachPaneBarItemSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Shell;
/**
* Attaches event handler fnFunction
to the {@link #event:paneClosed paneClosed} event of this sap.ui.ux3.Shell
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Shell
itself.
*
* Fired after a side pane of the shell is closed. It is also fired, when an open pane is closed by calling setShowPane(false), if and only if the pane was opened before.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell
itself
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public attachPaneClosed(fnFunction: Function, oListener?: any): sap.ui.ux3.Shell;
/**
* Attaches event handler fnFunction
to the {@link #event:paneClosed paneClosed} event of this sap.ui.ux3.Shell
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Shell
itself.
*
* Fired after a side pane of the shell is closed. It is also fired, when an open pane is closed by calling setShowPane(false), if and only if the pane was opened before.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell
itself
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public attachPaneClosed(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Shell;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.ui.ux3.Shell
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Shell
itself.
*
* Fired when search has been triggered.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell
itself
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public attachSearch(fnFunction: Function, oListener?: any): sap.ui.ux3.Shell;
/**
* Attaches event handler fnFunction
to the {@link #event:search search} event of this sap.ui.ux3.Shell
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Shell
itself.
*
* Fired when search has been triggered.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell
itself
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public attachSearch(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Shell;
/**
* Attaches event handler fnFunction
to the {@link #event:worksetItemSelected worksetItemSelected} event of this sap.ui.ux3.Shell
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Shell
itself.
*
* Fired when a workset item was selected by the user. The application may populate the sub-items of the given workset item in the event handler, but this must happen synchronously. If this is done, the application is responsible for displaying the correct content for the selected one of the newly created sub-items. The Shell will currently always mark the first sub-item as selected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell
itself
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public attachWorksetItemSelected(fnFunction: Function, oListener?: any): sap.ui.ux3.Shell;
/**
* Attaches event handler fnFunction
to the {@link #event:worksetItemSelected worksetItemSelected} event of this sap.ui.ux3.Shell
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.Shell
itself.
*
* Fired when a workset item was selected by the user. The application may populate the sub-items of the given workset item in the event handler, but this must happen synchronously. If this is done, the application is responsible for displaying the correct content for the selected one of the newly created sub-items. The Shell will currently always mark the first sub-item as selected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.Shell
itself
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public attachWorksetItemSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.Shell;
/**
* Closes the side Pane (if open).
*
* Returns 'this' to allow method chaining.
* @returns {sap.ui.ux3.Shell}
*/
public closePane(): sap.ui.ux3.Shell;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.ux3.Shell;
/**
* Destroys all the headerItems in the aggregation {@link #getHeaderItems headerItems}.
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public destroyHeaderItems(): sap.ui.ux3.Shell;
/**
* Destroys the notificationBar in the aggregation {@link #getNotificationBar notificationBar}.
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public destroyNotificationBar(): sap.ui.ux3.Shell;
/**
* Destroys all the paneBarItems in the aggregation {@link #getPaneBarItems paneBarItems}.
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public destroyPaneBarItems(): sap.ui.ux3.Shell;
/**
* Destroys all the paneContent in the aggregation {@link #getPaneContent paneContent}.
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public destroyPaneContent(): sap.ui.ux3.Shell;
/**
* Destroys all the toolPopups in the aggregation {@link #getToolPopups toolPopups}.
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public destroyToolPopups(): sap.ui.ux3.Shell;
/**
* Destroys all the worksetItems in the aggregation {@link #getWorksetItems worksetItems}.
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public destroyWorksetItems(): sap.ui.ux3.Shell;
/**
* Detaches event handler fnFunction
from the {@link #event:feedSubmit feedSubmit} event of this sap.ui.ux3.Shell
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public detachFeedSubmit(fnFunction: Function, oListener: any): sap.ui.ux3.Shell;
/**
* Detaches event handler fnFunction
from the {@link #event:logout logout} event of this sap.ui.ux3.Shell
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public detachLogout(fnFunction: Function, oListener: any): sap.ui.ux3.Shell;
/**
* Detaches event handler fnFunction
from the {@link #event:paneBarItemSelected paneBarItemSelected} event of this sap.ui.ux3.Shell
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public detachPaneBarItemSelected(fnFunction: Function, oListener: any): sap.ui.ux3.Shell;
/**
* Detaches event handler fnFunction
from the {@link #event:paneClosed paneClosed} event of this sap.ui.ux3.Shell
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public detachPaneClosed(fnFunction: Function, oListener: any): sap.ui.ux3.Shell;
/**
* Detaches event handler fnFunction
from the {@link #event:search search} event of this sap.ui.ux3.Shell
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public detachSearch(fnFunction: Function, oListener: any): sap.ui.ux3.Shell;
/**
* Detaches event handler fnFunction
from the {@link #event:worksetItemSelected worksetItemSelected} event of this sap.ui.ux3.Shell
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public detachWorksetItemSelected(fnFunction: Function, oListener: any): sap.ui.ux3.Shell;
/**
* Creates a new subclass of class sap.ui.ux3.Shell with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:feedSubmit feedSubmit} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
protected fireFeedSubmit(mParameters?: any): sap.ui.ux3.Shell;
/**
* Fires event {@link #event:logout logout} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
protected fireLogout(mParameters?: any): sap.ui.ux3.Shell;
/**
* Fires event {@link #event:paneBarItemSelected paneBarItemSelected} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
protected firePaneBarItemSelected(mParameters?: any): sap.ui.ux3.Shell;
/**
* Fires event {@link #event:paneClosed paneClosed} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
protected firePaneClosed(mParameters?: any): sap.ui.ux3.Shell;
/**
* Fires event {@link #event:search search} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
protected fireSearch(mParameters?: any): sap.ui.ux3.Shell;
/**
* Fires event {@link #event:worksetItemSelected worksetItemSelected} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireWorksetItemSelected(mParameters?: any): boolean;
/**
* Gets current value of property {@link #getAllowOverlayHeaderAccess allowOverlayHeaderAccess}.
*
* Whether the Shell header (Title Area + Header Items) can be accessed when an Overlay, OverlayContainer or ThingInspector is open.
*
* Default value is false
.
* @returns {boolean} Value of property allowOverlayHeaderAccess
*/
public getAllowOverlayHeaderAccess(): boolean;
/**
* Gets current value of property {@link #getAppIcon appIcon}.
*
* The URL of the image to appear in the left part of the header, usually a branding image containing a logo and/or product name. appIcon and appTitle are both optional and can both be set; in this case the icon appears first.
* If the appIcon is set, for accessibility reasons the appIconTooltip must also be set.
* @returns {sap.ui.core.URI} Value of property appIcon
*/
public getAppIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getAppIconTooltip appIconTooltip}.
*
* The tooltip of the application icon in the header
* @returns {string} Value of property appIconTooltip
*/
public getAppIconTooltip(): string;
/**
* Gets current value of property {@link #getApplyContentPadding applyContentPadding}.
*
* Whether the Shell content area should have a theme-dependent padding or not.
*
* Default value is true
.
* @returns {boolean} Value of property applyContentPadding
*/
public getApplyContentPadding(): boolean;
/**
* Gets current value of property {@link #getAppTitle appTitle}.
*
* The application title to appear in the left part of the header, usually a company and/or product name. appIcon and appTitle are both optional and can both be set; in this case the icon appears first.
* @returns {string} Value of property appTitle
*/
public getAppTitle(): string;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The content to appear in the main canvas. Each modification of this aggregation leads to a re-rendering of the content area - but not to a re-rendering of the complete Shell.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getDesignType designType}.
*
* Defines which design type is to be used.
*
* Default value is Standard
.
* @returns {sap.ui.ux3.ShellDesignType} Value of property designType
*/
public getDesignType(): sap.ui.ux3.ShellDesignType;
/**
* Gets current value of property {@link #getFullHeightContent fullHeightContent}.
*
* If set to true, the content area has a defined height. This means that any content put inside can use "100%" height in CSS and will then consume all available space.
* However, if content is larger, scrollbars will appear at the content area of the Shell and not on window level.
*
* Default value is false
.
* @returns {boolean} Value of property fullHeightContent
*/
public getFullHeightContent(): boolean;
/**
* Gets content of aggregation {@link #getHeaderItems headerItems}.
*
* Controls to appear in the header next to the logout button. It is recommended to only use controls of type Button, MenuButton and TextView.
* The respective UI guidelines need to be enforced on a higher level.
* @returns {sap.ui.core.Control[]}
*/
public getHeaderItems(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getHeaderType headerType}.
*
* Defines which header type to be used. Depending on the header type some other functionality might be obsolete.
*
* Default value is Standard
.
* @returns {sap.ui.ux3.ShellHeaderType} Value of property headerType
*/
public getHeaderType(): sap.ui.ux3.ShellHeaderType;
/**
* Gets current value of property {@link #getLogoutButtonTooltip logoutButtonTooltip}.
*
* The tooltip to be displayed for the Logout Button of the Shell. If not set, a text meaning "Logout" in the current language will be displayed.
* @returns {string} Value of property logoutButtonTooltip
*/
public getLogoutButtonTooltip(): string;
/**
* Returns a metadata object for class sap.ui.ux3.Shell.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getNotificationBar notificationBar}.
*
* The NotificationBar which should be integrated into the Shell.
* @returns {sap.ui.ux3.NotificationBar}
*/
public getNotificationBar(): sap.ui.ux3.NotificationBar;
/**
* Gets content of aggregation {@link #getPaneBarItems paneBarItems}.
*
* The items to appear in the PaneBar.
* @returns {sap.ui.core.Item[]}
*/
public getPaneBarItems(): sap.ui.core.Item[];
/**
* Gets content of aggregation {@link #getPaneContent paneContent}.
*
* The content to appear in the pane area.
* @returns {sap.ui.core.Control[]}
*/
public getPaneContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getPaneWidth paneWidth}.
*
* The width of the right-hand side pane in pixels. The value must be a non-negative integer. The Shell reserves the right to define a minimum width (currently 50px).
*
* Default value is 250
.
* @returns {number} Value of property paneWidth
*/
public getPaneWidth(): number;
/**
* Returns the SearchField control which is used in the Search Tool.
* @returns {sap.ui.commons.SearchField}
*/
public getSearchField(): sap.ui.commons.SearchField;
/**
* ID of the element which is the current target of the association {@link #getSelectedWorksetItem selectedWorksetItem}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedWorksetItem(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getShowFeederTool showFeederTool}.
*
* Whether the "Feeder" tool should be displayed or not.
*
* Default value is true
.
* @returns {boolean} Value of property showFeederTool
*/
public getShowFeederTool(): boolean;
/**
* Gets current value of property {@link #getShowInspectorTool showInspectorTool}.
*
* Whether the "Inspector" tool should be displayed or not.
*
* Default value is false
.
* @returns {boolean} Value of property showInspectorTool
*/
public getShowInspectorTool(): boolean;
/**
* Gets current value of property {@link #getShowLogoutButton showLogoutButton}.
*
* Whether the Logoff button in the header should be displayed or not.
*
* Default value is true
.
* @returns {boolean} Value of property showLogoutButton
*/
public getShowLogoutButton(): boolean;
/**
* Gets current value of property {@link #getShowPane showPane}.
*
* Whether the pane bar should be displayed at all or not.
*
* Default value is true
.
* @returns {boolean} Value of property showPane
*/
public getShowPane(): boolean;
/**
* Gets current value of property {@link #getShowSearchTool showSearchTool}.
*
* Whether the "Global Search" tool should be displayed or not.
*
* Default value is true
.
* @returns {boolean} Value of property showSearchTool
*/
public getShowSearchTool(): boolean;
/**
* Gets current value of property {@link #getShowTools showTools}.
*
* Whether the tool area should be displayed at all or not.
*
* Default value is true
.
* @returns {boolean} Value of property showTools
*/
public getShowTools(): boolean;
/**
* Gets content of aggregation {@link #getToolPopups toolPopups}.
*
* The items which appear in the ToolPalette and are opened as popup when clicked.
* @returns {sap.ui.ux3.ToolPopup[]}
*/
public getToolPopups(): sap.ui.ux3.ToolPopup[];
/**
* Gets content of aggregation {@link #getWorksetItems worksetItems}.
*
* The workset items.
* @returns {sap.ui.ux3.NavigationItem[]}
*/
public getWorksetItems(): sap.ui.ux3.NavigationItem[];
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getHeaderItems headerItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oHeaderItem - The headerItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfHeaderItem(oHeaderItem: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Item
in the aggregation {@link #getPaneBarItems paneBarItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Item} oPaneBarItem - The paneBarItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfPaneBarItem(oPaneBarItem: sap.ui.core.Item): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getPaneContent paneContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oPaneContent - The paneContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfPaneContent(oPaneContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.ux3.ToolPopup
in the aggregation {@link #getToolPopups toolPopups}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.ToolPopup} oToolPopup - The toolPopup whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfToolPopup(oToolPopup: sap.ui.ux3.ToolPopup): number;
/**
* Checks for the provided sap.ui.ux3.NavigationItem
in the aggregation {@link #getWorksetItems worksetItems}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.NavigationItem} oWorksetItem - The worksetItem whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfWorksetItem(oWorksetItem: sap.ui.ux3.NavigationItem): number;
/**
* Experimental method! Do not use!
*
* Makes Shell personalization available and injects the given personalization settings. This should be called before the user can do any adaptations per drag&drop or using the personalization dialog. Otherwise it may override the user's new settings.
* @param {any} oSettings - Personalization settings object
*/
public initializePersonalization(oSettings: any): void;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.ux3.Shell;
/**
* Inserts a headerItem into the aggregation {@link #getHeaderItems headerItems}.
* @param {sap.ui.core.Control} oHeaderItem - the headerItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the headerItem should be inserted at; for a negative value of iIndex
, the headerItem is inserted at position 0; for a value greater than the current size of the aggregation, the headerItem is inserted at the last position
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public insertHeaderItem(oHeaderItem: sap.ui.core.Control, iIndex: number): sap.ui.ux3.Shell;
/**
* Inserts a paneBarItem into the aggregation {@link #getPaneBarItems paneBarItems}.
* @param {sap.ui.core.Item} oPaneBarItem - the paneBarItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the paneBarItem should be inserted at; for a negative value of iIndex
, the paneBarItem is inserted at position 0; for a value greater than the current size of the aggregation, the paneBarItem is inserted at the last position
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public insertPaneBarItem(oPaneBarItem: sap.ui.core.Item, iIndex: number): sap.ui.ux3.Shell;
/**
* Inserts a paneContent into the aggregation {@link #getPaneContent paneContent}.
* @param {sap.ui.core.Control} oPaneContent - the paneContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the paneContent should be inserted at; for a negative value of iIndex
, the paneContent is inserted at position 0; for a value greater than the current size of the aggregation, the paneContent is inserted at the last position
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public insertPaneContent(oPaneContent: sap.ui.core.Control, iIndex: number): sap.ui.ux3.Shell;
/**
* Inserts a toolPopup into the aggregation {@link #getToolPopups toolPopups}.
* @param {sap.ui.ux3.ToolPopup} oToolPopup - the toolPopup to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the toolPopup should be inserted at; for a negative value of iIndex
, the toolPopup is inserted at position 0; for a value greater than the current size of the aggregation, the toolPopup is inserted at the last position
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public insertToolPopup(oToolPopup: sap.ui.ux3.ToolPopup, iIndex: number): sap.ui.ux3.Shell;
/**
* Inserts a worksetItem into the aggregation {@link #getWorksetItems worksetItems}.
* @param {sap.ui.ux3.NavigationItem} oWorksetItem - the worksetItem to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the worksetItem should be inserted at; for a negative value of iIndex
, the worksetItem is inserted at position 0; for a value greater than the current size of the aggregation, the worksetItem is inserted at the last position
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public insertWorksetItem(oWorksetItem: sap.ui.ux3.NavigationItem, iIndex: number): sap.ui.ux3.Shell;
/**
* Returns 'true' if the side Pane is currently open.
* @returns {boolean}
*/
public isPaneOpen(): boolean;
/**
* Opens the side Pane.
*
* A valid ID of a paneBarItem must be given, so this item can be marked as selected. A "paneBarItemSelected" event is then fired as if the opening was triggered by the user by a click on the respective PaneBarItem.
* This method can be called (with different IDs) even when the Pane is already open. It has then the same effect as if the user switches between PaneBarItems.
*
* Returns 'this' to allow method chaining.
* @param {string} sPaneBarItemId - The ID of the PaneBarItem which should be marked as selected.
* @returns {sap.ui.ux3.Shell}
*/
public openPane(sPaneBarItemId: string): sap.ui.ux3.Shell;
/**
* Experimental method! Do not use!
*/
public openPersonalizationDialog(): void;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getHeaderItems headerItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllHeaderItems(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getPaneBarItems paneBarItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Item[]} An array of the removed elements (might be empty)
*/
public removeAllPaneBarItems(): sap.ui.core.Item[];
/**
* Removes all the controls from the aggregation {@link #getPaneContent paneContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllPaneContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getToolPopups toolPopups}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.ToolPopup[]} An array of the removed elements (might be empty)
*/
public removeAllToolPopups(): sap.ui.ux3.ToolPopup[];
/**
* Removes all the controls from the aggregation {@link #getWorksetItems worksetItems}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.NavigationItem[]} An array of the removed elements (might be empty)
*/
public removeAllWorksetItems(): sap.ui.ux3.NavigationItem[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a headerItem from the aggregation {@link #getHeaderItems headerItems}.
* @param {number|string|sap.ui.core.Control} vHeaderItem - The headerItem to remove or its index or id
* @returns {sap.ui.core.Control} The removed headerItem or null
*/
public removeHeaderItem(vHeaderItem: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a paneBarItem from the aggregation {@link #getPaneBarItems paneBarItems}.
* @param {number|string|sap.ui.core.Item} vPaneBarItem - The paneBarItem to remove or its index or id
* @returns {sap.ui.core.Item} The removed paneBarItem or null
*/
public removePaneBarItem(vPaneBarItem: number|string|sap.ui.core.Item): sap.ui.core.Item;
/**
* Removes a paneContent from the aggregation {@link #getPaneContent paneContent}.
* @param {number|string|sap.ui.core.Control} vPaneContent - The paneContent to remove or its index or id
* @returns {sap.ui.core.Control} The removed paneContent or null
*/
public removePaneContent(vPaneContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a toolPopup from the aggregation {@link #getToolPopups toolPopups}.
* @param {number|string|sap.ui.ux3.ToolPopup} vToolPopup - The toolPopup to remove or its index or id
* @returns {sap.ui.ux3.ToolPopup} The removed toolPopup or null
*/
public removeToolPopup(vToolPopup: number|string|sap.ui.ux3.ToolPopup): sap.ui.ux3.ToolPopup;
/**
* Removes a worksetItem from the aggregation {@link #getWorksetItems worksetItems}.
* @param {number|string|sap.ui.ux3.NavigationItem} vWorksetItem - The worksetItem to remove or its index or id
* @returns {sap.ui.ux3.NavigationItem} The removed worksetItem or null
*/
public removeWorksetItem(vWorksetItem: number|string|sap.ui.ux3.NavigationItem): sap.ui.ux3.NavigationItem;
/**
* Sets a new value for property {@link #getAllowOverlayHeaderAccess allowOverlayHeaderAccess}.
*
* Whether the Shell header (Title Area + Header Items) can be accessed when an Overlay, OverlayContainer or ThingInspector is open.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bAllowOverlayHeaderAccess - New value for property allowOverlayHeaderAccess
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setAllowOverlayHeaderAccess(bAllowOverlayHeaderAccess: boolean): sap.ui.ux3.Shell;
/**
* Sets a new value for property {@link #getAppIcon appIcon}.
*
* The URL of the image to appear in the left part of the header, usually a branding image containing a logo and/or product name. appIcon and appTitle are both optional and can both be set; in this case the icon appears first.
* If the appIcon is set, for accessibility reasons the appIconTooltip must also be set.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sAppIcon - New value for property appIcon
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setAppIcon(sAppIcon: sap.ui.core.URI): sap.ui.ux3.Shell;
/**
* Sets a new value for property {@link #getAppIconTooltip appIconTooltip}.
*
* The tooltip of the application icon in the header
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAppIconTooltip - New value for property appIconTooltip
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setAppIconTooltip(sAppIconTooltip: string): sap.ui.ux3.Shell;
/**
* Sets a new value for property {@link #getApplyContentPadding applyContentPadding}.
*
* Whether the Shell content area should have a theme-dependent padding or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bApplyContentPadding - New value for property applyContentPadding
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setApplyContentPadding(bApplyContentPadding: boolean): sap.ui.ux3.Shell;
/**
* Sets a new value for property {@link #getAppTitle appTitle}.
*
* The application title to appear in the left part of the header, usually a company and/or product name. appIcon and appTitle are both optional and can both be set; in this case the icon appears first.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sAppTitle - New value for property appTitle
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setAppTitle(sAppTitle: string): sap.ui.ux3.Shell;
/**
* Replaces the existing Shell content with the given Control(-Tree). Only leads to a re-rendering of the content area (not the complete Shell).
* This method may be more convenient than a series of calls to "removeContent" and "addContent", which each lead to a re-rendering of the content area (but again not of the complete Shell).
*
* By default the old content is not destroyed and is returned by this method in an array for further usage. To avoid memory leaks, the old content should be destroyed (if not needed later), by setting the "destroyOldContent" flag or by destroying it manually later on. If "destroyOldContent" is set, an empty array is returned.
* @param {sap.ui.core.Control} oContent - The new Content. In this method it must be exactly one control (-tree). Use addContent() to add more control (-trees) to the main content area of the Shell.
* @param {boolean} bDestroyOldContent - If set, the controls previously contained in the Shell will be destroyed, to avoid memory leaks.
* @returns {sap.ui.core.Control[]}
*/
public setContent(oContent: sap.ui.core.Control, bDestroyOldContent: boolean): sap.ui.core.Control[];
/**
* Sets a new value for property {@link #getDesignType designType}.
*
* Defines which design type is to be used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.ui.ux3.ShellDesignType} sDesignType - New value for property designType
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setDesignType(sDesignType: sap.ui.ux3.ShellDesignType): sap.ui.ux3.Shell;
/**
* Sets a new value for property {@link #getFullHeightContent fullHeightContent}.
*
* If set to true, the content area has a defined height. This means that any content put inside can use "100%" height in CSS and will then consume all available space.
* However, if content is larger, scrollbars will appear at the content area of the Shell and not on window level.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bFullHeightContent - New value for property fullHeightContent
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setFullHeightContent(bFullHeightContent: boolean): sap.ui.ux3.Shell;
/**
* Sets a new value for property {@link #getHeaderType headerType}.
*
* Defines which header type to be used. Depending on the header type some other functionality might be obsolete.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.ui.ux3.ShellHeaderType} sHeaderType - New value for property headerType
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setHeaderType(sHeaderType: sap.ui.ux3.ShellHeaderType): sap.ui.ux3.Shell;
/**
* Sets a new value for property {@link #getLogoutButtonTooltip logoutButtonTooltip}.
*
* The tooltip to be displayed for the Logout Button of the Shell. If not set, a text meaning "Logout" in the current language will be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sLogoutButtonTooltip - New value for property logoutButtonTooltip
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setLogoutButtonTooltip(sLogoutButtonTooltip: string): sap.ui.ux3.Shell;
/**
* Moves the complete Shell away from the right window border by the given number of pixels (left border in RTL case).
*
* So there is space for a sidebar or so outside the Shell. The CSS class 'sapUiUx3ShellOuterSideBar' provides the basic position
* capabilities for the sidebar DOM element.
*
* This feature is not public. The usage is only granted to special groups on request.
* @param {number} px - how many pixels of free space should be next to the Shell (between 0 and 600)
* @param {Function} complete - optional callback function to call after the animation
* @param {string} outerId - optional id of the content representing the outside sidebar. If specified the width of the content is animated.
*/
protected setOffsetRight(px: number, complete?: Function, outerId?: string): void;
/**
* Replaces the existing side pane content with the given Control(-Tree). This method is optimized to only re-render the pane content (and not the shell) which is faster and smoother than any other way of changing the "paneContent" aggregation.
*
* By default, the old pane content is not destroyed and is returned by this method in an array for further usage. To avoid memory leaks, the old content should be destroyed (if not needed later), by setting the "destroyOldContent" flag or by destroying it manually later on. If "destroyOldContent" is set, an empty array is returned.
* @param {sap.ui.core.Control} oContent - The new Pane content. In this method it must be exactly one control (-tree). This could likely be a layout or a specific ux3 Pane control. Use addPaneContent() to add more control (-trees) to the Pane.
* @param {boolean} bDestroyOldContent - If set, the controls previously contained in the pane will be destroyed, to avoid memory leaks.
* @returns {sap.ui.core.Control[]}
*/
public setPaneContent(oContent: sap.ui.core.Control, bDestroyOldContent: boolean): sap.ui.core.Control[];
/**
* Sets a new value for property {@link #getPaneWidth paneWidth}.
*
* The width of the right-hand side pane in pixels. The value must be a non-negative integer. The Shell reserves the right to define a minimum width (currently 50px).
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 250
.
* @param {number} iPaneWidth - New value for property paneWidth
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setPaneWidth(iPaneWidth: number): sap.ui.ux3.Shell;
/**
* Sets the associated {@link #getSelectedWorksetItem selectedWorksetItem}.
* @param {sap.ui.core.ID|sap.ui.ux3.NavigationItem} oSelectedWorksetItem - ID of an element which becomes the new target of this selectedWorksetItem association; alternatively, an element instance may be given
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setSelectedWorksetItem(oSelectedWorksetItem: sap.ui.core.ID|sap.ui.ux3.NavigationItem): sap.ui.ux3.Shell;
/**
* Sets a new value for property {@link #getShowFeederTool showFeederTool}.
*
* Whether the "Feeder" tool should be displayed or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowFeederTool - New value for property showFeederTool
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setShowFeederTool(bShowFeederTool: boolean): sap.ui.ux3.Shell;
/**
* Sets a new value for property {@link #getShowInspectorTool showInspectorTool}.
*
* Whether the "Inspector" tool should be displayed or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowInspectorTool - New value for property showInspectorTool
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setShowInspectorTool(bShowInspectorTool: boolean): sap.ui.ux3.Shell;
/**
* Sets a new value for property {@link #getShowLogoutButton showLogoutButton}.
*
* Whether the Logoff button in the header should be displayed or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowLogoutButton - New value for property showLogoutButton
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setShowLogoutButton(bShowLogoutButton: boolean): sap.ui.ux3.Shell;
/**
* Sets a new value for property {@link #getShowPane showPane}.
*
* Whether the pane bar should be displayed at all or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowPane - New value for property showPane
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setShowPane(bShowPane: boolean): sap.ui.ux3.Shell;
/**
* Sets a new value for property {@link #getShowSearchTool showSearchTool}.
*
* Whether the "Global Search" tool should be displayed or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowSearchTool - New value for property showSearchTool
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setShowSearchTool(bShowSearchTool: boolean): sap.ui.ux3.Shell;
/**
* Sets a new value for property {@link #getShowTools showTools}.
*
* Whether the tool area should be displayed at all or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowTools - New value for property showTools
* @returns {sap.ui.ux3.Shell} Reference to this
in order to allow method chaining
*/
public setShowTools(bShowTools: boolean): sap.ui.ux3.Shell;
}
/**
* Available shell design types.
*/
export enum ShellDesignType {
/**
* An even lighter design. It borrows most of its properties from the Light
* design and just changes a few details like the header colors in order to
* have a blue design within gold reflection.
*/
Crystal = "Crystal",
/**
* A lighter design. Should be used in combination with the Standard header
* type.
*/
Light = "Light",
/**
* The standard Shell design (dark).
*/
Standard = "Standard",
}
/**
* Available shell header display types.
*/
export enum ShellHeaderType {
/**
* Only the branding area is visible. Top-level navigation bar, header items, title and icon are not shown.
*/
BrandOnly = "BrandOnly",
/**
* Like the Standard Area but without top-level navigation bar.
*/
NoNavigation = "NoNavigation",
/**
* Like the Standard Area but with a leaner top-level navigation bar.
*/
SlimNavigation = "SlimNavigation",
/**
* The standard Shell header.
*/
Standard = "Standard",
}
/**
* Thing Action for Swatch, QuickView, Thinginspector
*/
export class ThingAction extends sap.ui.core.Element {
/**
* Constructor for a new ThingAction.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.ux3.ThingAction
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ThingAction
itself.
*
* Event will be fired when the action was triggered.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ThingAction
itself
* @returns {sap.ui.ux3.ThingAction} Reference to this
in order to allow method chaining
*/
public attachSelect(fnFunction: Function, oListener?: any): sap.ui.ux3.ThingAction;
/**
* Attaches event handler fnFunction
to the {@link #event:select select} event of this sap.ui.ux3.ThingAction
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ThingAction
itself.
*
* Event will be fired when the action was triggered.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ThingAction
itself
* @returns {sap.ui.ux3.ThingAction} Reference to this
in order to allow method chaining
*/
public attachSelect(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ThingAction;
/**
* Detaches event handler fnFunction
from the {@link #event:select select} event of this sap.ui.ux3.ThingAction
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ThingAction} Reference to this
in order to allow method chaining
*/
public detachSelect(fnFunction: Function, oListener: any): sap.ui.ux3.ThingAction;
/**
* Creates a new subclass of class sap.ui.ux3.ThingAction with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:select select} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.ThingAction} Reference to this
in order to allow method chaining
*/
protected fireSelect(mParameters?: any): sap.ui.ux3.ThingAction;
/**
* Gets current value of property {@link #getEnabled enabled}.
*
* action enabled (true/false)
*
* Default value is true
.
* @returns {boolean} Value of property enabled
*/
public getEnabled(): boolean;
/**
* Returns a metadata object for class sap.ui.ux3.ThingAction.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getText text}.
*
* text of action
* @returns {string} Value of property text
*/
public getText(): string;
/**
* Sets a new value for property {@link #getEnabled enabled}.
*
* action enabled (true/false)
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bEnabled - New value for property enabled
* @returns {sap.ui.ux3.ThingAction} Reference to this
in order to allow method chaining
*/
public setEnabled(bEnabled: boolean): sap.ui.ux3.ThingAction;
/**
* Sets a new value for property {@link #getText text}.
*
* text of action
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sText - New value for property text
* @returns {sap.ui.ux3.ThingAction} Reference to this
in order to allow method chaining
*/
public setText(sText: string): sap.ui.ux3.ThingAction;
}
/**
* Thing Group Area
*/
export class ThingGroup extends sap.ui.core.Element {
/**
* Constructor for a new ThingGroup.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some action to the aggregation {@link #getActions actions}.
* @param {sap.ui.ux3.ThingGroup} oAction - the action to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.ThingGroup} Reference to this
in order to allow method chaining
*/
public addAction(oAction: sap.ui.ux3.ThingGroup): sap.ui.ux3.ThingGroup;
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.ThingGroup} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.ux3.ThingGroup;
/**
* Destroys all the actions in the aggregation {@link #getActions actions}.
* @returns {sap.ui.ux3.ThingGroup} Reference to this
in order to allow method chaining
*/
public destroyActions(): sap.ui.ux3.ThingGroup;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.ux3.ThingGroup} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.ux3.ThingGroup;
/**
* Creates a new subclass of class sap.ui.ux3.ThingGroup with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getActions actions}.
*
* Actions of the groups content
* @returns {sap.ui.ux3.ThingGroup[]}
*/
public getActions(): sap.ui.ux3.ThingGroup[];
/**
* Gets current value of property {@link #getColspan colspan}.
*
* If Group is used in a column layout the groups spans the all columns if set to true.
*
* Default value is false
.
* @returns {boolean} Value of property colspan
*/
public getColspan(): boolean;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Content of Group
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.ui.ux3.ThingGroup.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTitle title}.
*
* Title of Group
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Checks for the provided sap.ui.ux3.ThingGroup
in the aggregation {@link #getActions actions}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.ThingGroup} oAction - The action whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAction(oAction: sap.ui.ux3.ThingGroup): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a action into the aggregation {@link #getActions actions}.
* @param {sap.ui.ux3.ThingGroup} oAction - the action to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the action should be inserted at; for a negative value of iIndex
, the action is inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted at the last position
* @returns {sap.ui.ux3.ThingGroup} Reference to this
in order to allow method chaining
*/
public insertAction(oAction: sap.ui.ux3.ThingGroup, iIndex: number): sap.ui.ux3.ThingGroup;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.ux3.ThingGroup} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.ux3.ThingGroup;
/**
* Removes a action from the aggregation {@link #getActions actions}.
* @param {number|string|sap.ui.ux3.ThingGroup} vAction - The action to remove or its index or id
* @returns {sap.ui.ux3.ThingGroup} The removed action or null
*/
public removeAction(vAction: number|string|sap.ui.ux3.ThingGroup): sap.ui.ux3.ThingGroup;
/**
* Removes all the controls from the aggregation {@link #getActions actions}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.ThingGroup[]} An array of the removed elements (might be empty)
*/
public removeAllActions(): sap.ui.ux3.ThingGroup[];
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getColspan colspan}.
*
* If Group is used in a column layout the groups spans the all columns if set to true.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bColspan - New value for property colspan
* @returns {sap.ui.ux3.ThingGroup} Reference to this
in order to allow method chaining
*/
public setColspan(bColspan: boolean): sap.ui.ux3.ThingGroup;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Title of Group
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.ux3.ThingGroup} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.ux3.ThingGroup;
}
/**
* Thing Inspector
*/
export class ThingInspector extends sap.ui.ux3.Overlay {
/**
* Constructor for a new ThingInspector.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some action to the aggregation {@link #getActions actions}.
* @param {sap.ui.ux3.ThingAction} oAction - the action to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public addAction(oAction: sap.ui.ux3.ThingAction): sap.ui.ux3.ThingInspector;
/**
* Adds some facet to the aggregation {@link #getFacets facets}.
* @param {sap.ui.ux3.NavigationItem} oFacet - the facet to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public addFacet(oFacet: sap.ui.ux3.NavigationItem): sap.ui.ux3.ThingInspector;
/**
* Adds some facetContent to the aggregation {@link #getFacetContent facetContent}.
* @param {sap.ui.ux3.ThingGroup} oFacetContent - the facetContent to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public addFacetContent(oFacetContent: sap.ui.ux3.ThingGroup): sap.ui.ux3.ThingInspector;
/**
* Adds some headerContent to the aggregation {@link #getHeaderContent headerContent}.
* @param {sap.ui.ux3.ThingGroup} oHeaderContent - the headerContent to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public addHeaderContent(oHeaderContent: sap.ui.ux3.ThingGroup): sap.ui.ux3.ThingInspector;
/**
* Attaches event handler fnFunction
to the {@link #event:actionSelected actionSelected} event of this sap.ui.ux3.ThingInspector
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ThingInspector
itself.
*
* Further thing related Action selected
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ThingInspector
itself
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public attachActionSelected(fnFunction: Function, oListener?: any): sap.ui.ux3.ThingInspector;
/**
* Attaches event handler fnFunction
to the {@link #event:actionSelected actionSelected} event of this sap.ui.ux3.ThingInspector
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ThingInspector
itself.
*
* Further thing related Action selected
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ThingInspector
itself
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public attachActionSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ThingInspector;
/**
* Attaches event handler fnFunction
to the {@link #event:facetSelected facetSelected} event of this sap.ui.ux3.ThingInspector
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ThingInspector
itself.
*
* Event for facet selection. The application is responsible for displaying the correct content for the selected one. The ThingInspector will currently always mark the first facet as selected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ThingInspector
itself
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public attachFacetSelected(fnFunction: Function, oListener?: any): sap.ui.ux3.ThingInspector;
/**
* Attaches event handler fnFunction
to the {@link #event:facetSelected facetSelected} event of this sap.ui.ux3.ThingInspector
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ThingInspector
itself.
*
* Event for facet selection. The application is responsible for displaying the correct content for the selected one. The ThingInspector will currently always mark the first facet as selected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ThingInspector
itself
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public attachFacetSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ThingInspector;
/**
* Attaches event handler fnFunction
to the {@link #event:feedSubmit feedSubmit} event of this sap.ui.ux3.ThingInspector
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ThingInspector
itself.
*
* Fired when a new feed entry is submitted.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ThingInspector
itself
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public attachFeedSubmit(fnFunction: Function, oListener?: any): sap.ui.ux3.ThingInspector;
/**
* Attaches event handler fnFunction
to the {@link #event:feedSubmit feedSubmit} event of this sap.ui.ux3.ThingInspector
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ThingInspector
itself.
*
* Fired when a new feed entry is submitted.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ThingInspector
itself
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public attachFeedSubmit(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ThingInspector;
/**
* Destroys the actionBar in the aggregation {@link #getActionBar actionBar}.
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public destroyActionBar(): sap.ui.ux3.ThingInspector;
/**
* Destroys all the actions in the aggregation {@link #getActions actions}.
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public destroyActions(): sap.ui.ux3.ThingInspector;
/**
* Destroys all the facetContent in the aggregation {@link #getFacetContent facetContent}.
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public destroyFacetContent(): sap.ui.ux3.ThingInspector;
/**
* Destroys all the facets in the aggregation {@link #getFacets facets}.
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public destroyFacets(): sap.ui.ux3.ThingInspector;
/**
* Destroys all the headerContent in the aggregation {@link #getHeaderContent headerContent}.
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public destroyHeaderContent(): sap.ui.ux3.ThingInspector;
/**
* Detaches event handler fnFunction
from the {@link #event:actionSelected actionSelected} event of this sap.ui.ux3.ThingInspector
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public detachActionSelected(fnFunction: Function, oListener: any): sap.ui.ux3.ThingInspector;
/**
* Detaches event handler fnFunction
from the {@link #event:facetSelected facetSelected} event of this sap.ui.ux3.ThingInspector
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public detachFacetSelected(fnFunction: Function, oListener: any): sap.ui.ux3.ThingInspector;
/**
* Detaches event handler fnFunction
from the {@link #event:feedSubmit feedSubmit} event of this sap.ui.ux3.ThingInspector
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public detachFeedSubmit(fnFunction: Function, oListener: any): sap.ui.ux3.ThingInspector;
/**
* Creates a new subclass of class sap.ui.ux3.ThingInspector with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.ux3.Overlay.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:actionSelected actionSelected} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
protected fireActionSelected(mParameters?: any): sap.ui.ux3.ThingInspector;
/**
* Fires event {@link #event:facetSelected facetSelected} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireFacetSelected(mParameters?: any): boolean;
/**
* Fires event {@link #event:feedSubmit feedSubmit} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
protected fireFeedSubmit(mParameters?: any): sap.ui.ux3.ThingInspector;
/**
* Gets content of aggregation {@link #getActionBar actionBar}.
*
* ActionBar. If no actionBar is set a default ActionBar will be created.
* @returns {sap.ui.ux3.ActionBar}
*/
public getActionBar(): sap.ui.ux3.ActionBar;
/**
* Gets content of aggregation {@link #getActions actions}.
*
* Actions of a Thing
* @returns {sap.ui.ux3.ThingAction[]}
*/
public getActions(): sap.ui.ux3.ThingAction[];
/**
* Gets content of aggregation {@link #getFacetContent facetContent}.
*
* ThingGroups for content of the selected facet
* @returns {sap.ui.ux3.ThingGroup[]}
*/
public getFacetContent(): sap.ui.ux3.ThingGroup[];
/**
* Gets content of aggregation {@link #getFacets facets}.
*
* Thing Inspector facets
* @returns {sap.ui.ux3.NavigationItem[]}
*/
public getFacets(): sap.ui.ux3.NavigationItem[];
/**
* Gets current value of property {@link #getFavoriteActionEnabled favoriteActionEnabled}.
*
* Favorite action enabled/disabled. If disabled the action will be invisible.
*
* Default value is true
.
* @returns {boolean} Value of property favoriteActionEnabled
*/
public getFavoriteActionEnabled(): boolean;
/**
* Gets current value of property {@link #getFavoriteState favoriteState}.
*
* State Of favorite Action
*
* Default value is false
.
* @returns {boolean} Value of property favoriteState
*/
public getFavoriteState(): boolean;
/**
* Gets current value of property {@link #getFirstTitle firstTitle}.
*
* First Line of the Thing Inspector Title
* @returns {string} Value of property firstTitle
*/
public getFirstTitle(): string;
/**
* Gets current value of property {@link #getFlagActionEnabled flagActionEnabled}.
*
* Flag action enabled/disabled. If disabled the action will be invisible.
*
* Default value is true
.
* @returns {boolean} Value of property flagActionEnabled
*/
public getFlagActionEnabled(): boolean;
/**
* Gets current value of property {@link #getFlagState flagState}.
*
* State of Flag Action
*
* Default value is false
.
* @returns {boolean} Value of property flagState
*/
public getFlagState(): boolean;
/**
* Gets current value of property {@link #getFollowActionEnabled followActionEnabled}.
*
* Follow action enabled/disabled. If disabled the action will be invisible.
*
* Default value is true
.
* @returns {boolean} Value of property followActionEnabled
*/
public getFollowActionEnabled(): boolean;
/**
* Gets current value of property {@link #getFollowState followState}.
*
* Follow State of a Thing
*
* Default value is Default
.
* @returns {sap.ui.ux3.FollowActionState} Value of property followState
*/
public getFollowState(): sap.ui.ux3.FollowActionState;
/**
* Gets content of aggregation {@link #getHeaderContent headerContent}.
*
* ThingGroups for the header content
* @returns {sap.ui.ux3.ThingGroup[]}
*/
public getHeaderContent(): sap.ui.ux3.ThingGroup[];
/**
* Gets current value of property {@link #getHeaderType headerType}.
*
* Defines which header type should be used.
*
* Default value is Standard
.
* @returns {sap.ui.ux3.ThingViewerHeaderType} Value of property headerType
*/
public getHeaderType(): sap.ui.ux3.ThingViewerHeaderType;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Thing Icon Url
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.ui.ux3.ThingInspector.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getSecondTitle secondTitle}.
*
* Second Line of the Thing Inspector Title
* @returns {string} Value of property secondTitle
*/
public getSecondTitle(): string;
/**
* ID of the element which is the current target of the association {@link #getSelectedFacet selectedFacet}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedFacet(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getType type}.
*
* Thing type
* @returns {string} Value of property type
*/
public getType(): string;
/**
* Gets current value of property {@link #getUpdateActionEnabled updateActionEnabled}.
*
* Update action enabled/disabled. If disabled the action will be invisible.
*
* Default value is true
.
* @returns {boolean} Value of property updateActionEnabled
*/
public getUpdateActionEnabled(): boolean;
/**
* Checks for the provided sap.ui.ux3.ThingAction
in the aggregation {@link #getActions actions}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.ThingAction} oAction - The action whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAction(oAction: sap.ui.ux3.ThingAction): number;
/**
* Checks for the provided sap.ui.ux3.NavigationItem
in the aggregation {@link #getFacets facets}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.NavigationItem} oFacet - The facet whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfFacet(oFacet: sap.ui.ux3.NavigationItem): number;
/**
* Checks for the provided sap.ui.ux3.ThingGroup
in the aggregation {@link #getFacetContent facetContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.ThingGroup} oFacetContent - The facetContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfFacetContent(oFacetContent: sap.ui.ux3.ThingGroup): number;
/**
* Checks for the provided sap.ui.ux3.ThingGroup
in the aggregation {@link #getHeaderContent headerContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.ThingGroup} oHeaderContent - The headerContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfHeaderContent(oHeaderContent: sap.ui.ux3.ThingGroup): number;
/**
* Inserts a action into the aggregation {@link #getActions actions}.
* @param {sap.ui.ux3.ThingAction} oAction - the action to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the action should be inserted at; for a negative value of iIndex
, the action is inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted at the last position
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public insertAction(oAction: sap.ui.ux3.ThingAction, iIndex: number): sap.ui.ux3.ThingInspector;
/**
* Inserts a facet into the aggregation {@link #getFacets facets}.
* @param {sap.ui.ux3.NavigationItem} oFacet - the facet to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the facet should be inserted at; for a negative value of iIndex
, the facet is inserted at position 0; for a value greater than the current size of the aggregation, the facet is inserted at the last position
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public insertFacet(oFacet: sap.ui.ux3.NavigationItem, iIndex: number): sap.ui.ux3.ThingInspector;
/**
* Inserts a facetContent into the aggregation {@link #getFacetContent facetContent}.
* @param {sap.ui.ux3.ThingGroup} oFacetContent - the facetContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the facetContent should be inserted at; for a negative value of iIndex
, the facetContent is inserted at position 0; for a value greater than the current size of the aggregation, the facetContent is inserted at the last position
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public insertFacetContent(oFacetContent: sap.ui.ux3.ThingGroup, iIndex: number): sap.ui.ux3.ThingInspector;
/**
* Inserts a headerContent into the aggregation {@link #getHeaderContent headerContent}.
* @param {sap.ui.ux3.ThingGroup} oHeaderContent - the headerContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the headerContent should be inserted at; for a negative value of iIndex
, the headerContent is inserted at position 0; for a value greater than the current size of the aggregation, the headerContent is inserted at the last position
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public insertHeaderContent(oHeaderContent: sap.ui.ux3.ThingGroup, iIndex: number): sap.ui.ux3.ThingInspector;
/**
* Opens this instance of ThingIspector
* @param {string} initialFocusId
*/
public open(initialFocusId?: string): void;
/**
* Removes a action from the aggregation {@link #getActions actions}.
* @param {number|string|sap.ui.ux3.ThingAction} vAction - The action to remove or its index or id
* @returns {sap.ui.ux3.ThingAction} The removed action or null
*/
public removeAction(vAction: number|string|sap.ui.ux3.ThingAction): sap.ui.ux3.ThingAction;
/**
* Removes all the controls from the aggregation {@link #getActions actions}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.ThingAction[]} An array of the removed elements (might be empty)
*/
public removeAllActions(): sap.ui.ux3.ThingAction[];
/**
* Removes all the controls from the aggregation {@link #getFacetContent facetContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.ThingGroup[]} An array of the removed elements (might be empty)
*/
public removeAllFacetContent(): sap.ui.ux3.ThingGroup[];
/**
* Removes all the controls from the aggregation {@link #getFacets facets}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.NavigationItem[]} An array of the removed elements (might be empty)
*/
public removeAllFacets(): sap.ui.ux3.NavigationItem[];
/**
* Removes all the controls from the aggregation {@link #getHeaderContent headerContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.ThingGroup[]} An array of the removed elements (might be empty)
*/
public removeAllHeaderContent(): sap.ui.ux3.ThingGroup[];
/**
* Removes a facet from the aggregation {@link #getFacets facets}.
* @param {number|string|sap.ui.ux3.NavigationItem} vFacet - The facet to remove or its index or id
* @returns {sap.ui.ux3.NavigationItem} The removed facet or null
*/
public removeFacet(vFacet: number|string|sap.ui.ux3.NavigationItem): sap.ui.ux3.NavigationItem;
/**
* Removes a facetContent from the aggregation {@link #getFacetContent facetContent}.
* @param {number|string|sap.ui.ux3.ThingGroup} vFacetContent - The facetContent to remove or its index or id
* @returns {sap.ui.ux3.ThingGroup} The removed facetContent or null
*/
public removeFacetContent(vFacetContent: number|string|sap.ui.ux3.ThingGroup): sap.ui.ux3.ThingGroup;
/**
* Removes a headerContent from the aggregation {@link #getHeaderContent headerContent}.
* @param {number|string|sap.ui.ux3.ThingGroup} vHeaderContent - The headerContent to remove or its index or id
* @returns {sap.ui.ux3.ThingGroup} The removed headerContent or null
*/
public removeHeaderContent(vHeaderContent: number|string|sap.ui.ux3.ThingGroup): sap.ui.ux3.ThingGroup;
/**
* Sets the aggregated {@link #getActionBar actionBar}.
* @param {sap.ui.ux3.ActionBar} oActionBar - The actionBar to set
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public setActionBar(oActionBar: sap.ui.ux3.ActionBar): sap.ui.ux3.ThingInspector;
/**
* Sets a new value for property {@link #getFavoriteActionEnabled favoriteActionEnabled}.
*
* Favorite action enabled/disabled. If disabled the action will be invisible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bFavoriteActionEnabled - New value for property favoriteActionEnabled
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public setFavoriteActionEnabled(bFavoriteActionEnabled: boolean): sap.ui.ux3.ThingInspector;
/**
* Sets a new value for property {@link #getFavoriteState favoriteState}.
*
* State Of favorite Action
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bFavoriteState - New value for property favoriteState
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public setFavoriteState(bFavoriteState: boolean): sap.ui.ux3.ThingInspector;
/**
* Sets a new value for property {@link #getFirstTitle firstTitle}.
*
* First Line of the Thing Inspector Title
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sFirstTitle - New value for property firstTitle
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public setFirstTitle(sFirstTitle: string): sap.ui.ux3.ThingInspector;
/**
* Sets a new value for property {@link #getFlagActionEnabled flagActionEnabled}.
*
* Flag action enabled/disabled. If disabled the action will be invisible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bFlagActionEnabled - New value for property flagActionEnabled
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public setFlagActionEnabled(bFlagActionEnabled: boolean): sap.ui.ux3.ThingInspector;
/**
* Sets a new value for property {@link #getFlagState flagState}.
*
* State of Flag Action
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bFlagState - New value for property flagState
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public setFlagState(bFlagState: boolean): sap.ui.ux3.ThingInspector;
/**
* Sets a new value for property {@link #getFollowActionEnabled followActionEnabled}.
*
* Follow action enabled/disabled. If disabled the action will be invisible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bFollowActionEnabled - New value for property followActionEnabled
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public setFollowActionEnabled(bFollowActionEnabled: boolean): sap.ui.ux3.ThingInspector;
/**
* Sets a new value for property {@link #getFollowState followState}.
*
* Follow State of a Thing
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Default
.
* @param {sap.ui.ux3.FollowActionState} sFollowState - New value for property followState
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public setFollowState(sFollowState: sap.ui.ux3.FollowActionState): sap.ui.ux3.ThingInspector;
/**
* Sets a new value for property {@link #getHeaderType headerType}.
*
* Defines which header type should be used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.ui.ux3.ThingViewerHeaderType} sHeaderType - New value for property headerType
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public setHeaderType(sHeaderType: sap.ui.ux3.ThingViewerHeaderType): sap.ui.ux3.ThingInspector;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Thing Icon Url
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.ux3.ThingInspector;
/**
* Sets a new value for property {@link #getSecondTitle secondTitle}.
*
* Second Line of the Thing Inspector Title
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sSecondTitle - New value for property secondTitle
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public setSecondTitle(sSecondTitle: string): sap.ui.ux3.ThingInspector;
/**
* Sets the associated {@link #getSelectedFacet selectedFacet}.
* @param {sap.ui.core.ID|sap.ui.ux3.NavigationItem} oSelectedFacet - ID of an element which becomes the new target of this selectedFacet association; alternatively, an element instance may be given
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public setSelectedFacet(oSelectedFacet: sap.ui.core.ID|sap.ui.ux3.NavigationItem): sap.ui.ux3.ThingInspector;
/**
* Sets a new value for property {@link #getType type}.
*
* Thing type
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sType - New value for property type
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public setType(sType: string): sap.ui.ux3.ThingInspector;
/**
* Sets a new value for property {@link #getUpdateActionEnabled updateActionEnabled}.
*
* Update action enabled/disabled. If disabled the action will be invisible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bUpdateActionEnabled - New value for property updateActionEnabled
* @returns {sap.ui.ux3.ThingInspector} Reference to this
in order to allow method chaining
*/
public setUpdateActionEnabled(bUpdateActionEnabled: boolean): sap.ui.ux3.ThingInspector;
}
/**
* ThingViewer: Same as ThingInspector but decoupled from the Overlay and the ActionBar.
* The control can be added to a Parent container that has a defined width. The ThingViewer fill the whole container. If the parent container has no width defined the control will not work properly.
*/
export class ThingViewer extends sap.ui.core.Control {
/**
* Constructor for a new ThingViewer.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some facet to the aggregation {@link #getFacets facets}.
* @param {sap.ui.ux3.NavigationItem} oFacet - the facet to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public addFacet(oFacet: sap.ui.ux3.NavigationItem): sap.ui.ux3.ThingViewer;
/**
* Adds some facetContent to the aggregation {@link #getFacetContent facetContent}.
* @param {sap.ui.ux3.ThingGroup} oFacetContent - the facetContent to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public addFacetContent(oFacetContent: sap.ui.ux3.ThingGroup): sap.ui.ux3.ThingViewer;
/**
* Adds some headerContent to the aggregation {@link #getHeaderContent headerContent}.
* @param {sap.ui.ux3.ThingGroup} oHeaderContent - the headerContent to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public addHeaderContent(oHeaderContent: sap.ui.ux3.ThingGroup): sap.ui.ux3.ThingViewer;
/**
* Attaches event handler fnFunction
to the {@link #event:facetSelected facetSelected} event of this sap.ui.ux3.ThingViewer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ThingViewer
itself.
*
* Event for facet selection. The application is responsible for displaying the correct content for the selected one. The ThingInspector will currently always mark the first facet as selected.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ThingViewer
itself
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public attachFacetSelected(fnFunction: Function, oListener?: any): sap.ui.ux3.ThingViewer;
/**
* Attaches event handler fnFunction
to the {@link #event:facetSelected facetSelected} event of this sap.ui.ux3.ThingViewer
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ThingViewer
itself.
*
* Event for facet selection. The application is responsible for displaying the correct content for the selected one. The ThingInspector will currently always mark the first facet as selected.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ThingViewer
itself
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public attachFacetSelected(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ThingViewer;
/**
* Destroys the actionBar in the aggregation {@link #getActionBar actionBar}.
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public destroyActionBar(): sap.ui.ux3.ThingViewer;
/**
* Destroys all the facetContent in the aggregation {@link #getFacetContent facetContent}.
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public destroyFacetContent(): sap.ui.ux3.ThingViewer;
/**
* Destroys all the facets in the aggregation {@link #getFacets facets}.
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public destroyFacets(): sap.ui.ux3.ThingViewer;
/**
* Destroys all the headerContent in the aggregation {@link #getHeaderContent headerContent}.
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public destroyHeaderContent(): sap.ui.ux3.ThingViewer;
/**
* Detaches event handler fnFunction
from the {@link #event:facetSelected facetSelected} event of this sap.ui.ux3.ThingViewer
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public detachFacetSelected(fnFunction: Function, oListener: any): sap.ui.ux3.ThingViewer;
/**
* Creates a new subclass of class sap.ui.ux3.ThingViewer with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:facetSelected facetSelected} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireFacetSelected(mParameters?: any): boolean;
/**
* Gets content of aggregation {@link #getActionBar actionBar}.
*
* An ActionBar can be given
* @returns {sap.ui.ux3.ActionBar}
*/
public getActionBar(): sap.ui.ux3.ActionBar;
/**
* Gets content of aggregation {@link #getFacetContent facetContent}.
*
* ThingGroups for content of the selected facet
* @returns {sap.ui.ux3.ThingGroup[]}
*/
public getFacetContent(): sap.ui.ux3.ThingGroup[];
/**
* Gets content of aggregation {@link #getFacets facets}.
*
* Thing Inspector facets
* @returns {sap.ui.ux3.NavigationItem[]}
*/
public getFacets(): sap.ui.ux3.NavigationItem[];
/**
* Gets content of aggregation {@link #getHeaderContent headerContent}.
*
* ThingGroups for the header content
* @returns {sap.ui.ux3.ThingGroup[]}
*/
public getHeaderContent(): sap.ui.ux3.ThingGroup[];
/**
* Gets current value of property {@link #getHeaderType headerType}.
*
* Defines which header type should be used.
*
* Default value is Standard
.
* @returns {sap.ui.ux3.ThingViewerHeaderType} Value of property headerType
*/
public getHeaderType(): sap.ui.ux3.ThingViewerHeaderType;
/**
* Gets current value of property {@link #getHeight height}.
*
* Height of the ThingViewer
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getIcon icon}.
*
* Thing Icon Url
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Returns a metadata object for class sap.ui.ux3.ThingViewer.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* ID of the element which is the current target of the association {@link #getSelectedFacet selectedFacet}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedFacet(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getSubtitle subtitle}.
*
* Subtitle of the Thing Inspector
* @returns {string} Value of property subtitle
*/
public getSubtitle(): string;
/**
* Gets current value of property {@link #getTitle title}.
*
* Title of the Thing Inspector
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getType type}.
*
* Thing type
* @returns {string} Value of property type
*/
public getType(): string;
/**
* Gets current value of property {@link #getWidth width}.
*
* Width of the ThingViewer
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Checks for the provided sap.ui.ux3.NavigationItem
in the aggregation {@link #getFacets facets}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.NavigationItem} oFacet - The facet whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfFacet(oFacet: sap.ui.ux3.NavigationItem): number;
/**
* Checks for the provided sap.ui.ux3.ThingGroup
in the aggregation {@link #getFacetContent facetContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.ThingGroup} oFacetContent - The facetContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfFacetContent(oFacetContent: sap.ui.ux3.ThingGroup): number;
/**
* Checks for the provided sap.ui.ux3.ThingGroup
in the aggregation {@link #getHeaderContent headerContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.ux3.ThingGroup} oHeaderContent - The headerContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfHeaderContent(oHeaderContent: sap.ui.ux3.ThingGroup): number;
/**
* Inserts a facet into the aggregation {@link #getFacets facets}.
* @param {sap.ui.ux3.NavigationItem} oFacet - the facet to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the facet should be inserted at; for a negative value of iIndex
, the facet is inserted at position 0; for a value greater than the current size of the aggregation, the facet is inserted at the last position
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public insertFacet(oFacet: sap.ui.ux3.NavigationItem, iIndex: number): sap.ui.ux3.ThingViewer;
/**
* Inserts a facetContent into the aggregation {@link #getFacetContent facetContent}.
* @param {sap.ui.ux3.ThingGroup} oFacetContent - the facetContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the facetContent should be inserted at; for a negative value of iIndex
, the facetContent is inserted at position 0; for a value greater than the current size of the aggregation, the facetContent is inserted at the last position
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public insertFacetContent(oFacetContent: sap.ui.ux3.ThingGroup, iIndex: number): sap.ui.ux3.ThingViewer;
/**
* Inserts a headerContent into the aggregation {@link #getHeaderContent headerContent}.
* @param {sap.ui.ux3.ThingGroup} oHeaderContent - the headerContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the headerContent should be inserted at; for a negative value of iIndex
, the headerContent is inserted at position 0; for a value greater than the current size of the aggregation, the headerContent is inserted at the last position
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public insertHeaderContent(oHeaderContent: sap.ui.ux3.ThingGroup, iIndex: number): sap.ui.ux3.ThingViewer;
/**
* Removes all the controls from the aggregation {@link #getFacetContent facetContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.ThingGroup[]} An array of the removed elements (might be empty)
*/
public removeAllFacetContent(): sap.ui.ux3.ThingGroup[];
/**
* Removes all the controls from the aggregation {@link #getFacets facets}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.NavigationItem[]} An array of the removed elements (might be empty)
*/
public removeAllFacets(): sap.ui.ux3.NavigationItem[];
/**
* Removes all the controls from the aggregation {@link #getHeaderContent headerContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.ux3.ThingGroup[]} An array of the removed elements (might be empty)
*/
public removeAllHeaderContent(): sap.ui.ux3.ThingGroup[];
/**
* Removes a facet from the aggregation {@link #getFacets facets}.
* @param {number|string|sap.ui.ux3.NavigationItem} vFacet - The facet to remove or its index or id
* @returns {sap.ui.ux3.NavigationItem} The removed facet or null
*/
public removeFacet(vFacet: number|string|sap.ui.ux3.NavigationItem): sap.ui.ux3.NavigationItem;
/**
* Removes a facetContent from the aggregation {@link #getFacetContent facetContent}.
* @param {number|string|sap.ui.ux3.ThingGroup} vFacetContent - The facetContent to remove or its index or id
* @returns {sap.ui.ux3.ThingGroup} The removed facetContent or null
*/
public removeFacetContent(vFacetContent: number|string|sap.ui.ux3.ThingGroup): sap.ui.ux3.ThingGroup;
/**
* Removes a headerContent from the aggregation {@link #getHeaderContent headerContent}.
* @param {number|string|sap.ui.ux3.ThingGroup} vHeaderContent - The headerContent to remove or its index or id
* @returns {sap.ui.ux3.ThingGroup} The removed headerContent or null
*/
public removeHeaderContent(vHeaderContent: number|string|sap.ui.ux3.ThingGroup): sap.ui.ux3.ThingGroup;
/**
* Sets the aggregated {@link #getActionBar actionBar}.
* @param {sap.ui.ux3.ActionBar} oActionBar - The actionBar to set
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public setActionBar(oActionBar: sap.ui.ux3.ActionBar): sap.ui.ux3.ThingViewer;
/**
* Sets a new value for property {@link #getHeaderType headerType}.
*
* Defines which header type should be used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Standard
.
* @param {sap.ui.ux3.ThingViewerHeaderType} sHeaderType - New value for property headerType
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public setHeaderType(sHeaderType: sap.ui.ux3.ThingViewerHeaderType): sap.ui.ux3.ThingViewer;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Height of the ThingViewer
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.ui.ux3.ThingViewer;
/**
* Sets a new value for property {@link #getIcon icon}.
*
* Thing Icon Url
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.URI} sIcon - New value for property icon
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public setIcon(sIcon: sap.ui.core.URI): sap.ui.ux3.ThingViewer;
/**
* Sets the associated {@link #getSelectedFacet selectedFacet}.
* @param {sap.ui.core.ID|sap.ui.ux3.NavigationItem} oSelectedFacet - ID of an element which becomes the new target of this selectedFacet association; alternatively, an element instance may be given
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public setSelectedFacet(oSelectedFacet: sap.ui.core.ID|sap.ui.ux3.NavigationItem): sap.ui.ux3.ThingViewer;
/**
* Sets a new value for property {@link #getSubtitle subtitle}.
*
* Subtitle of the Thing Inspector
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sSubtitle - New value for property subtitle
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public setSubtitle(sSubtitle: string): sap.ui.ux3.ThingViewer;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Title of the Thing Inspector
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.ux3.ThingViewer;
/**
* Sets a new value for property {@link #getType type}.
*
* Thing type
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sType - New value for property type
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public setType(sType: string): sap.ui.ux3.ThingViewer;
/**
* Sets a new value for property {@link #getWidth width}.
*
* Width of the ThingViewer
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.ui.ux3.ThingViewer} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.ui.ux3.ThingViewer;
}
/**
* Available ThingViewer header display types.
*/
export enum ThingViewerHeaderType {
/**
* The header content is displayed horizontally above the facet content
*/
Horizontal = "Horizontal",
/**
* The standard ThingViewer header.
*/
Standard = "Standard",
}
/**
* A popup which the user can open from the Shell's tool pane. Generally, the starting point would be an icon.
* For this pop up, buttons can be defined with any text; therefore, it has the same purpose
* and similar look like any common dialog box.
* A ToolPopup can have any content. Depending on the application type and design, the structure
* of the texts and input fields can be for example form-like.
*/
export class ToolPopup extends sap.ui.core.Control {
/**
* Constructor for a new ToolPopup.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some button to the aggregation {@link #getButtons buttons}.
* @param {sap.ui.core.Control} oButton - the button to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public addButton(oButton: sap.ui.core.Control): sap.ui.ux3.ToolPopup;
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.ui.ux3.ToolPopup;
/**
* Adds an ID to the Popup that should be focusable as well when using autoclose
.
* Chaining is only possible if a valid type (string) is given.
* @param {string} sID - ID of the corresponding element that should be focusable as well
*/
public addFocusableArea(sID?: string): void;
/**
* Attaches event handler fnFunction
to the {@link #event:close close} event of this sap.ui.ux3.ToolPopup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ToolPopup
itself.
*
* Event is fired when the popup closes because the user pressed Escape or the ToolPopup
* Button in the Shell. This is called before the closing animation.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ToolPopup
itself
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public attachClose(fnFunction: Function, oListener?: any): sap.ui.ux3.ToolPopup;
/**
* Attaches event handler fnFunction
to the {@link #event:close close} event of this sap.ui.ux3.ToolPopup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ToolPopup
itself.
*
* Event is fired when the popup closes because the user pressed Escape or the ToolPopup
* Button in the Shell. This is called before the closing animation.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ToolPopup
itself
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public attachClose(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ToolPopup;
/**
* Attaches event handler fnFunction
to the {@link #event:closed closed} event of this sap.ui.ux3.ToolPopup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ToolPopup
itself.
*
* This event is fired after the ToolPopup has finished its closing animation.
* It is called for EVERY close, regardless of whether the user has triggered the
* close or whether the ToolPopup was closed via API call.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ToolPopup
itself
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public attachClosed(fnFunction: Function, oListener?: any): sap.ui.ux3.ToolPopup;
/**
* Attaches event handler fnFunction
to the {@link #event:closed closed} event of this sap.ui.ux3.ToolPopup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ToolPopup
itself.
*
* This event is fired after the ToolPopup has finished its closing animation.
* It is called for EVERY close, regardless of whether the user has triggered the
* close or whether the ToolPopup was closed via API call.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ToolPopup
itself
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public attachClosed(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ToolPopup;
/**
* Attaches event handler fnFunction
to the {@link #event:enter enter} event of this sap.ui.ux3.ToolPopup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ToolPopup
itself.
*
* Event is fired whenever the user clicks the Enter or the Enter key inside the pop up
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ToolPopup
itself
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public attachEnter(fnFunction: Function, oListener?: any): sap.ui.ux3.ToolPopup;
/**
* Attaches event handler fnFunction
to the {@link #event:enter enter} event of this sap.ui.ux3.ToolPopup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ToolPopup
itself.
*
* Event is fired whenever the user clicks the Enter or the Enter key inside the pop up
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ToolPopup
itself
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public attachEnter(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ToolPopup;
/**
* Attaches event handler fnFunction
to the {@link #event:iconChanged iconChanged} event of this sap.ui.ux3.ToolPopup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ToolPopup
itself.
*
* Event is fired when one of the icon properties is modified (Note: The icon is not
* rendered by the ToolPopup).
* To be used by other controls which want to update the icon in their UI.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ToolPopup
itself
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public attachIconChanged(fnFunction: Function, oListener?: any): sap.ui.ux3.ToolPopup;
/**
* Attaches event handler fnFunction
to the {@link #event:iconChanged iconChanged} event of this sap.ui.ux3.ToolPopup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ToolPopup
itself.
*
* Event is fired when one of the icon properties is modified (Note: The icon is not
* rendered by the ToolPopup).
* To be used by other controls which want to update the icon in their UI.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ToolPopup
itself
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public attachIconChanged(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ToolPopup;
/**
* Attaches event handler fnFunction
to the {@link #event:open open} event of this sap.ui.ux3.ToolPopup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ToolPopup
itself.
*
* Event is fired when the popup opens
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ToolPopup
itself
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public attachOpen(fnFunction: Function, oListener?: any): sap.ui.ux3.ToolPopup;
/**
* Attaches event handler fnFunction
to the {@link #event:open open} event of this sap.ui.ux3.ToolPopup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ToolPopup
itself.
*
* Event is fired when the popup opens
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ToolPopup
itself
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public attachOpen(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ToolPopup;
/**
* Attaches event handler fnFunction
to the {@link #event:opened opened} event of this sap.ui.ux3.ToolPopup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ToolPopup
itself.
*
* Event is being fired after the ToolPopup has been opened.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ToolPopup
itself
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public attachOpened(fnFunction: Function, oListener?: any): sap.ui.ux3.ToolPopup;
/**
* Attaches event handler fnFunction
to the {@link #event:opened opened} event of this sap.ui.ux3.ToolPopup
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.ui.ux3.ToolPopup
itself.
*
* Event is being fired after the ToolPopup has been opened.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.ui.ux3.ToolPopup
itself
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public attachOpened(oData: any, fnFunction: Function, oListener?: any): sap.ui.ux3.ToolPopup;
/**
* Closes the pop up.
* Can be called by the Shell when the pop up's button is clicked again; or by the application
* when the interaction in the pop up has been completed or canceled.
* @param {boolean} bPreventRestoreFocus - If set, the focus is NOT restored to the element that had the focus before the ToolPopup was opened. This makes sense when the ToolPopup is closed programmatically from a different area of the application (outside the ToolPopup) and the focus should not move aways from that place.
* @returns {sap.ui.ux3.ToolPopup}
*/
public close(bPreventRestoreFocus: boolean): sap.ui.ux3.ToolPopup;
/**
* Destroys all the buttons in the aggregation {@link #getButtons buttons}.
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public destroyButtons(): sap.ui.ux3.ToolPopup;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.ui.ux3.ToolPopup;
/**
* Detaches event handler fnFunction
from the {@link #event:close close} event of this sap.ui.ux3.ToolPopup
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public detachClose(fnFunction: Function, oListener: any): sap.ui.ux3.ToolPopup;
/**
* Detaches event handler fnFunction
from the {@link #event:closed closed} event of this sap.ui.ux3.ToolPopup
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public detachClosed(fnFunction: Function, oListener: any): sap.ui.ux3.ToolPopup;
/**
* Detaches event handler fnFunction
from the {@link #event:enter enter} event of this sap.ui.ux3.ToolPopup
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public detachEnter(fnFunction: Function, oListener: any): sap.ui.ux3.ToolPopup;
/**
* Detaches event handler fnFunction
from the {@link #event:iconChanged iconChanged} event of this sap.ui.ux3.ToolPopup
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public detachIconChanged(fnFunction: Function, oListener: any): sap.ui.ux3.ToolPopup;
/**
* Detaches event handler fnFunction
from the {@link #event:open open} event of this sap.ui.ux3.ToolPopup
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public detachOpen(fnFunction: Function, oListener: any): sap.ui.ux3.ToolPopup;
/**
* Detaches event handler fnFunction
from the {@link #event:opened opened} event of this sap.ui.ux3.ToolPopup
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public detachOpened(fnFunction: Function, oListener: any): sap.ui.ux3.ToolPopup;
/**
* Creates a new subclass of class sap.ui.ux3.ToolPopup with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:close close} to attached listeners.
*
* Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {boolean} Whether or not to prevent the default action
*/
protected fireClose(mParameters?: any): boolean;
/**
* Fires event {@link #event:closed closed} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
protected fireClosed(mParameters?: any): sap.ui.ux3.ToolPopup;
/**
* Fires event {@link #event:enter enter} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
protected fireEnter(mParameters?: any): sap.ui.ux3.ToolPopup;
/**
* Fires event {@link #event:iconChanged iconChanged} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
protected fireIconChanged(mParameters?: any): sap.ui.ux3.ToolPopup;
/**
* Fires event {@link #event:open open} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
protected fireOpen(mParameters?: any): sap.ui.ux3.ToolPopup;
/**
* Fires event {@link #event:opened opened} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
protected fireOpened(mParameters?: any): sap.ui.ux3.ToolPopup;
/**
* Gets current value of property {@link #getAutoClose autoClose}.
*
* Determines whether the ToolPopup will auto close when it loses focus.
* If the user e.g. clicks outside of the ToolPopup it will be closed.
* Please don't use "modal" and "autoclose" at the same time.
* In this case a warning will be prompted to the console and "autoclose" won't be used.
*
* Default value is false
.
* @returns {boolean} Value of property autoClose
*/
public getAutoClose(): boolean;
/**
* Gets content of aggregation {@link #getButtons buttons}.
*
* Defines the buttons to appear in the popup
* @returns {sap.ui.core.Control[]}
*/
public getButtons(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getCloseDuration closeDuration}.
*
* Time in milliseconds for the close animation.
*
* Default value is 400
.
* @returns {number} Value of property closeDuration
*/
public getCloseDuration(): number;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Defines the content of the popup
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* ID of the element which is the current target of the association {@link #getDefaultButton defaultButton}, or null
.
* @returns {sap.ui.core.ID}
*/
public getDefaultButton(): sap.ui.core.ID;
/**
* Indicates whether the ToolPopup is currently enabled or not.
*
* Applications can't control the enabled state via a property. A ToolPopup is implicitly
* enabled depending on its openState
. Descendant controls that honor the
* enabled state of their ancestors will appear disabled after the ToolPopup is closed.
*
* Since 1.13.1. Whether a dialog is regarded as "enabled" during the state transitions
* (OPENING, CLOSING) is not fully decided. Currently, it is enabled during the OPENING phase
* and disabled during the CLOSING phase. The only potential change would be to treat the
* OPENING phase as disabled as well. Applications should be prepared to receive events from
* "enabled" controls after they called open() on the dialog until close() is called on it.
* If the mentioned potential change should happen, the dialog will become enabled only
* after the transition to OPEN. Events from "enabled" children then can still only arrive
* between open() and close(), so applications that obey the previous rule should continue
* to work. Only end users or code that explicitly triggers pseudo user events would notice
* a difference.
* A second aspect that might change is the visual behavior of the content: during the CLOSING
* phase it 'looks' enabled but in fact it is already disabled. This avoids unnecessary redraws
* for content that becomes hidden soon. Should this show to be confusing for end users, it might
* be changed.
* @returns {boolean}
*/
public getEnabled(): boolean;
/**
* Gets current value of property {@link #getIcon icon}.
*
* This property is relevant for Shell use:
* The URL to the icon displayed in the tool area which is used to open the ToolPopup.
* The recommended size is 32x32px, including some transparent border. Therefore,
* the content will cover about 20x20px.
* @returns {sap.ui.core.URI} Value of property icon
*/
public getIcon(): sap.ui.core.URI;
/**
* Gets current value of property {@link #getIconHover iconHover}.
*
* This property is relevant for Shell use:
* The URL to the icon in hover state, displayed in the tool area which is used to open the popup.
* @returns {sap.ui.core.URI} Value of property iconHover
*/
public getIconHover(): sap.ui.core.URI;
/**
* ID of the element which is the current target of the association {@link #getInitialFocus initialFocus}, or null
.
* @returns {sap.ui.core.ID}
*/
public getInitialFocus(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getInverted inverted}.
*
* Specifies whether the ToolPopup has a dark or bright background. If set to true
* the background and borders will be dark. If false they will be bright.
* This property only has an effect for the GoldReflection-theme.
*
* Default value is true
.
* @returns {boolean} Value of property inverted
*/
public getInverted(): boolean;
/**
* Gets current value of property {@link #getMaxHeight maxHeight}.
*
* Forces a maximum height of the ToolPopup in pixels. If the ToolPopup content
* is higher than the ToolPopup, the content will be scrollable.
* @returns {sap.ui.core.CSSSize} Value of property maxHeight
*/
public getMaxHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getMaxWidth maxWidth}.
*
* Forces a maximum width of the ToolPopup in pixels.
* @returns {sap.ui.core.CSSSize} Value of property maxWidth
*/
public getMaxWidth(): sap.ui.core.CSSSize;
/**
* Returns a metadata object for class sap.ui.ux3.ToolPopup.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getModal modal}.
*
* Specifies whether the popup is modal and blocks any user-interaction with controls in the background.
* Changing this property while the ToolPopup is open will not have any effect.
* Please don't use "modal" and "autoclose" at the same time. In this case a warning will
* be prompted to the console and "autoclose" won't be used.
*
* Default value is false
.
* @returns {boolean} Value of property modal
*/
public getModal(): boolean;
/**
* Gets current value of property {@link #getOpenDuration openDuration}.
*
* Time in milliseconds for the open animation.
*
* Default value is 400
.
* @returns {number} Value of property openDuration
*/
public getOpenDuration(): number;
/**
* ID of the element which is the current target of the association {@link #getOpener opener}, or null
.
* @returns {sap.ui.core.ID}
*/
public getOpener(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getTitle title}.
*
* Determines the title displayed in the pop up window
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getButtons buttons}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oButton - The button whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfButton(oButton: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a button into the aggregation {@link #getButtons buttons}.
* @param {sap.ui.core.Control} oButton - the button to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the button should be inserted at; for a negative value of iIndex
, the button is inserted at position 0; for a value greater than the current size of the aggregation, the button is inserted at the last position
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public insertButton(oButton: sap.ui.core.Control, iIndex: number): sap.ui.ux3.ToolPopup;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.ui.ux3.ToolPopup;
/**
* Indicates whether the pop up is currently open
* @returns {boolean}
*/
public isOpen(): boolean;
/**
* Opens the ToolPopup.
* It is checked which control wants to open the ToolPopup. The Shell was previously
* set as parent so the corresponding parent element is used to set the correct position of the ToolPopup.
* If another control (i.e. a button) opens the ToolPopup, the control must be previously
* set as opener
via setOpener
to the ToolPopup.
* Corresponding to this opener the position of the ToolPopup will be set.
* It's also possible to set the position above, below or left from the opener.
* This can be done via the possible parameters my
and at
.
* These parameters refers to work the same way as they do of sap.ui.core.Popup.open.
* @param {sap.ui.core.Popup.Dock} my - The ToolPopup's content reference position for docking
* @param {sap.ui.core.Popup.Dock} at - The "of" element's reference point for docking to
* @returns {sap.ui.ux3.ToolPopup}
*/
public open(my?: sap.ui.core.Popup.Dock, at?: sap.ui.core.Popup.Dock): sap.ui.ux3.ToolPopup;
/**
* Removes all the controls from the aggregation {@link #getButtons buttons}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllButtons(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a button from the aggregation {@link #getButtons buttons}.
* @param {number|string|sap.ui.core.Control} vButton - The button to remove or its index or id
* @returns {sap.ui.core.Control} The removed button or null
*/
public removeButton(vButton: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes an ID to the Popup that should be focusable as well when using autoclose
.
* Chaining is only possible if a valid type (string) is given.
* @param {string} sID - ID of the corresponding element
*/
public removeFocusableArea(sID?: string): void;
/**
* Sets a new value for property {@link #getAutoClose autoClose}.
*
* Determines whether the ToolPopup will auto close when it loses focus.
* If the user e.g. clicks outside of the ToolPopup it will be closed.
* Please don't use "modal" and "autoclose" at the same time.
* In this case a warning will be prompted to the console and "autoclose" won't be used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bAutoClose - New value for property autoClose
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public setAutoClose(bAutoClose: boolean): sap.ui.ux3.ToolPopup;
/**
* This is just a forward to the Popup's function (sap.ui.core.Popup.setAutoCloseAreas)
* with the same functionality.
* @param {Element[]} aAutoCloseAreas
*/
public setAutoCloseAreas(aAutoCloseAreas: Element[]): void;
/**
* Sets a new value for property {@link #getCloseDuration closeDuration}.
*
* Time in milliseconds for the close animation.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 400
.
* @param {number} iCloseDuration - New value for property closeDuration
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public setCloseDuration(iCloseDuration: number): sap.ui.ux3.ToolPopup;
/**
* Sets the associated {@link #getDefaultButton defaultButton}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oDefaultButton - ID of an element which becomes the new target of this defaultButton association; alternatively, an element instance may be given
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public setDefaultButton(oDefaultButton: sap.ui.core.ID|sap.ui.core.Control): sap.ui.ux3.ToolPopup;
/**
* Sets the associated {@link #getInitialFocus initialFocus}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oInitialFocus - ID of an element which becomes the new target of this initialFocus association; alternatively, an element instance may be given
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public setInitialFocus(oInitialFocus: sap.ui.core.ID|sap.ui.core.Control): sap.ui.ux3.ToolPopup;
/**
* Sets a new value for property {@link #getInverted inverted}.
*
* Specifies whether the ToolPopup has a dark or bright background. If set to true
* the background and borders will be dark. If false they will be bright.
* This property only has an effect for the GoldReflection-theme.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bInverted - New value for property inverted
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public setInverted(bInverted: boolean): sap.ui.ux3.ToolPopup;
/**
* Sets a new value for property {@link #getMaxHeight maxHeight}.
*
* Forces a maximum height of the ToolPopup in pixels. If the ToolPopup content
* is higher than the ToolPopup, the content will be scrollable.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {sap.ui.core.CSSSize} sMaxHeight - New value for property maxHeight
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public setMaxHeight(sMaxHeight: sap.ui.core.CSSSize): sap.ui.ux3.ToolPopup;
/**
* Sets a new value for property {@link #getModal modal}.
*
* Specifies whether the popup is modal and blocks any user-interaction with controls in the background.
* Changing this property while the ToolPopup is open will not have any effect.
* Please don't use "modal" and "autoclose" at the same time. In this case a warning will
* be prompted to the console and "autoclose" won't be used.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bModal - New value for property modal
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public setModal(bModal: boolean): sap.ui.ux3.ToolPopup;
/**
* Sets a new value for property {@link #getOpenDuration openDuration}.
*
* Time in milliseconds for the open animation.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 400
.
* @param {number} iOpenDuration - New value for property openDuration
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public setOpenDuration(iOpenDuration: number): sap.ui.ux3.ToolPopup;
/**
* Sets the associated {@link #getOpener opener}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oOpener - ID of an element which becomes the new target of this opener association; alternatively, an element instance may be given
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public setOpener(oOpener: sap.ui.core.ID|sap.ui.core.Control): sap.ui.ux3.ToolPopup;
/**
* Sets the position of the pop up, the same parameters as for sap.ui.core.Popup can be used.
*/
public setPosition(): void;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Determines the title displayed in the pop up window
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.ui.ux3.ToolPopup} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.ui.ux3.ToolPopup;
}
/**
* VisibleItemCountMode of the FacetFilter defines if the FacetFilter takes the whole available height (Auto) in the surrounding container, or is so high as needed to show 5 Items ("Fixed " - default).
*/
export enum VisibleItemCountMode {
/**
* The FacetFilter automatically fills the height of the surrounding container. The visibleItemCount property is automatically changed accordingly.
*/
Auto = "Auto",
/**
* The FacetFilter always has as many items in the FacetFilterList as defined in the visibleItemCount property.
*/
Fixed = "Fixed",
}
}
}
/**
* SAP UxAP
*/
namespace uxap {
/**
* Anchor bar is the navigation bar of an Object page. Its purpose is to provide links to all Sections and Subsections. Takes the form of a Select on phone.
*/
export class AnchorBar extends sap.m.Toolbar {
/**
* Constructor for a new AnchorBar.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.uxap.AnchorBar with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.Toolbar.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.uxap.AnchorBar.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns an sap.ui.core.delegate.ScrollEnablement object used to handle scrolling.
* @returns {any}
*/
public getScrollDelegate(): any;
/**
* ID of the element which is the current target of the association {@link #getSelectedButton selectedButton}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedButton(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getShowPopover showPopover}.
*
* Determines whether to show a Popover with Subsection links when clicking on Section links in the Anchor bar.
*
* Default value is true
.
* @returns {boolean} Value of property showPopover
*/
public getShowPopover(): boolean;
/**
* Gets current value of property {@link #getUpperCase upperCase}.
*
* Determines whether the Anchor bar items are displayed in upper case.
*
* Default value is false
.
* @returns {boolean} Value of property upperCase
*/
public getUpperCase(): boolean;
/**
* Scroll to a specific Section.
* @param {string} sId - The Section ID to scroll to
* @param {number} duration - Scroll duration (in ms). Default value is 0
*/
public scrollToSection(sId: string, duration: number): void;
/**
* Sets the associated {@link #getSelectedButton selectedButton}.
* @param {sap.ui.core.ID|sap.m.Button} oSelectedButton - ID of an element which becomes the new target of this selectedButton association; alternatively, an element instance may be given
* @returns {sap.uxap.AnchorBar} Reference to this
in order to allow method chaining
*/
public setSelectedButton(oSelectedButton: sap.ui.core.ID|sap.m.Button): sap.uxap.AnchorBar;
/**
* Sets a new value for property {@link #getShowPopover showPopover}.
*
* Determines whether to show a Popover with Subsection links when clicking on Section links in the Anchor bar.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowPopover - New value for property showPopover
* @returns {sap.uxap.AnchorBar} Reference to this
in order to allow method chaining
*/
public setShowPopover(bShowPopover: boolean): sap.uxap.AnchorBar;
/**
* Sets a new value for property {@link #getUpperCase upperCase}.
*
* Determines whether the Anchor bar items are displayed in upper case.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bUpperCase - New value for property upperCase
* @returns {sap.uxap.AnchorBar} Reference to this
in order to allow method chaining
*/
public setUpperCase(bUpperCase: boolean): sap.uxap.AnchorBar;
}
/**
* A block is the main element that will be displayed, mainly in an object page, but not necessarily
* only there.
*
* A block is a control that use an XML view for storing its internal control tree.
* A block is a control that has modes and a view associated to each modes.
* At rendering time, the view associated to the mode is rendered.
*
* Note: The control supports only XML views.
*
* As any UI5 views, the XML view can have a controller which automatically comes a this.oParentBlock attribute (so that the controller can interacts with the block).
* If the controller implements the onParentBlockModeChange method, this method will get called with the sMode parameter when the view is used or re-used by the block.
*/
export class BlockBase extends sap.ui.core.Control {
/**
* Constructor for a new BlockBase.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some mapping to the aggregation {@link #getMappings mappings}.
* @param {sap.uxap.ModelMapping} oMapping - the mapping to add; if empty, nothing is inserted
* @returns {sap.uxap.BlockBase} Reference to this
in order to allow method chaining
*/
public addMapping(oMapping: sap.uxap.ModelMapping): sap.uxap.BlockBase;
/**
* Destroys all the mappings in the aggregation {@link #getMappings mappings}.
* @returns {sap.uxap.BlockBase} Reference to this
in order to allow method chaining
*/
public destroyMappings(): sap.uxap.BlockBase;
/**
* Creates a new subclass of class sap.uxap.BlockBase with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getColumnLayout columnLayout}.
*
* Determines on how columns the layout will be rendered.
* Allowed values are integers from 1 to 4 and "auto".
*
* Default value is auto
.
* @returns {sap.uxap.BlockBaseColumnLayout} Value of property columnLayout
*/
public getColumnLayout(): sap.uxap.BlockBaseColumnLayout;
/**
* Gets current value of property {@link #getFormAdjustment formAdjustment}.
*
* Determines if the block should automatically adjust its inner forms.
* Allowed values are "BlockColumns" and "OneColumn" and "None".
* If the value is "BlockColumns", then the inner form will have as many columns as the colspan of its parent block.
* If the value is "OneColumn", the inner form will have exactly one column, regardless the colspan of its parent block.
* If the value is "None", no automatic adjustment of inner forms will be made and the form will keep its original column count.
*
* Default value is BlockColumns
.
* @returns {sap.uxap.BlockBaseFormAdjustment} Value of property formAdjustment
*/
public getFormAdjustment(): sap.uxap.BlockBaseFormAdjustment;
/**
* Gets content of aggregation {@link #getMappings mappings}.
*
* Map external UI5 model and internal Block model
* @returns {sap.uxap.ModelMapping[]}
*/
public getMappings(): sap.uxap.ModelMapping[];
/**
* Returns a metadata object for class sap.uxap.BlockBase.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMode mode}.
*
* Determines the mode of the block.
* When block is used inside ObjectPage this mode is inherited my the SubSection.
* The mode of the block is changed when SubSection mode changes.
* @returns {string} Value of property mode
*/
public getMode(): string;
/**
* ID of the element which is the current target of the association {@link #getSelectedView selectedView}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedView(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getShowSubSectionMore showSubSectionMore}.
*
* Determines whether the show more button should be shown.
*
* Note: The property will take effect if the BlockBase
is inside
* and would be ignored in case the BlockBase
is nested inside another BlockBase
.
*
* Default value is false
.
* @returns {boolean} Value of property showSubSectionMore
*/
public getShowSubSectionMore(): boolean;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Determines the visibility of the block.
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Checks for the provided sap.uxap.ModelMapping
in the aggregation {@link #getMappings mappings}.
* and returns its index if found or -1 otherwise.
* @param {sap.uxap.ModelMapping} oMapping - The mapping whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfMapping(oMapping: sap.uxap.ModelMapping): number;
/**
* Inserts a mapping into the aggregation {@link #getMappings mappings}.
* @param {sap.uxap.ModelMapping} oMapping - the mapping to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the mapping should be inserted at; for a negative value of iIndex
, the mapping is inserted at position 0; for a value greater than the current size of the aggregation, the mapping is inserted at the last position
* @returns {sap.uxap.BlockBase} Reference to this
in order to allow method chaining
*/
public insertMapping(oMapping: sap.uxap.ModelMapping, iIndex: number): sap.uxap.BlockBase;
/**
* Removes all the controls from the aggregation {@link #getMappings mappings}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.uxap.ModelMapping[]} An array of the removed elements (might be empty)
*/
public removeAllMappings(): sap.uxap.ModelMapping[];
/**
* Removes a mapping from the aggregation {@link #getMappings mappings}.
* @param {number|string|sap.uxap.ModelMapping} vMapping - The mapping to remove or its index or id
* @returns {sap.uxap.ModelMapping} The removed mapping or null
*/
public removeMapping(vMapping: number|string|sap.uxap.ModelMapping): sap.uxap.ModelMapping;
/**
* Set the column layout for this particular block.
* @param {string} sLayout - The column layout to apply to the control
*/
public setColumnLayout(sLayout: string): void;
/**
* Sets a new value for property {@link #getFormAdjustment formAdjustment}.
*
* Determines if the block should automatically adjust its inner forms.
* Allowed values are "BlockColumns" and "OneColumn" and "None".
* If the value is "BlockColumns", then the inner form will have as many columns as the colspan of its parent block.
* If the value is "OneColumn", the inner form will have exactly one column, regardless the colspan of its parent block.
* If the value is "None", no automatic adjustment of inner forms will be made and the form will keep its original column count.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is BlockColumns
.
* @param {sap.uxap.BlockBaseFormAdjustment} sFormAdjustment - New value for property formAdjustment
* @returns {sap.uxap.BlockBase} Reference to this
in order to allow method chaining
*/
public setFormAdjustment(sFormAdjustment: sap.uxap.BlockBaseFormAdjustment): sap.uxap.BlockBase;
/**
* Set the view mode for this particular block.
* @param {string} sMode - the mode to apply to the control (that should be synchronized with view declared)
* @returns {any} this
*/
public setMode(sMode: string): any;
/**
* Sets the associated {@link #getSelectedView selectedView}.
* @param {sap.ui.core.ID|sap.ui.core.Control} oSelectedView - ID of an element which becomes the new target of this selectedView association; alternatively, an element instance may be given
* @returns {sap.uxap.BlockBase} Reference to this
in order to allow method chaining
*/
public setSelectedView(oSelectedView: sap.ui.core.ID|sap.ui.core.Control): sap.uxap.BlockBase;
/**
* Setter for the visibility of the block.
* @returns {sap.uxap.BlockBase}
*/
public setVisible(): sap.uxap.BlockBase;
}
/**
* Used by the BlockBase control to define how many columns should it be assigned by the objectPageSubSection.
* The allowed values can be auto (subsection assigned a number of columns based on the parent objectPageLayout subsectionLayout property), 1, 2 or 3
* (This may not be a valid value for some subSectionLayout, for example asking for 3 columns in a 2 column layout would raise warnings).
*/
export type BlockBaseColumnLayout = "auto"|1|2|3|4;
/**
* Used by the BlockBase control to define if it should do automatic adjustment of its nested forms.
*/
export enum BlockBaseFormAdjustment {
/**
* Any form within the block will be automatically adjusted to have as many columns as the colspan of its parent block.
*/
BlockColumns = "BlockColumns",
/**
* No automatic adjustment of forms.
*/
None = "None",
/**
* Any form within the block will be automatically adjusted to have only one column.
*/
OneColumn = "OneColumn",
}
/**
* The BreadCrumbs control represents the navigation steps up to the current location in the application and allows
* the user to quickly navigate to a previous location on the path that got him to the current location.
* It has two main modes of operation. One is a trail of links followed by separators (when there's enough space
* for the control to fit on one line), and the other is a dropdown list with the links (when the trail of links
* wouldn't fit on one line).
*/
export class BreadCrumbs extends sap.ui.core.Control {
/**
* Constructor for a new BreadCrumbs.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some link to the aggregation {@link #getLinks links}.
* @param {sap.m.Link} oLink - the link to add; if empty, nothing is inserted
* @returns {sap.uxap.BreadCrumbs} Reference to this
in order to allow method chaining
*/
public addLink(oLink: sap.m.Link): sap.uxap.BreadCrumbs;
/**
* Destroys the currentLocation in the aggregation {@link #getCurrentLocation currentLocation}.
* @returns {sap.uxap.BreadCrumbs} Reference to this
in order to allow method chaining
*/
public destroyCurrentLocation(): sap.uxap.BreadCrumbs;
/**
* Destroys all the links in the aggregation {@link #getLinks links}.
* @returns {sap.uxap.BreadCrumbs} Reference to this
in order to allow method chaining
*/
public destroyLinks(): sap.uxap.BreadCrumbs;
/**
* Creates a new subclass of class sap.uxap.BreadCrumbs with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getCurrentLocation currentLocation}.
*
* The current/last element in the BreadCrumbs path.
* @returns {sap.m.Text}
*/
public getCurrentLocation(): sap.m.Text;
/**
* Gets content of aggregation {@link #getLinks links}.
*
* A list of all the active link elements in the BreadCrumbs control.
* @returns {sap.m.Link[]}
*/
public getLinks(): sap.m.Link[];
/**
* Returns a metadata object for class sap.uxap.BreadCrumbs.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowCurrentLocation showCurrentLocation}.
*
* Sets the visibility of the current/last element in the BreadCrumbs path.
*
* Default value is true
.
* @returns {boolean} Value of property showCurrentLocation
*/
public getShowCurrentLocation(): boolean;
/**
* Checks for the provided sap.m.Link
in the aggregation {@link #getLinks links}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Link} oLink - The link whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfLink(oLink: sap.m.Link): number;
/**
* Inserts a link into the aggregation {@link #getLinks links}.
* @param {sap.m.Link} oLink - the link to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the link should be inserted at; for a negative value of iIndex
, the link is inserted at position 0; for a value greater than the current size of the aggregation, the link is inserted at the last position
* @returns {sap.uxap.BreadCrumbs} Reference to this
in order to allow method chaining
*/
public insertLink(oLink: sap.m.Link, iIndex: number): sap.uxap.BreadCrumbs;
/**
* Removes all the controls from the aggregation {@link #getLinks links}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Link[]} An array of the removed elements (might be empty)
*/
public removeAllLinks(): sap.m.Link[];
/**
* Removes a link from the aggregation {@link #getLinks links}.
* @param {number|string|sap.m.Link} vLink - The link to remove or its index or id
* @returns {sap.m.Link} The removed link or null
*/
public removeLink(vLink: number|string|sap.m.Link): sap.m.Link;
/**
* Sets the aggregated {@link #getCurrentLocation currentLocation}.
* @param {sap.m.Text} oCurrentLocation - The currentLocation to set
* @returns {sap.uxap.BreadCrumbs} Reference to this
in order to allow method chaining
*/
public setCurrentLocation(oCurrentLocation: sap.m.Text): sap.uxap.BreadCrumbs;
/**
* Sets a new value for property {@link #getShowCurrentLocation showCurrentLocation}.
*
* Sets the visibility of the current/last element in the BreadCrumbs path.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowCurrentLocation - New value for property showCurrentLocation
* @returns {sap.uxap.BreadCrumbs} Reference to this
in order to allow method chaining
*/
public setShowCurrentLocation(bShowCurrentLocation: boolean): sap.uxap.BreadCrumbs;
}
/**
* A select that display items on 2 level of hierarchy.
* If a provided item has a custom data named "secondLevel", then it will be displayed as a second level, otherwise it would be displayed as a first level.
*/
export class HierarchicalSelect extends sap.m.Select {
/**
* Constructor for a new HierarchicalSelect.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.uxap.HierarchicalSelect with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.Select.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.uxap.HierarchicalSelect.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getUpperCase upperCase}.
*
* Determines whether the HierarchicalSelect items are displayed in upper case.
*
* Default value is false
.
* @returns {boolean} Value of property upperCase
*/
public getUpperCase(): boolean;
/**
* Sets a new value for property {@link #getUpperCase upperCase}.
*
* Determines whether the HierarchicalSelect items are displayed in upper case.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bUpperCase - New value for property upperCase
* @returns {sap.uxap.HierarchicalSelect} Reference to this
in order to allow method chaining
*/
public setUpperCase(bUpperCase: boolean): sap.uxap.HierarchicalSelect;
}
/**
* Used by the ObjectSectionBase control to define the importance of the content contained in it.
*/
export enum Importance {
/**
* High importance of the content
*/
High = "High",
/**
* Low importance of the content
*/
Low = "Low",
/**
* Medium importance of the content
*/
Medium = "Medium",
}
/**
* Define the entity that will be passed to the ObjectPageLayout.
*/
export class ModelMapping extends sap.ui.core.Element {
/**
* Constructor for a new ModelMapping.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - Initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.uxap.ModelMapping with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getExternalModelName externalModelName}.
*
* Determines the the external model name.
* @returns {string} Value of property externalModelName
*/
public getExternalModelName(): string;
/**
* Gets current value of property {@link #getExternalPath externalPath}.
*
* Determines the the external path.
* @returns {string} Value of property externalPath
*/
public getExternalPath(): string;
/**
* Gets current value of property {@link #getInternalModelName internalModelName}.
*
* Determines the the internal model name.
*
* Default value is Model
.
* @returns {string} Value of property internalModelName
*/
public getInternalModelName(): string;
/**
* Returns a metadata object for class sap.uxap.ModelMapping.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets a new value for property {@link #getExternalModelName externalModelName}.
*
* Determines the the external model name.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sExternalModelName - New value for property externalModelName
* @returns {sap.uxap.ModelMapping} Reference to this
in order to allow method chaining
*/
public setExternalModelName(sExternalModelName: string): sap.uxap.ModelMapping;
/**
* Sets a new value for property {@link #getExternalPath externalPath}.
*
* Determines the the external path.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sExternalPath - New value for property externalPath
* @returns {sap.uxap.ModelMapping} Reference to this
in order to allow method chaining
*/
public setExternalPath(sExternalPath: string): sap.uxap.ModelMapping;
/**
* Sets a new value for property {@link #getInternalModelName internalModelName}.
*
* Determines the the internal model name.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Model
.
* @param {string} sInternalModelName - New value for property internalModelName
* @returns {sap.uxap.ModelMapping} Reference to this
in order to allow method chaining
*/
public setInternalModelName(sInternalModelName: string): sap.uxap.ModelMapping;
}
/**
* Used by the sap.uxap.component.Component how to initialize the ObjectPageLayout sections and subsections.
*/
export enum ObjectPageConfigurationMode {
/**
* Determines the JSON model
*/
JsonModel = "JsonModel",
/**
* Determines the JSON url
*/
JsonURL = "JsonURL",
}
/**
* ObjectPageHeader represents the static part of an Object page header.
* Typically used to display the basic information about a business object, such as title/description/picture, as well as a list of common actions.
*/
export class ObjectPageHeader extends sap.ui.core.Control {
/**
* Constructor for a new ObjectPageHeader.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some action to the aggregation {@link #getActions actions}.
* @param {sap.ui.core.Control} oAction - the action to add; if empty, nothing is inserted
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public addAction(oAction: sap.ui.core.Control): sap.uxap.ObjectPageHeader;
/**
* Adds some breadCrumbLink to the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
* @param {sap.m.Link} oBreadCrumbLink - the breadCrumbLink to add; if empty, nothing is inserted
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public addBreadCrumbLink(oBreadCrumbLink: sap.m.Link): sap.uxap.ObjectPageHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:markChangesPress markChangesPress} event of this sap.uxap.ObjectPageHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.uxap.ObjectPageHeader
itself.
*
* The event is fired when the unsaved changes button is pressed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageHeader
itself
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public attachMarkChangesPress(fnFunction: Function, oListener?: any): sap.uxap.ObjectPageHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:markChangesPress markChangesPress} event of this sap.uxap.ObjectPageHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.uxap.ObjectPageHeader
itself.
*
* The event is fired when the unsaved changes button is pressed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageHeader
itself
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public attachMarkChangesPress(oData: any, fnFunction: Function, oListener?: any): sap.uxap.ObjectPageHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:markLockedPress markLockedPress} event of this sap.uxap.ObjectPageHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.uxap.ObjectPageHeader
itself.
*
* The event is fired when the Locked button is pressed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageHeader
itself
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public attachMarkLockedPress(fnFunction: Function, oListener?: any): sap.uxap.ObjectPageHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:markLockedPress markLockedPress} event of this sap.uxap.ObjectPageHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.uxap.ObjectPageHeader
itself.
*
* The event is fired when the Locked button is pressed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageHeader
itself
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public attachMarkLockedPress(oData: any, fnFunction: Function, oListener?: any): sap.uxap.ObjectPageHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:titleSelectorPress titleSelectorPress} event of this sap.uxap.ObjectPageHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.uxap.ObjectPageHeader
itself.
*
* The event is fired when the objectPage header title selector (down-arrow) is pressed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageHeader
itself
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public attachTitleSelectorPress(fnFunction: Function, oListener?: any): sap.uxap.ObjectPageHeader;
/**
* Attaches event handler fnFunction
to the {@link #event:titleSelectorPress titleSelectorPress} event of this sap.uxap.ObjectPageHeader
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.uxap.ObjectPageHeader
itself.
*
* The event is fired when the objectPage header title selector (down-arrow) is pressed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageHeader
itself
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public attachTitleSelectorPress(oData: any, fnFunction: Function, oListener?: any): sap.uxap.ObjectPageHeader;
/**
* Destroys all the actions in the aggregation {@link #getActions actions}.
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public destroyActions(): sap.uxap.ObjectPageHeader;
/**
* Destroys all the breadCrumbsLinks in the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public destroyBreadCrumbsLinks(): sap.uxap.ObjectPageHeader;
/**
* Destroys the navigationBar in the aggregation {@link #getNavigationBar navigationBar}.
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public destroyNavigationBar(): sap.uxap.ObjectPageHeader;
/**
* Destroys the sideContentButton in the aggregation {@link #getSideContentButton sideContentButton}.
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public destroySideContentButton(): sap.uxap.ObjectPageHeader;
/**
* Detaches event handler fnFunction
from the {@link #event:markChangesPress markChangesPress} event of this sap.uxap.ObjectPageHeader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public detachMarkChangesPress(fnFunction: Function, oListener: any): sap.uxap.ObjectPageHeader;
/**
* Detaches event handler fnFunction
from the {@link #event:markLockedPress markLockedPress} event of this sap.uxap.ObjectPageHeader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public detachMarkLockedPress(fnFunction: Function, oListener: any): sap.uxap.ObjectPageHeader;
/**
* Detaches event handler fnFunction
from the {@link #event:titleSelectorPress titleSelectorPress} event of this sap.uxap.ObjectPageHeader
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public detachTitleSelectorPress(fnFunction: Function, oListener: any): sap.uxap.ObjectPageHeader;
/**
* Creates a new subclass of class sap.uxap.ObjectPageHeader with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:markChangesPress markChangesPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
protected fireMarkChangesPress(mParameters?: any): sap.uxap.ObjectPageHeader;
/**
* Fires event {@link #event:markLockedPress markLockedPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
protected fireMarkLockedPress(mParameters?: any): sap.uxap.ObjectPageHeader;
/**
* Fires event {@link #event:titleSelectorPress titleSelectorPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
protected fireTitleSelectorPress(mParameters?: any): sap.uxap.ObjectPageHeader;
/**
* Gets content of aggregation {@link #getActions actions}.
*
* List of actions that will be displayed in the header.
* You can use ObjectPageHeaderActionButton controls to achieve a different visual representation of the action buttons in the action bar and the action sheet (overflow menu).
* You can use ObjectPageHeaderLayoutData to display a visual separator.
* @returns {sap.ui.core.Control[]}
*/
public getActions(): sap.ui.core.Control[];
/**
* Gets content of aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
*
* A list of all the active link elements in the BreadCrumbs control.
* @returns {sap.m.Link[]}
*/
public getBreadCrumbsLinks(): sap.m.Link[];
/**
* Gets current value of property {@link #getHeaderDesign headerDesign}.
*
* Determines the design of the header - Light or Dark.
* Note: This property is deprecated. It will continue to work in the Blue Crystal theme,
* but it will not be taken into account for the Belize themes.
*
* Default value is Light
.
* @returns {sap.uxap.ObjectPageHeaderDesign} Value of property headerDesign
*/
public getHeaderDesign(): sap.uxap.ObjectPageHeaderDesign;
/**
* Gets current value of property {@link #getIsActionAreaAlwaysVisible isActionAreaAlwaysVisible}.
*
* Determines whether the action buttons should always be visible or visible only when the header is snapped.
*
* Default value is true
.
* @returns {boolean} Value of property isActionAreaAlwaysVisible
*/
public getIsActionAreaAlwaysVisible(): boolean;
/**
* Gets current value of property {@link #getIsObjectIconAlwaysVisible isObjectIconAlwaysVisible}.
*
* Determines whether the icon should always be visible or visible only when the header is snapped.
*
* Default value is false
.
* @returns {boolean} Value of property isObjectIconAlwaysVisible
*/
public getIsObjectIconAlwaysVisible(): boolean;
/**
* Gets current value of property {@link #getIsObjectSubtitleAlwaysVisible isObjectSubtitleAlwaysVisible}.
*
* Determines whether the subtitle should always be visible or visible only when the header is snapped.
*
* Default value is true
.
* @returns {boolean} Value of property isObjectSubtitleAlwaysVisible
*/
public getIsObjectSubtitleAlwaysVisible(): boolean;
/**
* Gets current value of property {@link #getIsObjectTitleAlwaysVisible isObjectTitleAlwaysVisible}.
*
* Determines whether the title should always be visible or visible only when the header is snapped.
*
* Default value is true
.
* @returns {boolean} Value of property isObjectTitleAlwaysVisible
*/
public getIsObjectTitleAlwaysVisible(): boolean;
/**
* Gets current value of property {@link #getMarkChanges markChanges}.
*
* Marks that there are unsaved changes in the objectPageHeader.
* The markChanges state cannot be used together with the markLocked state.
* If both are set to true, only the locked state will be displayed.
*
* Default value is false
.
* @returns {boolean} Value of property markChanges
*/
public getMarkChanges(): boolean;
/**
* Gets current value of property {@link #getMarkFavorite markFavorite}.
*
* Set the favorite state to true or false. The showMarkers property must be true for this property to take effect.
*
* Default value is false
.
* @returns {boolean} Value of property markFavorite
*/
public getMarkFavorite(): boolean;
/**
* Gets current value of property {@link #getMarkFlagged markFlagged}.
*
* Set the flagged state to true or false. The showMarkers property must be true for this property to take effect.
*
* Default value is false
.
* @returns {boolean} Value of property markFlagged
*/
public getMarkFlagged(): boolean;
/**
* Gets current value of property {@link #getMarkLocked markLocked}.
*
* Set the locked state of the objectPageHeader.
*
* Default value is false
.
* @returns {boolean} Value of property markLocked
*/
public getMarkLocked(): boolean;
/**
* Returns a metadata object for class sap.uxap.ObjectPageHeader.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets content of aggregation {@link #getNavigationBar navigationBar}.
*
* An instance of sap.m.Bar to be embedded in the header
* @returns {sap.m.Bar}
*/
public getNavigationBar(): sap.m.Bar;
/**
* Gets current value of property {@link #getObjectImageAlt objectImageAlt}.
*
* The text to be used for the Alt and Tooltip attribute of the image, supplied via the objectImageURI property
*
* Default value is
.
* @returns {string} Value of property objectImageAlt
*/
public getObjectImageAlt(): string;
/**
* Gets current value of property {@link #getObjectImageDensityAware objectImageDensityAware}.
*
* The value of densityAware for the image, supplied via the objectImageURI property.
* See sap.m.Image for more details on densityAware.
*
* Default value is false
.
* @returns {boolean} Value of property objectImageDensityAware
*/
public getObjectImageDensityAware(): boolean;
/**
* Gets current value of property {@link #getObjectImageShape objectImageShape}.
*
* Determines whether the picture should be displayed in a square or with a circle-shaped mask.
*
* Default value is Square
.
* @returns {sap.uxap.ObjectPageHeaderPictureShape} Value of property objectImageShape
*/
public getObjectImageShape(): sap.uxap.ObjectPageHeaderPictureShape;
/**
* Gets current value of property {@link #getObjectImageURI objectImageURI}.
*
* The URL of the image, representing the business object
* @returns {string} Value of property objectImageURI
*/
public getObjectImageURI(): string;
/**
* Gets current value of property {@link #getObjectSubtitle objectSubtitle}.
*
* The description of the object
* @returns {string} Value of property objectSubtitle
*/
public getObjectSubtitle(): string;
/**
* Gets current value of property {@link #getObjectTitle objectTitle}.
*
* The title of the object
* @returns {string} Value of property objectTitle
*/
public getObjectTitle(): string;
/**
* Gets current value of property {@link #getShowMarkers showMarkers}.
*
* Indicates if object page header title supports showing markers such as flagged and favorite.
*
* Default value is false
.
* @returns {boolean} Value of property showMarkers
*/
public getShowMarkers(): boolean;
/**
* Gets current value of property {@link #getShowPlaceholder showPlaceholder}.
*
* Enables support of a placeholder image in case no image is specified or the URL of the provided image is invalid.
*
* Default value is false
.
* @returns {boolean} Value of property showPlaceholder
*/
public getShowPlaceholder(): boolean;
/**
* Gets current value of property {@link #getShowTitleSelector showTitleSelector}.
*
* When set to true, the selector arrow icon/image is shown and can be pressed.
*
* Default value is false
.
* @returns {boolean} Value of property showTitleSelector
*/
public getShowTitleSelector(): boolean;
/**
* Gets content of aggregation {@link #getSideContentButton sideContentButton}.
*
* A button that is used for opening the side content of the page or some additional content.
* @returns {sap.m.Button}
*/
public getSideContentButton(): sap.m.Button;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getActions actions}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oAction - The action whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAction(oAction: sap.ui.core.Control): number;
/**
* Checks for the provided sap.m.Link
in the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
* and returns its index if found or -1 otherwise.
* @param {sap.m.Link} oBreadCrumbLink - The breadCrumbLink whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfBreadCrumbLink(oBreadCrumbLink: sap.m.Link): number;
/**
* Inserts a action into the aggregation {@link #getActions actions}.
* @param {sap.ui.core.Control} oAction - the action to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the action should be inserted at; for a negative value of iIndex
, the action is inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted at the last position
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public insertAction(oAction: sap.ui.core.Control, iIndex: number): sap.uxap.ObjectPageHeader;
/**
* Inserts a breadCrumbLink into the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
* @param {sap.m.Link} oBreadCrumbLink - the breadCrumbLink to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the breadCrumbLink should be inserted at; for a negative value of iIndex
, the breadCrumbLink is inserted at position 0; for a value greater than the current size of the aggregation, the breadCrumbLink is inserted at the last position
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public insertBreadCrumbLink(oBreadCrumbLink: sap.m.Link, iIndex: number): sap.uxap.ObjectPageHeader;
/**
* Removes a action from the aggregation {@link #getActions actions}.
* @param {number|string|sap.ui.core.Control} vAction - The action to remove or its index or id
* @returns {sap.ui.core.Control} The removed action or null
*/
public removeAction(vAction: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes all the controls from the aggregation {@link #getActions actions}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllActions(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.m.Link[]} An array of the removed elements (might be empty)
*/
public removeAllBreadCrumbsLinks(): sap.m.Link[];
/**
* Removes a breadCrumbLink from the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
* @param {number|string|sap.m.Link} vBreadCrumbLink - The breadCrumbLink to remove or its index or id
* @returns {sap.m.Link} The removed breadCrumbLink or null
*/
public removeBreadCrumbLink(vBreadCrumbLink: number|string|sap.m.Link): sap.m.Link;
/**
* Sets a new value for property {@link #getHeaderDesign headerDesign}.
*
* Determines the design of the header - Light or Dark.
* Note: This property is deprecated. It will continue to work in the Blue Crystal theme,
* but it will not be taken into account for the Belize themes.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Light
.
* @param {sap.uxap.ObjectPageHeaderDesign} sHeaderDesign - New value for property headerDesign
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setHeaderDesign(sHeaderDesign: sap.uxap.ObjectPageHeaderDesign): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getIsActionAreaAlwaysVisible isActionAreaAlwaysVisible}.
*
* Determines whether the action buttons should always be visible or visible only when the header is snapped.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIsActionAreaAlwaysVisible - New value for property isActionAreaAlwaysVisible
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setIsActionAreaAlwaysVisible(bIsActionAreaAlwaysVisible: boolean): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getIsObjectIconAlwaysVisible isObjectIconAlwaysVisible}.
*
* Determines whether the icon should always be visible or visible only when the header is snapped.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bIsObjectIconAlwaysVisible - New value for property isObjectIconAlwaysVisible
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setIsObjectIconAlwaysVisible(bIsObjectIconAlwaysVisible: boolean): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getIsObjectSubtitleAlwaysVisible isObjectSubtitleAlwaysVisible}.
*
* Determines whether the subtitle should always be visible or visible only when the header is snapped.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIsObjectSubtitleAlwaysVisible - New value for property isObjectSubtitleAlwaysVisible
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setIsObjectSubtitleAlwaysVisible(bIsObjectSubtitleAlwaysVisible: boolean): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getIsObjectTitleAlwaysVisible isObjectTitleAlwaysVisible}.
*
* Determines whether the title should always be visible or visible only when the header is snapped.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bIsObjectTitleAlwaysVisible - New value for property isObjectTitleAlwaysVisible
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setIsObjectTitleAlwaysVisible(bIsObjectTitleAlwaysVisible: boolean): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getMarkChanges markChanges}.
*
* Marks that there are unsaved changes in the objectPageHeader.
* The markChanges state cannot be used together with the markLocked state.
* If both are set to true, only the locked state will be displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bMarkChanges - New value for property markChanges
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setMarkChanges(bMarkChanges: boolean): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getMarkFavorite markFavorite}.
*
* Set the favorite state to true or false. The showMarkers property must be true for this property to take effect.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bMarkFavorite - New value for property markFavorite
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setMarkFavorite(bMarkFavorite: boolean): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getMarkFlagged markFlagged}.
*
* Set the flagged state to true or false. The showMarkers property must be true for this property to take effect.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bMarkFlagged - New value for property markFlagged
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setMarkFlagged(bMarkFlagged: boolean): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getMarkLocked markLocked}.
*
* Set the locked state of the objectPageHeader.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bMarkLocked - New value for property markLocked
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setMarkLocked(bMarkLocked: boolean): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getObjectImageAlt objectImageAlt}.
*
* The text to be used for the Alt and Tooltip attribute of the image, supplied via the objectImageURI property
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is
.
* @param {string} sObjectImageAlt - New value for property objectImageAlt
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setObjectImageAlt(sObjectImageAlt: string): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getObjectImageDensityAware objectImageDensityAware}.
*
* The value of densityAware for the image, supplied via the objectImageURI property.
* See sap.m.Image for more details on densityAware.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bObjectImageDensityAware - New value for property objectImageDensityAware
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setObjectImageDensityAware(bObjectImageDensityAware: boolean): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getObjectImageShape objectImageShape}.
*
* Determines whether the picture should be displayed in a square or with a circle-shaped mask.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Square
.
* @param {sap.uxap.ObjectPageHeaderPictureShape} sObjectImageShape - New value for property objectImageShape
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setObjectImageShape(sObjectImageShape: sap.uxap.ObjectPageHeaderPictureShape): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getObjectImageURI objectImageURI}.
*
* The URL of the image, representing the business object
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sObjectImageURI - New value for property objectImageURI
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setObjectImageURI(sObjectImageURI: string): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getObjectSubtitle objectSubtitle}.
*
* The description of the object
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sObjectSubtitle - New value for property objectSubtitle
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setObjectSubtitle(sObjectSubtitle: string): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getShowMarkers showMarkers}.
*
* Indicates if object page header title supports showing markers such as flagged and favorite.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowMarkers - New value for property showMarkers
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setShowMarkers(bShowMarkers: boolean): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getShowPlaceholder showPlaceholder}.
*
* Enables support of a placeholder image in case no image is specified or the URL of the provided image is invalid.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowPlaceholder - New value for property showPlaceholder
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setShowPlaceholder(bShowPlaceholder: boolean): sap.uxap.ObjectPageHeader;
/**
* Sets a new value for property {@link #getShowTitleSelector showTitleSelector}.
*
* When set to true, the selector arrow icon/image is shown and can be pressed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowTitleSelector - New value for property showTitleSelector
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setShowTitleSelector(bShowTitleSelector: boolean): sap.uxap.ObjectPageHeader;
/**
* Sets the aggregated {@link #getSideContentButton sideContentButton}.
* @param {sap.m.Button} oSideContentButton - The sideContentButton to set
* @returns {sap.uxap.ObjectPageHeader} Reference to this
in order to allow method chaining
*/
public setSideContentButton(oSideContentButton: sap.m.Button): sap.uxap.ObjectPageHeader;
}
/**
* Button that can be used in the ObjectPageHeader action aggregation.
*/
export class ObjectPageHeaderActionButton extends sap.m.Button {
/**
* Constructor for a new ObjectPageHeaderActionButton.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.uxap.ObjectPageHeaderActionButton with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.m.Button.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets current value of property {@link #getHideIcon hideIcon}.
*
* Hide the button icon when rendered into the headerTitle part of the ObjectPageLayout.
* This is useful if you want to display texts only in the headerTitle part but still want to display text + icon in the actionSheet that appears when not enough space is available on the screen for displaying all actions.
*
* Default value is false
.
* @returns {boolean} Value of property hideIcon
*/
public getHideIcon(): boolean;
/**
* Gets current value of property {@link #getHideText hideText}.
*
* Hide the button text when rendered into the headerTitle part of the ObjectPageLayout.
* This is useful if you want to display icons only in the headerTitle part but still want to display text + icon in the actionSheet that appears when not enough space is available on the screen for displaying all actions.
*
* Default value is true
.
* @returns {boolean} Value of property hideText
*/
public getHideText(): boolean;
/**
* Gets current value of property {@link #getImportance importance}.
*
* Determines the order in which the button overflows.
*
* Default value is library.Importance.High
.
* @returns {sap.uxap.Importance} Value of property importance
*/
public getImportance(): sap.uxap.Importance;
/**
* Returns a metadata object for class sap.uxap.ObjectPageHeaderActionButton.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Sets a new value for property {@link #getHideIcon hideIcon}.
*
* Hide the button icon when rendered into the headerTitle part of the ObjectPageLayout.
* This is useful if you want to display texts only in the headerTitle part but still want to display text + icon in the actionSheet that appears when not enough space is available on the screen for displaying all actions.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bHideIcon - New value for property hideIcon
* @returns {sap.uxap.ObjectPageHeaderActionButton} Reference to this
in order to allow method chaining
*/
public setHideIcon(bHideIcon: boolean): sap.uxap.ObjectPageHeaderActionButton;
/**
* Sets a new value for property {@link #getHideText hideText}.
*
* Hide the button text when rendered into the headerTitle part of the ObjectPageLayout.
* This is useful if you want to display icons only in the headerTitle part but still want to display text + icon in the actionSheet that appears when not enough space is available on the screen for displaying all actions.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bHideText - New value for property hideText
* @returns {sap.uxap.ObjectPageHeaderActionButton} Reference to this
in order to allow method chaining
*/
public setHideText(bHideText: boolean): sap.uxap.ObjectPageHeaderActionButton;
/**
* Sets a new value for property {@link #getImportance importance}.
*
* Determines the order in which the button overflows.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is library.Importance.High
.
* @param {sap.uxap.Importance} sImportance - New value for property importance
* @returns {sap.uxap.ObjectPageHeaderActionButton} Reference to this
in order to allow method chaining
*/
public setImportance(sImportance: sap.uxap.Importance): sap.uxap.ObjectPageHeaderActionButton;
}
/**
* ObjectPageHeaderContent represents the dynamic part of an Object page header. May contain any control.
* Unlike the Object page header title, the Object page header content is part of the scrolling area of the Object page.
* This enables it to hold any amount of information and still be usable on a mobile device.
*/
export class ObjectPageHeaderContent extends sap.ui.core.Control {
/**
* Constructor for a new ObjectPageHeaderContent.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.uxap.ObjectPageHeaderContent} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.uxap.ObjectPageHeaderContent;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.uxap.ObjectPageHeaderContent} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.uxap.ObjectPageHeaderContent;
/**
* Creates a new subclass of class sap.uxap.ObjectPageHeaderContent with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* The list of Objects of type sap.ui.core.Control.
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getContentDesign contentDesign}.
*
* Determines the design of the header - Light or Dark.
* Note: This property is deprecated. It will continue to work in the Blue Crystal theme,
* but it will not be taken into account for the Belize themes.
*
* Default value is Light
.
* @returns {sap.uxap.ObjectPageHeaderDesign} Value of property contentDesign
*/
public getContentDesign(): sap.uxap.ObjectPageHeaderDesign;
/**
* Returns a metadata object for class sap.uxap.ObjectPageHeaderContent.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.uxap.ObjectPageHeaderContent} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.uxap.ObjectPageHeaderContent;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getContentDesign contentDesign}.
*
* Determines the design of the header - Light or Dark.
* Note: This property is deprecated. It will continue to work in the Blue Crystal theme,
* but it will not be taken into account for the Belize themes.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Light
.
* @param {sap.uxap.ObjectPageHeaderDesign} sContentDesign - New value for property contentDesign
* @returns {sap.uxap.ObjectPageHeaderContent} Reference to this
in order to allow method chaining
*/
public setContentDesign(sContentDesign: sap.uxap.ObjectPageHeaderDesign): sap.uxap.ObjectPageHeaderContent;
}
/**
* Used by the ObjectPageHeader control to define which design to use.
*/
export enum ObjectPageHeaderDesign {
/**
* Dark theme for the ObjectPageHeader.
*/
Dark = "Dark",
/**
* Light theme for the ObjectPageHeader.
*/
Light = "Light",
}
/**
* This is a LayoutData Element that can be added to a control if this control is used within an ObjectPage headerContent aggregation
*/
export class ObjectPageHeaderLayoutData extends sap.ui.core.LayoutData {
/**
* Constructor for a new ObjectPageHeaderLayoutData.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Creates a new subclass of class sap.uxap.ObjectPageHeaderLayoutData with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.LayoutData.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.uxap.ObjectPageHeaderLayoutData.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getShowSeparatorAfter showSeparatorAfter}.
*
* If this property is set the control will display a separator after it.
*
* Default value is false
.
* @returns {boolean} Value of property showSeparatorAfter
*/
public getShowSeparatorAfter(): boolean;
/**
* Gets current value of property {@link #getShowSeparatorBefore showSeparatorBefore}.
*
* If this property is set the control will display a separator before it.
*
* Default value is false
.
* @returns {boolean} Value of property showSeparatorBefore
*/
public getShowSeparatorBefore(): boolean;
/**
* Gets current value of property {@link #getVisibleL visibleL}.
*
* If this property is set the control will be visible (or not) in a large sized layout.
*
* Default value is true
.
* @returns {boolean} Value of property visibleL
*/
public getVisibleL(): boolean;
/**
* Gets current value of property {@link #getVisibleM visibleM}.
*
* If this property is set the control will be visible (or not) in a medium sized layout.
*
* Default value is true
.
* @returns {boolean} Value of property visibleM
*/
public getVisibleM(): boolean;
/**
* Gets current value of property {@link #getVisibleS visibleS}.
*
* If this property is set the control will be visible (or not) in a small sized layout.
*
* Default value is true
.
* @returns {boolean} Value of property visibleS
*/
public getVisibleS(): boolean;
/**
* Gets current value of property {@link #getWidth width}.
*
* If this property is set the control will take the provided size.
*
* Default value is auto
.
* @returns {sap.ui.core.CSSSize} Value of property width
*/
public getWidth(): sap.ui.core.CSSSize;
/**
* Sets a new value for property {@link #getShowSeparatorAfter showSeparatorAfter}.
*
* If this property is set the control will display a separator after it.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowSeparatorAfter - New value for property showSeparatorAfter
* @returns {sap.uxap.ObjectPageHeaderLayoutData} Reference to this
in order to allow method chaining
*/
public setShowSeparatorAfter(bShowSeparatorAfter: boolean): sap.uxap.ObjectPageHeaderLayoutData;
/**
* Sets a new value for property {@link #getShowSeparatorBefore showSeparatorBefore}.
*
* If this property is set the control will display a separator before it.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowSeparatorBefore - New value for property showSeparatorBefore
* @returns {sap.uxap.ObjectPageHeaderLayoutData} Reference to this
in order to allow method chaining
*/
public setShowSeparatorBefore(bShowSeparatorBefore: boolean): sap.uxap.ObjectPageHeaderLayoutData;
/**
* Sets a new value for property {@link #getVisibleL visibleL}.
*
* If this property is set the control will be visible (or not) in a large sized layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisibleL - New value for property visibleL
* @returns {sap.uxap.ObjectPageHeaderLayoutData} Reference to this
in order to allow method chaining
*/
public setVisibleL(bVisibleL: boolean): sap.uxap.ObjectPageHeaderLayoutData;
/**
* Sets a new value for property {@link #getVisibleM visibleM}.
*
* If this property is set the control will be visible (or not) in a medium sized layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisibleM - New value for property visibleM
* @returns {sap.uxap.ObjectPageHeaderLayoutData} Reference to this
in order to allow method chaining
*/
public setVisibleM(bVisibleM: boolean): sap.uxap.ObjectPageHeaderLayoutData;
/**
* Sets a new value for property {@link #getVisibleS visibleS}.
*
* If this property is set the control will be visible (or not) in a small sized layout.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisibleS - New value for property visibleS
* @returns {sap.uxap.ObjectPageHeaderLayoutData} Reference to this
in order to allow method chaining
*/
public setVisibleS(bVisibleS: boolean): sap.uxap.ObjectPageHeaderLayoutData;
/**
* Sets a new value for property {@link #getWidth width}.
*
* If this property is set the control will take the provided size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is auto
.
* @param {sap.ui.core.CSSSize} sWidth - New value for property width
* @returns {sap.uxap.ObjectPageHeaderLayoutData} Reference to this
in order to allow method chaining
*/
public setWidth(sWidth: sap.ui.core.CSSSize): sap.uxap.ObjectPageHeaderLayoutData;
}
/**
* Used by the ObjectPageHeader control to define which shape to use for the image.
*/
export enum ObjectPageHeaderPictureShape {
/**
* Circle shape for the images in the ObjectPageHeader.
*/
Circle = "Circle",
/**
* Square shape for the images in the ObjectPageHeader.
*/
Square = "Square",
}
/**
* An ObjectPageLayout is the layout control, used to put together all parts of an Object page - Header, Navigation bar and Sections/Subsections.
*/
export class ObjectPageLayout extends sap.ui.core.Control {
/**
* Constructor for a new ObjectPageLayout.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Resume layout calculations and call _adjustLayoutAndUxRules (f.e. once buld updates are over)
*/
protected _resumeLayoutCalculations(): void;
/**
* Stop layout calculations temporarily (f.e. to do bulk updates on the object page)
*/
protected _suppressLayoutCalculations(): void;
/**
* Resets the internal information of which subsections are in view and immediately
* calls the layout calculation so that an event subSectionEnteredViewPort
is fired
* for the subsections that are actually in view. Use this method after a change in bindings
* to the existing object, since it's layout might have changed and the app
* needs to react to the new subsections in view.
*/
protected _triggerVisibleSubSectionsEvents(): void;
/**
* Adds some headerContent to the aggregation {@link #getHeaderContent headerContent}.
* @param {sap.ui.core.Control} oHeaderContent - the headerContent to add; if empty, nothing is inserted
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public addHeaderContent(oHeaderContent: sap.ui.core.Control): sap.uxap.ObjectPageLayout;
/**
* Adds some section to the aggregation {@link #getSections sections}.
* @param {sap.uxap.ObjectPageSection} oSection - the section to add; if empty, nothing is inserted
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public addSection(oSection: sap.uxap.ObjectPageSection): sap.uxap.ObjectPageLayout;
/**
* Attaches event handler fnFunction
to the {@link #event:editHeaderButtonPress editHeaderButtonPress} event of this sap.uxap.ObjectPageLayout
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.uxap.ObjectPageLayout
itself.
*
* The event is fired when the Edit Header button is pressed
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageLayout
itself
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public attachEditHeaderButtonPress(fnFunction: Function, oListener?: any): sap.uxap.ObjectPageLayout;
/**
* Attaches event handler fnFunction
to the {@link #event:editHeaderButtonPress editHeaderButtonPress} event of this sap.uxap.ObjectPageLayout
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.uxap.ObjectPageLayout
itself.
*
* The event is fired when the Edit Header button is pressed
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageLayout
itself
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public attachEditHeaderButtonPress(oData: any, fnFunction: Function, oListener?: any): sap.uxap.ObjectPageLayout;
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.uxap.ObjectPageLayout
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.uxap.ObjectPageLayout
itself.
*
* The event is fired when the selected section is changed using the navigation.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageLayout
itself
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public attachNavigate(fnFunction: Function, oListener?: any): sap.uxap.ObjectPageLayout;
/**
* Attaches event handler fnFunction
to the {@link #event:navigate navigate} event of this sap.uxap.ObjectPageLayout
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.uxap.ObjectPageLayout
itself.
*
* The event is fired when the selected section is changed using the navigation.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageLayout
itself
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public attachNavigate(oData: any, fnFunction: Function, oListener?: any): sap.uxap.ObjectPageLayout;
/**
* Attaches event handler fnFunction
to the {@link #event:toggleAnchorBar toggleAnchorBar} event of this sap.uxap.ObjectPageLayout
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.uxap.ObjectPageLayout
itself.
*
* The event is fired when the Anchor bar is switched from moving to fixed or the other way round.
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageLayout
itself
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public attachToggleAnchorBar(fnFunction: Function, oListener?: any): sap.uxap.ObjectPageLayout;
/**
* Attaches event handler fnFunction
to the {@link #event:toggleAnchorBar toggleAnchorBar} event of this sap.uxap.ObjectPageLayout
.
*
* When called, the context of the event handler (its this
) will be bound to oListener
if specified,
* otherwise it will be bound to this sap.uxap.ObjectPageLayout
itself.
*
* The event is fired when the Anchor bar is switched from moving to fixed or the other way round.
* @param {any} oData - An application-specific payload object that will be passed to the event handler along with the event object when firing the event
* @param {Function} fnFunction - The function to be called when the event occurs
* @param {any} oListener - Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageLayout
itself
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public attachToggleAnchorBar(oData: any, fnFunction: Function, oListener?: any): sap.uxap.ObjectPageLayout;
/**
* Destroys the footer in the aggregation {@link #getFooter footer}.
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public destroyFooter(): sap.uxap.ObjectPageLayout;
/**
* Destroys all the headerContent in the aggregation {@link #getHeaderContent headerContent}.
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public destroyHeaderContent(): sap.uxap.ObjectPageLayout;
/**
* Destroys the headerTitle in the aggregation {@link #getHeaderTitle headerTitle}.
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public destroyHeaderTitle(): sap.uxap.ObjectPageLayout;
/**
* Destroys all the sections in the aggregation {@link #getSections sections}.
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public destroySections(): sap.uxap.ObjectPageLayout;
/**
* Detaches event handler fnFunction
from the {@link #event:editHeaderButtonPress editHeaderButtonPress} event of this sap.uxap.ObjectPageLayout
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public detachEditHeaderButtonPress(fnFunction: Function, oListener: any): sap.uxap.ObjectPageLayout;
/**
* Detaches event handler fnFunction
from the {@link #event:navigate navigate} event of this sap.uxap.ObjectPageLayout
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public detachNavigate(fnFunction: Function, oListener: any): sap.uxap.ObjectPageLayout;
/**
* Detaches event handler fnFunction
from the {@link #event:toggleAnchorBar toggleAnchorBar} event of this sap.uxap.ObjectPageLayout
.
*
* The passed function and listener object must match the ones used for event registration.
* @param {Function} fnFunction - The function to be called, when the event occurs
* @param {any} oListener - Context object on which the given function had to be called
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public detachToggleAnchorBar(fnFunction: Function, oListener: any): sap.uxap.ObjectPageLayout;
/**
* Creates a new subclass of class sap.uxap.ObjectPageLayout with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Fires event {@link #event:editHeaderButtonPress editHeaderButtonPress} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
protected fireEditHeaderButtonPress(mParameters?: any): sap.uxap.ObjectPageLayout;
/**
* Fires event {@link #event:navigate navigate} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
protected fireNavigate(mParameters?: any): sap.uxap.ObjectPageLayout;
/**
* Fires event {@link #event:toggleAnchorBar toggleAnchorBar} to attached listeners.
* @param {any} mParameters - Parameters to pass along with the event
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
protected fireToggleAnchorBar(mParameters?: any): sap.uxap.ObjectPageLayout;
/**
* Gets current value of property {@link #getAlwaysShowContentHeader alwaysShowContentHeader}.
*
* Determines whether Header Content will always be expanded on desktop.
*
* Default value is false
.
* @returns {boolean} Value of property alwaysShowContentHeader
*/
public getAlwaysShowContentHeader(): boolean;
/**
* Gets current value of property {@link #getEnableLazyLoading enableLazyLoading}.
*
* Enable lazy loading for the Object page Subsections.
*
* Default value is false
.
* @returns {boolean} Value of property enableLazyLoading
*/
public getEnableLazyLoading(): boolean;
/**
* Gets current value of property {@link #getFlexEnabled flexEnabled}.
*
* Specifies whether the object page enables flexibility features, such as hiding and adding sections.
* For more information about SAPUI5 flexibility, refer to the Developer Guide.
*
* Default value is false
.
* @returns {boolean} Value of property flexEnabled
*/
public getFlexEnabled(): boolean;
/**
* Gets content of aggregation {@link #getFooter footer}.
*
* Object page floating footer.
* @returns {sap.m.IBar}
*/
public getFooter(): sap.m.IBar;
/**
* Gets content of aggregation {@link #getHeaderTitle headerTitle}.
*
* Object page header title - the upper, always static, part of the Object page header.
* @returns {sap.uxap.ObjectPageHeader}
*/
public getHeaderTitle(): sap.uxap.ObjectPageHeader;
/**
* Gets current value of property {@link #getHeight height}.
*
* Determines the height of the ObjectPage.
*
* Default value is 100%
.
* @returns {sap.ui.core.CSSSize} Value of property height
*/
public getHeight(): sap.ui.core.CSSSize;
/**
* Gets current value of property {@link #getIsChildPage isChildPage}.
*
* Determines whether the page is a child page and renders it with a different design.
* Child pages have an additional (darker/lighter) stripe on the left side of their header content area.
*
* Default value is false
.
* @returns {boolean} Value of property isChildPage
*/
public getIsChildPage(): boolean;
/**
* Returns a metadata object for class sap.uxap.ObjectPageLayout.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Returns an sap.ui.core.delegate.ScrollEnablement object used to handle scrolling
* @returns {any}
*/
public getScrollDelegate(): any;
/**
* Returns the UI5 ID of the Section that is currently being scrolled.
* @returns {string}
*/
public getScrollingSectionId(): string;
/**
* Gets content of aggregation {@link #getSections sections}.
*
* The sections that make up the Object page content area.
* @returns {sap.uxap.ObjectPageSection[]}
*/
public getSections(): sap.uxap.ObjectPageSection[];
/**
* Gets current value of property {@link #getSectionTitleLevel sectionTitleLevel}.
*
* Determines the ARIA level of the ObjectPageSection
and ObjectPageSubSection
titles.
* The ARIA level is used by assisting technologies, such as screen readers, to create a hierarchical site map for faster navigation.
*
*
Note:
*
* - Defining a
sectionTitleLevel
will add aria-level
attribute from 1 to 6
* instead of changing the titles` HTML tag from H1 to H6.
*
For example: if sectionTitleLevel
is TitleLevel.H1
,
* it will result as aria-level of 1 added to the ObjectPageSection
title.
*
*
* - The
ObjectPageSubSection
title
* would have aria-level
one level lower than the defined.
* For example: if sectionTitleLevel
is TitleLevel.H1
,
* it will result as aria-level of 2 added to the ObjectPageSubSection
title.
*
* - It is possible to define a
titleLevel
on ObjectPageSection
or ObjectPageSubSection
level.
* In this case the value of this property will be ignored.
*
*
*
* Default value is Auto
.
* @returns {sap.ui.core.TitleLevel} Value of property sectionTitleLevel
*/
public getSectionTitleLevel(): sap.ui.core.TitleLevel;
/**
* ID of the element which is the current target of the association {@link #getSelectedSection selectedSection}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedSection(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getShowAnchorBar showAnchorBar}.
*
* Determines whether the Navigation bar (Anchor bar) is displayed.
*
* Default value is true
.
* @returns {boolean} Value of property showAnchorBar
*/
public getShowAnchorBar(): boolean;
/**
* Gets current value of property {@link #getShowAnchorBarPopover showAnchorBarPopover}.
*
* Determines whether to show a Popover with Subsection links when clicking on Section links in the Anchor bar.
*
* Default value is true
.
* @returns {boolean} Value of property showAnchorBarPopover
*/
public getShowAnchorBarPopover(): boolean;
/**
* Gets current value of property {@link #getShowEditHeaderButton showEditHeaderButton}.
*
* Determines whether an Edit button will be shown in Header Content.
*
* Default value is false
.
* @returns {boolean} Value of property showEditHeaderButton
*/
public getShowEditHeaderButton(): boolean;
/**
* Gets current value of property {@link #getShowFooter showFooter}.
*
* Determines whether the footer is visible.
*
* Default value is false
.
* @returns {boolean} Value of property showFooter
*/
public getShowFooter(): boolean;
/**
* Gets current value of property {@link #getShowHeaderContent showHeaderContent}.
*
* Determines the visibility of the Header content (headerContent aggregation).
*
* Default value is true
.
* @returns {boolean} Value of property showHeaderContent
*/
public getShowHeaderContent(): boolean;
/**
* Gets current value of property {@link #getShowOnlyHighImportance showOnlyHighImportance}.
*
* Determines whether sections and subsections with importance Low and Medium are hidden even on large screens.
*
* Default value is false
.
* @returns {boolean} Value of property showOnlyHighImportance
*/
public getShowOnlyHighImportance(): boolean;
/**
* Gets current value of property {@link #getShowTitleInHeaderContent showTitleInHeaderContent}.
*
* Determines whether the title, image, markers and selectTitleArrow are shown in the Header content area.
*
* Default value is false
.
* @returns {boolean} Value of property showTitleInHeaderContent
*/
public getShowTitleInHeaderContent(): boolean;
/**
* Gets current value of property {@link #getSubSectionLayout subSectionLayout}.
*
* Determines whether Subsection titles are displayed on top or to the left of the Subsection content.
*
* Default value is TitleOnTop
.
* @returns {sap.uxap.ObjectPageSubSectionLayout} Value of property subSectionLayout
*/
public getSubSectionLayout(): sap.uxap.ObjectPageSubSectionLayout;
/**
* Gets current value of property {@link #getUpperCaseAnchorBar upperCaseAnchorBar}.
*
* Determines whether the Anchor bar items are displayed in upper case.
*
* Default value is true
.
* @returns {boolean} Value of property upperCaseAnchorBar
*/
public getUpperCaseAnchorBar(): boolean;
/**
* Gets current value of property {@link #getUseIconTabBar useIconTabBar}.
*
* Use tab navigation mode instead of the default Anchor bar mode.
*
Note: Keep in mind that the sap.m.IconTabBar
control is no longer used for the tab navigation mode.
*
* Default value is false
.
* @returns {boolean} Value of property useIconTabBar
*/
public getUseIconTabBar(): boolean;
/**
* Gets current value of property {@link #getUseTwoColumnsForLargeScreen useTwoColumnsForLargeScreen}.
*
* Determines whether the to use two column layout for the L screen size.
*
* Default value is false
.
* @returns {boolean} Value of property useTwoColumnsForLargeScreen
*/
public getUseTwoColumnsForLargeScreen(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getHeaderContent headerContent}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oHeaderContent - The headerContent whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfHeaderContent(oHeaderContent: sap.ui.core.Control): number;
/**
* Checks for the provided sap.uxap.ObjectPageSection
in the aggregation {@link #getSections sections}.
* and returns its index if found or -1 otherwise.
* @param {sap.uxap.ObjectPageSection} oSection - The section whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSection(oSection: sap.uxap.ObjectPageSection): number;
/**
* Inserts a headerContent into the aggregation {@link #getHeaderContent headerContent}.
* @param {sap.ui.core.Control} oHeaderContent - the headerContent to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the headerContent should be inserted at; for a negative value of iIndex
, the headerContent is inserted at position 0; for a value greater than the current size of the aggregation, the headerContent is inserted at the last position
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public insertHeaderContent(oHeaderContent: sap.ui.core.Control, iIndex: number): sap.uxap.ObjectPageLayout;
/**
* Inserts a section into the aggregation {@link #getSections sections}.
* @param {sap.uxap.ObjectPageSection} oSection - the section to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the section should be inserted at; for a negative value of iIndex
, the section is inserted at position 0; for a value greater than the current size of the aggregation, the section is inserted at the last position
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public insertSection(oSection: sap.uxap.ObjectPageSection, iIndex: number): sap.uxap.ObjectPageLayout;
/**
* Removes all the controls from the aggregation {@link #getHeaderContent headerContent}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllHeaderContent(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getSections sections}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.uxap.ObjectPageSection[]} An array of the removed elements (might be empty)
*/
public removeAllSections(): sap.uxap.ObjectPageSection[];
/**
* Removes a headerContent from the aggregation {@link #getHeaderContent headerContent}.
* @param {number|string|sap.ui.core.Control} vHeaderContent - The headerContent to remove or its index or id
* @returns {sap.ui.core.Control} The removed headerContent or null
*/
public removeHeaderContent(vHeaderContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a section from the aggregation {@link #getSections sections}.
* @param {number|string|sap.uxap.ObjectPageSection} vSection - The section to remove or its index or id
* @returns {sap.uxap.ObjectPageSection} The removed section or null
*/
public removeSection(vSection: number|string|sap.uxap.ObjectPageSection): sap.uxap.ObjectPageSection;
/**
* Scrolls the Object page to the given Section.
* @param {string} sId - The Section ID to scroll to
* @param {number} iDuration - Scroll duration (in ms). Default value is 0
* @param {number} iOffset - Additional pixels to scroll
*/
public scrollToSection(sId: string, iDuration: number, iOffset: number): void;
/**
* Sets a new value for property {@link #getAlwaysShowContentHeader alwaysShowContentHeader}.
*
* Determines whether Header Content will always be expanded on desktop.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bAlwaysShowContentHeader - New value for property alwaysShowContentHeader
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setAlwaysShowContentHeader(bAlwaysShowContentHeader: boolean): sap.uxap.ObjectPageLayout;
/**
* Sets a new value for property {@link #getEnableLazyLoading enableLazyLoading}.
*
* Enable lazy loading for the Object page Subsections.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bEnableLazyLoading - New value for property enableLazyLoading
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setEnableLazyLoading(bEnableLazyLoading: boolean): sap.uxap.ObjectPageLayout;
/**
* Sets a new value for property {@link #getFlexEnabled flexEnabled}.
*
* Specifies whether the object page enables flexibility features, such as hiding and adding sections.
* For more information about SAPUI5 flexibility, refer to the Developer Guide.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bFlexEnabled - New value for property flexEnabled
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setFlexEnabled(bFlexEnabled: boolean): sap.uxap.ObjectPageLayout;
/**
* Sets the aggregated {@link #getFooter footer}.
* @param {sap.m.IBar} oFooter - The footer to set
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setFooter(oFooter: sap.m.IBar): sap.uxap.ObjectPageLayout;
/**
* Sets the aggregated {@link #getHeaderTitle headerTitle}.
* @param {sap.uxap.ObjectPageHeader} oHeaderTitle - The headerTitle to set
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setHeaderTitle(oHeaderTitle: sap.uxap.ObjectPageHeader): sap.uxap.ObjectPageLayout;
/**
* Sets a new value for property {@link #getHeight height}.
*
* Determines the height of the ObjectPage.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is 100%
.
* @param {sap.ui.core.CSSSize} sHeight - New value for property height
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setHeight(sHeight: sap.ui.core.CSSSize): sap.uxap.ObjectPageLayout;
/**
* Sets a new value for property {@link #getIsChildPage isChildPage}.
*
* Determines whether the page is a child page and renders it with a different design.
* Child pages have an additional (darker/lighter) stripe on the left side of their header content area.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bIsChildPage - New value for property isChildPage
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setIsChildPage(bIsChildPage: boolean): sap.uxap.ObjectPageLayout;
/**
* Sets a new value for property {@link #getSectionTitleLevel sectionTitleLevel}.
*
* Determines the ARIA level of the ObjectPageSection
and ObjectPageSubSection
titles.
* The ARIA level is used by assisting technologies, such as screen readers, to create a hierarchical site map for faster navigation.
*
*
Note:
*
* - Defining a
sectionTitleLevel
will add aria-level
attribute from 1 to 6
* instead of changing the titles` HTML tag from H1 to H6.
*
For example: if sectionTitleLevel
is TitleLevel.H1
,
* it will result as aria-level of 1 added to the ObjectPageSection
title.
*
*
* - The
ObjectPageSubSection
title
* would have aria-level
one level lower than the defined.
* For example: if sectionTitleLevel
is TitleLevel.H1
,
* it will result as aria-level of 2 added to the ObjectPageSubSection
title.
*
* - It is possible to define a
titleLevel
on ObjectPageSection
or ObjectPageSubSection
level.
* In this case the value of this property will be ignored.
*
*
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.ui.core.TitleLevel} sSectionTitleLevel - New value for property sectionTitleLevel
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setSectionTitleLevel(sSectionTitleLevel: sap.ui.core.TitleLevel): sap.uxap.ObjectPageLayout;
/**
* Sets the section that should be selected.
*
* The section can either be given by itself or by its id.
*
* Note that null
or undefined
are not valid arguments and will be discarded.
* This is because the sap.uxap.ObjectPageLayout
should always have one of its sections selected (unless it has 0 sections).
* @param {string|sap.uxap.ObjectPageSection} sId - the ID of the section that should be selected vSection the section that should be selected Note that null
or undefined
are not valid arguments
* @returns {sap.uxap.ObjectPageLayout} Returns this
to allow method chaining
*/
public setSelectedSection(sId: string|sap.uxap.ObjectPageSection): sap.uxap.ObjectPageLayout;
/**
* Sets a new value for property {@link #getShowAnchorBar showAnchorBar}.
*
* Determines whether the Navigation bar (Anchor bar) is displayed.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowAnchorBar - New value for property showAnchorBar
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setShowAnchorBar(bShowAnchorBar: boolean): sap.uxap.ObjectPageLayout;
/**
* Sets a new value for property {@link #getShowAnchorBarPopover showAnchorBarPopover}.
*
* Determines whether to show a Popover with Subsection links when clicking on Section links in the Anchor bar.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowAnchorBarPopover - New value for property showAnchorBarPopover
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setShowAnchorBarPopover(bShowAnchorBarPopover: boolean): sap.uxap.ObjectPageLayout;
/**
* Sets a new value for property {@link #getShowEditHeaderButton showEditHeaderButton}.
*
* Determines whether an Edit button will be shown in Header Content.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowEditHeaderButton - New value for property showEditHeaderButton
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setShowEditHeaderButton(bShowEditHeaderButton: boolean): sap.uxap.ObjectPageLayout;
/**
* Sets a new value for property {@link #getShowFooter showFooter}.
*
* Determines whether the footer is visible.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowFooter - New value for property showFooter
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setShowFooter(bShowFooter: boolean): sap.uxap.ObjectPageLayout;
/**
* Sets a new value for property {@link #getShowOnlyHighImportance showOnlyHighImportance}.
*
* Determines whether sections and subsections with importance Low and Medium are hidden even on large screens.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowOnlyHighImportance - New value for property showOnlyHighImportance
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setShowOnlyHighImportance(bShowOnlyHighImportance: boolean): sap.uxap.ObjectPageLayout;
/**
* Sets a new value for property {@link #getShowTitleInHeaderContent showTitleInHeaderContent}.
*
* Determines whether the title, image, markers and selectTitleArrow are shown in the Header content area.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bShowTitleInHeaderContent - New value for property showTitleInHeaderContent
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setShowTitleInHeaderContent(bShowTitleInHeaderContent: boolean): sap.uxap.ObjectPageLayout;
/**
* Sets a new value for property {@link #getSubSectionLayout subSectionLayout}.
*
* Determines whether Subsection titles are displayed on top or to the left of the Subsection content.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is TitleOnTop
.
* @param {sap.uxap.ObjectPageSubSectionLayout} sSubSectionLayout - New value for property subSectionLayout
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setSubSectionLayout(sSubSectionLayout: sap.uxap.ObjectPageSubSectionLayout): sap.uxap.ObjectPageLayout;
/**
* Sets a new value for property {@link #getUpperCaseAnchorBar upperCaseAnchorBar}.
*
* Determines whether the Anchor bar items are displayed in upper case.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bUpperCaseAnchorBar - New value for property upperCaseAnchorBar
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setUpperCaseAnchorBar(bUpperCaseAnchorBar: boolean): sap.uxap.ObjectPageLayout;
/**
* Sets a new value for property {@link #getUseTwoColumnsForLargeScreen useTwoColumnsForLargeScreen}.
*
* Determines whether the to use two column layout for the L screen size.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bUseTwoColumnsForLargeScreen - New value for property useTwoColumnsForLargeScreen
* @returns {sap.uxap.ObjectPageLayout} Reference to this
in order to allow method chaining
*/
public setUseTwoColumnsForLargeScreen(bUseTwoColumnsForLargeScreen: boolean): sap.uxap.ObjectPageLayout;
}
/**
* ObjectPageLazyLoader is a helper element that enables a "stashed"-based lazy loading approach for the content of
* the sap.uxap.ObjectPageSubSection control. ObjectPageLazyLoader is intended to be used in a declarative way only
* (e.g. in a view) with the "stashed" property set to "true", and is recommended to be used only once per
* subsection as its sole content.
*
* ObjectPageLazyLoader utilizes UI5's stashing mechanism and is a lightweight alternative to the native block-based
* Lazy Loading of the Object Page. Wrapping the content of a subsection in an ObjectPageLazyLoader with "stashed=true"
* will make the said content unstash automatically as the user scrolls.
*
* Note: Subsections are required to have an ID when used with ObjectPageLazyLoader.
*/
export class ObjectPageLazyLoader extends sap.ui.core.Control {
/**
* Constructor for a new ObjectPageLazyLoader.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - ID for the new control, generated automatically if no ID is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some content to the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to add; if empty, nothing is inserted
* @returns {sap.uxap.ObjectPageLazyLoader} Reference to this
in order to allow method chaining
*/
public addContent(oContent: sap.ui.core.Control): sap.uxap.ObjectPageLazyLoader;
/**
* Destroys all the content in the aggregation {@link #getContent content}.
* @returns {sap.uxap.ObjectPageLazyLoader} Reference to this
in order to allow method chaining
*/
public destroyContent(): sap.uxap.ObjectPageLazyLoader;
/**
* Creates a new subclass of class sap.uxap.ObjectPageLazyLoader with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getContent content}.
*
* Controls to be displayed after this element is unstashed
* @returns {sap.ui.core.Control[]}
*/
public getContent(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.uxap.ObjectPageLazyLoader.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getContent content}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oContent - The content whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfContent(oContent: sap.ui.core.Control): number;
/**
* Inserts a content into the aggregation {@link #getContent content}.
* @param {sap.ui.core.Control} oContent - the content to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the content should be inserted at; for a negative value of iIndex
, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
* @returns {sap.uxap.ObjectPageLazyLoader} Reference to this
in order to allow method chaining
*/
public insertContent(oContent: sap.ui.core.Control, iIndex: number): sap.uxap.ObjectPageLazyLoader;
/**
* Removes all the controls from the aggregation {@link #getContent content}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllContent(): sap.ui.core.Control[];
/**
* Removes a content from the aggregation {@link #getContent content}.
* @param {number|string|sap.ui.core.Control} vContent - The content to remove or its index or id
* @returns {sap.ui.core.Control} The removed content or null
*/
public removeContent(vContent: number|string|sap.ui.core.Control): sap.ui.core.Control;
}
/**
* An ObjectPageSection is the top-level information container of an Object page. Its purpose is to aggregate Subsections.
* Disclaimer: This control is intended to be used only as part of the Object page layout
*/
export class ObjectPageSection extends sap.uxap.ObjectPageSectionBase {
/**
* Constructor for a new ObjectPageSection.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some subSection to the aggregation {@link #getSubSections subSections}.
* @param {sap.uxap.ObjectPageSubSection} oSubSection - the subSection to add; if empty, nothing is inserted
* @returns {sap.uxap.ObjectPageSection} Reference to this
in order to allow method chaining
*/
public addSubSection(oSubSection: sap.uxap.ObjectPageSubSection): sap.uxap.ObjectPageSection;
/**
* Destroys all the subSections in the aggregation {@link #getSubSections subSections}.
* @returns {sap.uxap.ObjectPageSection} Reference to this
in order to allow method chaining
*/
public destroySubSections(): sap.uxap.ObjectPageSection;
/**
* Creates a new subclass of class sap.uxap.ObjectPageSection with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.uxap.ObjectPageSectionBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Returns a metadata object for class sap.uxap.ObjectPageSection.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* ID of the element which is the current target of the association {@link #getSelectedSubSection selectedSubSection}, or null
.
* @returns {sap.ui.core.ID}
*/
public getSelectedSubSection(): sap.ui.core.ID;
/**
* Gets current value of property {@link #getShowTitle showTitle}.
*
* Determines whether to display the Section title or not.
*
* Default value is true
.
* @returns {boolean} Value of property showTitle
*/
public getShowTitle(): boolean;
/**
* Gets content of aggregation {@link #getSubSections subSections}.
*
* The list of Subsections.
* @returns {sap.uxap.ObjectPageSubSection[]}
*/
public getSubSections(): sap.uxap.ObjectPageSubSection[];
/**
* Gets current value of property {@link #getTitleUppercase titleUppercase}.
*
* Determines whether the Section title is displayed in upper case.
*
* Default value is true
.
* @returns {boolean} Value of property titleUppercase
*/
public getTitleUppercase(): boolean;
/**
* Checks for the provided sap.uxap.ObjectPageSubSection
in the aggregation {@link #getSubSections subSections}.
* and returns its index if found or -1 otherwise.
* @param {sap.uxap.ObjectPageSubSection} oSubSection - The subSection whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfSubSection(oSubSection: sap.uxap.ObjectPageSubSection): number;
/**
* Inserts a subSection into the aggregation {@link #getSubSections subSections}.
* @param {sap.uxap.ObjectPageSubSection} oSubSection - the subSection to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the subSection should be inserted at; for a negative value of iIndex
, the subSection is inserted at position 0; for a value greater than the current size of the aggregation, the subSection is inserted at the last position
* @returns {sap.uxap.ObjectPageSection} Reference to this
in order to allow method chaining
*/
public insertSubSection(oSubSection: sap.uxap.ObjectPageSubSection, iIndex: number): sap.uxap.ObjectPageSection;
/**
* Removes all the controls from the aggregation {@link #getSubSections subSections}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.uxap.ObjectPageSubSection[]} An array of the removed elements (might be empty)
*/
public removeAllSubSections(): sap.uxap.ObjectPageSubSection[];
/**
* Removes a subSection from the aggregation {@link #getSubSections subSections}.
* @param {number|string|sap.uxap.ObjectPageSubSection} vSubSection - The subSection to remove or its index or id
* @returns {sap.uxap.ObjectPageSubSection} The removed subSection or null
*/
public removeSubSection(vSubSection: number|string|sap.uxap.ObjectPageSubSection): sap.uxap.ObjectPageSubSection;
/**
* Sets the associated {@link #getSelectedSubSection selectedSubSection}.
* @param {sap.ui.core.ID|sap.uxap.ObjectPageSubSection} oSelectedSubSection - ID of an element which becomes the new target of this selectedSubSection association; alternatively, an element instance may be given
* @returns {sap.uxap.ObjectPageSection} Reference to this
in order to allow method chaining
*/
public setSelectedSubSection(oSelectedSubSection: sap.ui.core.ID|sap.uxap.ObjectPageSubSection): sap.uxap.ObjectPageSection;
/**
* Sets a new value for property {@link #getShowTitle showTitle}.
*
* Determines whether to display the Section title or not.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bShowTitle - New value for property showTitle
* @returns {sap.uxap.ObjectPageSection} Reference to this
in order to allow method chaining
*/
public setShowTitle(bShowTitle: boolean): sap.uxap.ObjectPageSection;
/**
* Sets a new value for property {@link #getTitleUppercase titleUppercase}.
*
* Determines whether the Section title is displayed in upper case.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bTitleUppercase - New value for property titleUppercase
* @returns {sap.uxap.ObjectPageSection} Reference to this
in order to allow method chaining
*/
public setTitleUppercase(bTitleUppercase: boolean): sap.uxap.ObjectPageSection;
}
/**
* An abstract container for object page sections and subSections
*/
export class ObjectPageSectionBase extends sap.ui.core.Control {
/**
* Constructor for a new ObjectPageSectionBase.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Explicitly ask to connect to the UI5 model tree
*/
public connectToModels(): void;
/**
* Destroys the customAnchorBarButton in the aggregation {@link #getCustomAnchorBarButton customAnchorBarButton}.
* @returns {sap.uxap.ObjectPageSectionBase} Reference to this
in order to allow method chaining
*/
public destroyCustomAnchorBarButton(): sap.uxap.ObjectPageSectionBase;
/**
* Creates a new subclass of class sap.uxap.ObjectPageSectionBase with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getCustomAnchorBarButton customAnchorBarButton}.
*
* The custom button that will provide a link to the section in the ObjectPageLayout anchor bar.
* This button will be used as a custom template to be into the ObjectPageLayout anchorBar area, therefore property changes happening on this button template after the first rendering won't affect the actual button copy used in the anchorBar.
*
* If you want to change some of the button properties, you would need to bind them to a model.
* @returns {sap.m.Button}
*/
public getCustomAnchorBarButton(): sap.m.Button;
/**
* Gets current value of property {@link #getImportance importance}.
*
* Determines whether the section will be hidden on low resolutions.
*
* Default value is library.Importance.High
.
* @returns {sap.uxap.Importance} Value of property importance
*/
public getImportance(): sap.uxap.Importance;
/**
* Returns a metadata object for class sap.uxap.ObjectPageSectionBase.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getTitle title}.
*
* Section Title
* @returns {string} Value of property title
*/
public getTitle(): string;
/**
* Gets current value of property {@link #getTitleLevel titleLevel}.
*
* Determines the ARIA level of the ObjectPageSectionBase
title.
* The ARIA level is used by assisting technologies, such as screen readers, to create a hierarchical site map for faster navigation.
*
*
Note: Defining a titleLevel
will add aria-level
attribute from 1 to 6,
* instead of changing the ObjectPageSectionBase
title HTML tag from H1 to H6.
*
For example: if titleLevel
is TitleLevel.H1
,
* it will result as aria-level of 1 added to the ObjectPageSectionBase
title.
*
* Default value is Auto
.
* @returns {sap.ui.core.TitleLevel} Value of property titleLevel
*/
public getTitleLevel(): sap.ui.core.TitleLevel;
/**
* Gets current value of property {@link #getVisible visible}.
*
* Invisible ObjectPageSectionBase are not rendered
*
* Default value is true
.
* @returns {boolean} Value of property visible
*/
public getVisible(): boolean;
/**
* Sets the aggregated {@link #getCustomAnchorBarButton customAnchorBarButton}.
* @param {sap.m.Button} oCustomAnchorBarButton - The customAnchorBarButton to set
* @returns {sap.uxap.ObjectPageSectionBase} Reference to this
in order to allow method chaining
*/
public setCustomAnchorBarButton(oCustomAnchorBarButton: sap.m.Button): sap.uxap.ObjectPageSectionBase;
/**
* Sets a new value for property {@link #getImportance importance}.
*
* Determines whether the section will be hidden on low resolutions.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is library.Importance.High
.
* @param {sap.uxap.Importance} sImportance - New value for property importance
* @returns {sap.uxap.ObjectPageSectionBase} Reference to this
in order to allow method chaining
*/
public setImportance(sImportance: sap.uxap.Importance): sap.uxap.ObjectPageSectionBase;
/**
* Sets a new value for property {@link #getTitle title}.
*
* Section Title
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
* @param {string} sTitle - New value for property title
* @returns {sap.uxap.ObjectPageSectionBase} Reference to this
in order to allow method chaining
*/
public setTitle(sTitle: string): sap.uxap.ObjectPageSectionBase;
/**
* Sets a new value for property {@link #getTitleLevel titleLevel}.
*
* Determines the ARIA level of the ObjectPageSectionBase
title.
* The ARIA level is used by assisting technologies, such as screen readers, to create a hierarchical site map for faster navigation.
*
*
Note: Defining a titleLevel
will add aria-level
attribute from 1 to 6,
* instead of changing the ObjectPageSectionBase
title HTML tag from H1 to H6.
*
For example: if titleLevel
is TitleLevel.H1
,
* it will result as aria-level of 1 added to the ObjectPageSectionBase
title.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Auto
.
* @param {sap.ui.core.TitleLevel} sTitleLevel - New value for property titleLevel
* @returns {sap.uxap.ObjectPageSectionBase} Reference to this
in order to allow method chaining
*/
public setTitleLevel(sTitleLevel: sap.ui.core.TitleLevel): sap.uxap.ObjectPageSectionBase;
/**
* Sets a new value for property {@link #getVisible visible}.
*
* Invisible ObjectPageSectionBase are not rendered
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is true
.
* @param {boolean} bVisible - New value for property visible
* @returns {sap.uxap.ObjectPageSectionBase} Reference to this
in order to allow method chaining
*/
public setVisible(bVisible: boolean): sap.uxap.ObjectPageSectionBase;
}
/**
* An ObjectPageSubSection is the second-level information container of an Object page and may only be used within an Object page section.
* Subsections may display primary information in the so called blocks aggregation (always visible)
* and not-so-important information in the moreBlocks aggregation, whose content is initially hidden, but may be accessed via a See more (...) button.
* Disclaimer: This control is intended to be used only as part of the Object page layout
*/
export class ObjectPageSubSection extends sap.uxap.ObjectPageSectionBase {
/**
* Constructor for a new ObjectPageSubSection.
*
*
* Accepts an object literal mSettings
that defines initial
* property values, aggregated and associated objects as well as event handlers.
* See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.
* @param {string} sId - id for the new control, generated automatically if no id is given
* @param {any} mSettings - initial settings for the new control
*/
public constructor(sId?: string, mSettings?: any);
/**
* Adds some action to the aggregation {@link #getActions actions}.
* @param {sap.ui.core.Control} oAction - the action to add; if empty, nothing is inserted
* @returns {sap.uxap.ObjectPageSubSection} Reference to this
in order to allow method chaining
*/
public addAction(oAction: sap.ui.core.Control): sap.uxap.ObjectPageSubSection;
/**
* Adds some block to the aggregation {@link #getBlocks blocks}.
* @param {sap.ui.core.Control} oBlock - the block to add; if empty, nothing is inserted
* @returns {sap.uxap.ObjectPageSubSection} Reference to this
in order to allow method chaining
*/
public addBlock(oBlock: sap.ui.core.Control): sap.uxap.ObjectPageSubSection;
/**
* Adds some moreBlock to the aggregation {@link #getMoreBlocks moreBlocks}.
* @param {sap.ui.core.Control} oMoreBlock - the moreBlock to add; if empty, nothing is inserted
* @returns {sap.uxap.ObjectPageSubSection} Reference to this
in order to allow method chaining
*/
public addMoreBlock(oMoreBlock: sap.ui.core.Control): sap.uxap.ObjectPageSubSection;
/**
* Destroys all the actions in the aggregation {@link #getActions actions}.
* @returns {sap.uxap.ObjectPageSubSection} Reference to this
in order to allow method chaining
*/
public destroyActions(): sap.uxap.ObjectPageSubSection;
/**
* Destroys all the blocks in the aggregation {@link #getBlocks blocks}.
* @returns {sap.uxap.ObjectPageSubSection} Reference to this
in order to allow method chaining
*/
public destroyBlocks(): sap.uxap.ObjectPageSubSection;
/**
* Destroys all the moreBlocks in the aggregation {@link #getMoreBlocks moreBlocks}.
* @returns {sap.uxap.ObjectPageSubSection} Reference to this
in order to allow method chaining
*/
public destroyMoreBlocks(): sap.uxap.ObjectPageSubSection;
/**
* Creates a new subclass of class sap.uxap.ObjectPageSubSection with name sClassName
* and enriches it with the information contained in oClassInfo
.
*
* oClassInfo
might contain the same kind of information as described in {@link sap.uxap.ObjectPageSectionBase.extend}.
* @param {string} sClassName - Name of the class being created
* @param {any} oClassInfo - Object literal with information about the class
* @param {Function} FNMetaImpl - Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
* @returns {Function} Created class / constructor function
*/
public static extend(sClassName: string, oClassInfo?: any, FNMetaImpl?: Function): Function;
/**
* Gets content of aggregation {@link #getActions actions}.
*
* Actions available for this Subsection
* @returns {sap.ui.core.Control[]}
*/
public getActions(): sap.ui.core.Control[];
/**
* Gets content of aggregation {@link #getBlocks blocks}.
*
* Controls to be displayed in the subsection
* @returns {sap.ui.core.Control[]}
*/
public getBlocks(): sap.ui.core.Control[];
/**
* Returns a metadata object for class sap.uxap.ObjectPageSubSection.
* @returns {sap.ui.base.Metadata} Metadata object describing this class
*/
public static getMetadata(): sap.ui.base.Metadata;
/**
* Gets current value of property {@link #getMode mode}.
*
* A mode property that will be passed to the controls in the blocks and moreBlocks aggregations. Only relevant if these aggregations use Object page blocks.
*
* Default value is Collapsed
.
* @returns {sap.uxap.ObjectPageSubSectionMode} Value of property mode
*/
public getMode(): sap.uxap.ObjectPageSubSectionMode;
/**
* Gets content of aggregation {@link #getMoreBlocks moreBlocks}.
*
* Additional controls to display when the Show more / See all / (...) button is pressed
* @returns {sap.ui.core.Control[]}
*/
public getMoreBlocks(): sap.ui.core.Control[];
/**
* Gets current value of property {@link #getTitleUppercase titleUppercase}.
*
* Determines whether the Subsection title is displayed in upper case.
*
* Default value is false
.
* @returns {boolean} Value of property titleUppercase
*/
public getTitleUppercase(): boolean;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getActions actions}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oAction - The action whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfAction(oAction: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getBlocks blocks}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oBlock - The block whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfBlock(oBlock: sap.ui.core.Control): number;
/**
* Checks for the provided sap.ui.core.Control
in the aggregation {@link #getMoreBlocks moreBlocks}.
* and returns its index if found or -1 otherwise.
* @param {sap.ui.core.Control} oMoreBlock - The moreBlock whose index is looked for
* @returns {number} The index of the provided control in the aggregation if found, or -1 otherwise
*/
public indexOfMoreBlock(oMoreBlock: sap.ui.core.Control): number;
/**
* Inserts a action into the aggregation {@link #getActions actions}.
* @param {sap.ui.core.Control} oAction - the action to insert; if empty, nothing is inserted
* @param {number} iIndex - the 0
-based index the action should be inserted at; for a negative value of iIndex
, the action is inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted at the last position
* @returns {sap.uxap.ObjectPageSubSection} Reference to this
in order to allow method chaining
*/
public insertAction(oAction: sap.ui.core.Control, iIndex: number): sap.uxap.ObjectPageSubSection;
/**
* Removes a action from the aggregation {@link #getActions actions}.
* @param {number|string|sap.ui.core.Control} vAction - The action to remove or its index or id
* @returns {sap.ui.core.Control} The removed action or null
*/
public removeAction(vAction: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes all the controls from the aggregation {@link #getActions actions}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllActions(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getBlocks blocks}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllBlocks(): sap.ui.core.Control[];
/**
* Removes all the controls from the aggregation {@link #getMoreBlocks moreBlocks}.
*
* Additionally, it unregisters them from the hosting UIArea.
* @returns {sap.ui.core.Control[]} An array of the removed elements (might be empty)
*/
public removeAllMoreBlocks(): sap.ui.core.Control[];
/**
* Removes a block from the aggregation {@link #getBlocks blocks}.
* @param {number|string|sap.ui.core.Control} vBlock - The block to remove or its index or id
* @returns {sap.ui.core.Control} The removed block or null
*/
public removeBlock(vBlock: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Removes a moreBlock from the aggregation {@link #getMoreBlocks moreBlocks}.
* @param {number|string|sap.ui.core.Control} vMoreBlock - The moreBlock to remove or its index or id
* @returns {sap.ui.core.Control} The removed moreBlock or null
*/
public removeMoreBlock(vMoreBlock: number|string|sap.ui.core.Control): sap.ui.core.Control;
/**
* Sets a new value for property {@link #getMode mode}.
*
* A mode property that will be passed to the controls in the blocks and moreBlocks aggregations. Only relevant if these aggregations use Object page blocks.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is Collapsed
.
* @param {sap.uxap.ObjectPageSubSectionMode} sMode - New value for property mode
* @returns {sap.uxap.ObjectPageSubSection} Reference to this
in order to allow method chaining
*/
public setMode(sMode: sap.uxap.ObjectPageSubSectionMode): sap.uxap.ObjectPageSubSection;
/**
* Sets a new value for property {@link #getTitleUppercase titleUppercase}.
*
* Determines whether the Subsection title is displayed in upper case.
*
* When called with a value of null
or undefined
, the default value of the property will be restored.
*
* Default value is false
.
* @param {boolean} bTitleUppercase - New value for property titleUppercase
* @returns {sap.uxap.ObjectPageSubSection} Reference to this
in order to allow method chaining
*/
public setTitleUppercase(bTitleUppercase: boolean): sap.uxap.ObjectPageSubSection;
}
/**
* Used by the ObjectPagSubSection control to define which layout to apply.
*/
export enum ObjectPageSubSectionLayout {
/**
* TitleOnLeft: title and actions on the left, inside the block area.
*/
TitleOnLeft = "TitleOnLeft",
/**
* TitleOnTop: title and actions on top of the block area.
*/
TitleOnTop = "TitleOnTop",
}
/**
* Used by the ObjectPageLayout control to define which layout to use (either Collapsed or Expanded).
*/
export enum ObjectPageSubSectionMode {
/**
* Collapsed mode of display of the ObjectPageLayout.
*/
Collapsed = "Collapsed",
/**
* Expanded mode of displaying the ObjectPageLayout.
*/
Expanded = "Expanded",
}
}
}